Private Cloud Gateway

https://api.spectrocloud.com/v1/overlords

summary:
Retrieves a list of overlords owned by the tenant
Parameters:
NameTypeDescriptionRequired
namestringno
200
(empty)
{
"items": [
{
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"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",
"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": {
"isActive": "boolean",
"isReady": "boolean",
"state": "string"
}
}
]
}

https://api.spectrocloud.com/v1/overlords/maas/manifest

summary:
Returns the manifests required for the private gateway installation
Path parameters:
NameTypeDescriptionRequired
pairingCodestringyes
200
(empty)
{
"manifest": "string"
}

https://api.spectrocloud.com/v1/overlords/maas/{uid}/account

summary:
update the maas cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"account": {
"apiEndpoint": "string",
"apiKey": "string"
},
"shareWithProjects": "boolean"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/overlords/maas/{uid}/account

summary:
create the maas cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"account": {
"apiEndpoint": "string",
"apiKey": "string"
},
"name": "string",
"shareWithProjects": "boolean"
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/overlords/maas/{uid}/account/validate

summary:
validate the maas cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"account": {
"apiEndpoint": "string",
"apiKey": "string"
}
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/overlords/maas/{uid}/cloudconfig

summary:
update the maas cloud config for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"clusterConfig": {
"domain": "string",
"sshKeys": [
"string"
]
},
"clusterSettings": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"machineConfig": {
"azs": [
"string"
],
"instanceType": {
"minCPU": "integer",
"minMemInMB": "integer"
},
"resourcePool": "string"
},
"size": "integer"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/overlords/maas/{uid}/cloudconfig

summary:
create the maas cloud config for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"clusterConfig": {
"domain": "string",
"sshKeys": [
"string"
]
},
"clusterSettings": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"machineConfig": {
"azs": [
"string"
],
"instanceType": {
"minCPU": "integer",
"minMemInMB": "integer"
},
"resourcePool": "string"
},
"size": "integer"
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/overlords/openstack/manifest

summary:
Returns the manifests required for the private gateway installation
Path parameters:
NameTypeDescriptionRequired
pairingCodestringyes
200
(empty)
{
"manifest": "string"
}

https://api.spectrocloud.com/v1/overlords/openstack/{uid}/account

summary:
update the OpenStack cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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

https://api.spectrocloud.com/v1/overlords/openstack/{uid}/account

summary:
create the OpenStack cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"account": {
"caCert": "string",
"defaultDomain": "string",
"defaultProject": "string",
"identityEndpoint": "string",
"insecure": "boolean",
"parentRegion": "string",
"password": "string",
"username": "string"
},
"name": "string",
"shareWithProjects": "boolean"
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/overlords/openstack/{uid}/account/validate

summary:
validate the OpenStack cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"account": {
"caCert": "string",
"defaultDomain": "string",
"defaultProject": "string",
"identityEndpoint": "string",
"insecure": "boolean",
"parentRegion": "string",
"password": "string",
"username": "string"
}
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/overlords/openstack/{uid}/cloudconfig

summary:
update the OpenStack cloud config for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"machineConfig": {
"azs": [
"string"
],
"flavorConfig": {
"diskGiB": "integer",
"memoryMiB": "integer",
"name": "string",
"numCPUs": "integer"
}
},
"size": "integer"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/overlords/openstack/{uid}/cloudconfig

summary:
create the OpenStack cloud config for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"machineConfig": {
"azs": [
"string"
],
"flavorConfig": {
"diskGiB": "integer",
"memoryMiB": "integer",
"name": "string",
"numCPUs": "integer"
}
},
"size": "integer"
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/overlords/pairing/code

summary:
Returns the pairing code for the private gateway
Parameters:
NameTypeDescriptionRequired
cloudTypestringno
200
(empty)
{
"pairingCode": "string"
}

https://api.spectrocloud.com/v1/overlords/vsphere/manifest

summary:
Returns the manifests required for the private gateway installation
Path parameters:
NameTypeDescriptionRequired
pairingCodestringyes
200
(empty)
{
"manifest": "string"
}

https://api.spectrocloud.com/v1/overlords/vsphere/ova

summary:
Returns overlord's ova information
200
(empty)
{
"location": "string"
}

https://api.spectrocloud.com/v1/overlords/vsphere/tenants/{tenantUid}/system

summary:
Creates the system private gateway for the specified tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/account

summary:
update the vSphere cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"account": {
"insecure": "boolean",
"password": "string",
"username": "string",
"vcenterServer": "string"
},
"shareWithProjects": "boolean"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/account

summary:
create the vSphere cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"account": {
"insecure": "boolean",
"password": "string",
"username": "string",
"vcenterServer": "string"
},
"name": "string",
"shareWithProjects": "boolean"
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/account/validate

summary:
validate the vSphere cloudaccount for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"account": {
"insecure": "boolean",
"password": "string",
"username": "string",
"vcenterServer": "string"
}
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/cloudconfig

summary:
update the vSphere cloud config for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"size": "integer"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/cloudconfig

summary:
create the vSphere cloud config for the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"size": "integer"
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/pools

summary:
Retrieves a list of IP Pools for the specified private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
(empty)
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"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 gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"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
{
"uid": "string"
}

https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/pools/{poolUid}

summary:
Updates the private gateways's specified IP Pool data
Path parameters:
NameTypeDescriptionRequired
uidstringyes
poolUidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"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

https://api.spectrocloud.com/v1/overlords/vsphere/{uid}/pools/{poolUid}

summary:
Deletes the private gateways's specified IP Pool data
Path parameters:
NameTypeDescriptionRequired
uidstringyes
poolUidstringyes
204
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 account
Path parameters:
NameTypeDescriptionRequired
uidstringyes
datacenterstringyes
computeclusterstringyes
200
(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 account
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
(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 uid
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
(empty)
{
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"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",
"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": {
"isActive": "boolean",
"isReady": "boolean",
"state": "string"
}
}

https://api.spectrocloud.com/v1/overlords/{uid}

summary:
delete the private gateway
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
(empty)
{
"msg": "string"
}

https://api.spectrocloud.com/v1/overlords/{uid}/metadata

summary:
update the private gateway's metadata
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/overlords/{uid}/reset

summary:
reset the private gateway by disaaociating the private gateway's resources
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
(empty)
{
"msg": "string"
}