→
https://api.spectrocloud.com/v1/overlords
summary:
Retrieves a list of overlords owned by the tenantParameters:
Name | Type | Description | Required |
---|---|---|---|
name | string | no |
200
(empty)
(empty)
{"items": [{"kind": "string","metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"cloudAccountUid": "string","ipAddress": "string","ipPools": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"pool": {"end": "string","gateway": "string","nameserver": {"addresses": ["string"],"search": ["string"]},"prefix": "integer","start": "string","subnet": "string"},"priavetGatewayUid": "string","restrictToSingleCluster": "boolean"},"status": {"allottedIps": ["string"],"associatedClusters": ["string"],"inUse": "boolean"}}],"isSystem": "boolean","registryUid": "string","spectroClusterUid": "string","tenantUid": "string"},"status": {"health": {"agentVersion": "string","conditions": [{"message": "string","relatedObject": {"kind": "string","name": "string","uid": "string"},"type": "string"}],"state": "string"},"isActive": "boolean","isReady": "boolean","state": "string"}}]}
→
https://api.spectrocloud.com/v1/overlords/maas/manifest
summary:
Returns the manifests required for the private gateway installationPath parameters:
Name | Type | Description | Required |
---|---|---|---|
pairingCode | string | yes |
200
(empty)
(empty)
{"manifest": "string"}
→
https://api.spectrocloud.com/v1/overlords/maas/{uid}/account
summary:
update the maas cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"apiEndpoint": "string","apiKey": "string"},"shareWithProjects": "boolean"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/overlords/maas/{uid}/account
summary:
create the maas cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"apiEndpoint": "string","apiKey": "string"},"name": "string","shareWithProjects": "boolean"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/overlords/maas/{uid}/account/validate
summary:
validate the maas cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"apiEndpoint": "string","apiKey": "string"}}
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1/overlords/maas/{uid}/cloudconfig
summary:
update the maas cloud config for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"clusterConfig": {"domain": "string","sshKeys": ["string"]},"clusterSettings": {"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}},"resources": {"namespaces": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"relatedObject": {"kind": "string","name": "string","uid": "string"},"resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"rbacs": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}}}]},"updateWorkerPoolsInParallel": "boolean"},"machineConfig": {"azs": ["string"],"instanceType": {"minCPU": "integer","minMemInMB": "integer"},"resourcePool": "string"},"size": "integer"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/overlords/maas/{uid}/cloudconfig
summary:
create the maas cloud config for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"clusterConfig": {"domain": "string","sshKeys": ["string"]},"clusterSettings": {"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}},"resources": {"namespaces": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"relatedObject": {"kind": "string","name": "string","uid": "string"},"resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"rbacs": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}}}]},"updateWorkerPoolsInParallel": "boolean"},"machineConfig": {"azs": ["string"],"instanceType": {"minCPU": "integer","minMemInMB": "integer"},"resourcePool": "string"},"size": "integer"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/overlords/openstack/manifest
summary:
Returns the manifests required for the private gateway installationPath parameters:
Name | Type | Description | Required |
---|---|---|---|
pairingCode | string | yes |
200
(empty)
(empty)
{"manifest": "string"}
→
https://api.spectrocloud.com/v1/overlords/openstack/{uid}/account
summary:
update the OpenStack cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"caCert": "string","defaultDomain": "string","defaultProject": "string","identityEndpoint": "string","insecure": "boolean","parentRegion": "string","password": "string","username": "string"},"shareWithProjects": "boolean"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/overlords/openstack/{uid}/account
summary:
create the OpenStack cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"caCert": "string","defaultDomain": "string","defaultProject": "string","identityEndpoint": "string","insecure": "boolean","parentRegion": "string","password": "string","username": "string"},"name": "string","shareWithProjects": "boolean"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/overlords/openstack/{uid}/account/validate
summary:
validate the OpenStack cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"caCert": "string","defaultDomain": "string","defaultProject": "string","identityEndpoint": "string","insecure": "boolean","parentRegion": "string","password": "string","username": "string"}}
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1/overlords/openstack/{uid}/cloudconfig
summary:
update the OpenStack cloud config for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"clusterConfig": {"bastionDisabled": "boolean","dnsNameservers": ["string"],"domain": {"id": "string","name": "string"},"network": {"id": "string","name": "string"},"nodeCidr": "string","project": {"id": "string","name": "string"},"region": "string","sshKeyName": "string","subnet": {"id": "string","name": "string"}},"clusterSettings": {"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}},"resources": {"namespaces": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"relatedObject": {"kind": "string","name": "string","uid": "string"},"resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"rbacs": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}}}]},"updateWorkerPoolsInParallel": "boolean"},"machineConfig": {"azs": ["string"],"flavorConfig": {"diskGiB": "integer","memoryMiB": "integer","name": "string","numCPUs": "integer"}},"size": "integer"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/overlords/openstack/{uid}/cloudconfig
summary:
create the OpenStack cloud config for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"clusterConfig": {"bastionDisabled": "boolean","dnsNameservers": ["string"],"domain": {"id": "string","name": "string"},"network": {"id": "string","name": "string"},"nodeCidr": "string","project": {"id": "string","name": "string"},"region": "string","sshKeyName": "string","subnet": {"id": "string","name": "string"}},"clusterSettings": {"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}},"resources": {"namespaces": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"relatedObject": {"kind": "string","name": "string","uid": "string"},"resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"rbacs": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}}}]},"updateWorkerPoolsInParallel": "boolean"},"machineConfig": {"azs": ["string"],"flavorConfig": {"diskGiB": "integer","memoryMiB": "integer","name": "string","numCPUs": "integer"}},"size": "integer"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/overlords/pairing/code
summary:
Returns the pairing code for the private gatewayParameters:
Name | Type | Description | Required |
---|---|---|---|
cloudType | string | no |
200
(empty)
(empty)
{"pairingCode": "string"}
→
https://api.spectrocloud.com/v1/overlords/vsphere/manifest
summary:
Returns the manifests required for the private gateway installationPath parameters:
Name | Type | Description | Required |
---|---|---|---|
pairingCode | string | yes |
200
(empty)
(empty)
{"manifest": "string"}
→
https://api.spectrocloud.com/v1/overlords/vsphere/ova
summary:
Returns overlord's ova information 200
(empty)
(empty)
{"location": "string"}
→
https://api.spectrocloud.com/v1/overlords/vsphere/tenants/{tenantUid}/system
summary:
Creates the system private gateway for the specified tenantPath parameters:
Name | Type | Description | Required |
---|---|---|---|
tenantUid | string | yes |
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/account
summary:
update the vSphere cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"insecure": "boolean","password": "string","username": "string","vcenterServer": "string"},"shareWithProjects": "boolean"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/account
summary:
create the vSphere cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"insecure": "boolean","password": "string","username": "string","vcenterServer": "string"},"name": "string","shareWithProjects": "boolean"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/account/validate
summary:
validate the vSphere cloudaccount for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"account": {"insecure": "boolean","password": "string","username": "string","vcenterServer": "string"}}
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/cloudconfig
summary:
update the vSphere cloud config for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"clusterConfig": {"controlPlaneEndpoint": {"ddnsSearchDomain": "string","host": "string","type": "string"},"ntpServers": ["string"],"placements": [{"cluster": "string","datacenter": "string","datastore": "string","folder": "string","imageTemplateFolder": "string","network": {"networkName": "string","parentPoolUid": "string","staticIp": "boolean"},"resourcePool": "string","storagePolicyName": "string","uid": "string"}],"sshKeys": ["string"],"staticIp": "boolean"},"clusterSettings": {"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}},"resources": {"namespaces": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"relatedObject": {"kind": "string","name": "string","uid": "string"},"resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"rbacs": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}}}]},"updateWorkerPoolsInParallel": "boolean"},"size": "integer"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/cloudconfig
summary:
create the vSphere cloud config for the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"clusterConfig": {"controlPlaneEndpoint": {"ddnsSearchDomain": "string","host": "string","type": "string"},"ntpServers": ["string"],"placements": [{"cluster": "string","datacenter": "string","datastore": "string","folder": "string","imageTemplateFolder": "string","network": {"networkName": "string","parentPoolUid": "string","staticIp": "boolean"},"resourcePool": "string","storagePolicyName": "string","uid": "string"}],"sshKeys": ["string"],"staticIp": "boolean"},"clusterSettings": {"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}},"resources": {"namespaces": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"relatedObject": {"kind": "string","name": "string","uid": "string"},"resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"rbacs": [{"metadata": {"annotations": "object","labels": "object","name": "string","uid": "string"},"spec": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}}}]},"updateWorkerPoolsInParallel": "boolean"},"size": "integer"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/pools
summary:
Retrieves a list of IP Pools for the specified private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
(empty)
(empty)
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"pool": {"end": "string","gateway": "string","nameserver": {"addresses": ["string"],"search": ["string"]},"prefix": "integer","start": "string","subnet": "string"},"priavetGatewayUid": "string","restrictToSingleCluster": "boolean"},"status": {"allottedIps": ["string"],"associatedClusters": ["string"],"inUse": "boolean"}}]}
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/pools
summary:
Creates an IP pool defintion for the sepcified private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"pool": {"end": "string","gateway": "string","nameserver": {"addresses": ["string"],"search": ["string"]},"prefix": "integer","start": "string","subnet": "string"},"restrictToSingleCluster": "boolean"}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/pools/{poolUid}
summary:
Updates the private gateways's specified IP Pool dataPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
poolUid | string | yes |
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"pool": {"end": "string","gateway": "string","nameserver": {"addresses": ["string"],"search": ["string"]},"prefix": "integer","start": "string","subnet": "string"},"restrictToSingleCluster": "boolean"}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/pools/{poolUid}
summary:
Deletes the private gateways's specified IP Pool dataPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
poolUid | string | yes |
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/properties/computecluster/resources
summary:
Retrieves the vSphere computecluster resources for the specified private gateway's accountPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
datacenter | string | yes | |
computecluster | string | yes |
200
(empty)
(empty)
{"computecluster": {"datastores": ["string"],"name": "string","networks": ["string"],"resourcePools": ["string"]},"datacenter": "string"}
→
https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/properties/datacenters
summary:
Retrieves the vSphere datacenters & datacluster for the specified private gateway's accountPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
(empty)
(empty)
{"items": [{"computeclusters": ["string"],"datacenter": "string","folders": ["string"]}]}
→
https://api.spectrocloud.com/v1/overlords/{uid}
summary:
Returns the specified private gateway's for the given uidPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
(empty)
(empty)
{"kind": "string","metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"cloudAccountUid": "string","ipAddress": "string","ipPools": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"pool": {"end": "string","gateway": "string","nameserver": {"addresses": ["string"],"search": ["string"]},"prefix": "integer","start": "string","subnet": "string"},"priavetGatewayUid": "string","restrictToSingleCluster": "boolean"},"status": {"allottedIps": ["string"],"associatedClusters": ["string"],"inUse": "boolean"}}],"isSystem": "boolean","registryUid": "string","spectroClusterUid": "string","tenantUid": "string"},"status": {"health": {"agentVersion": "string","conditions": [{"message": "string","relatedObject": {"kind": "string","name": "string","uid": "string"},"type": "string"}],"state": "string"},"isActive": "boolean","isReady": "boolean","state": "string"}}
→
https://api.spectrocloud.com/v1/overlords/{uid}
summary:
delete the private gatewayPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
(empty)
(empty)
{"msg": "string"}
→
https://api.spectrocloud.com/v1/overlords/{uid}/metadata
summary:
update the private gateway's metadataPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"metadata": {"annotations": "object","labels": "object","name": "string"}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/overlords/{uid}/reset
summary:
reset the private gateway by disaaociating the private gateway's resourcesPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
(empty)
(empty)
{"msg": "string"}