Powered by Algolia

    Private Cloud Gateway

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

    summary:
    Returns the pairing code for the overload
    200
    (empty)
    {
    "pairingCode": "string"
    }

    https://api.spectrocloud.com/v1alpha1/overlords/vsphere

    summary:
    Retrieves a list of overlords owned by the tenant
    Parameters:
    NameTypeDescriptionRequired
    namestringno
    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": {
    "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/v1alpha1/overlords/vsphere/manifest

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

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

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

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/overlords/vsphere/{uid}

    summary:
    Returns the specified overlord for the given uid
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    (empty)
    {
    "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/v1alpha1/overlords/vsphere/{uid}

    summary:
    Updates the specified overlord
    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": {
    "agentVersion": "string",
    "hostname": "string",
    "ipAddress": "string"
    }
    }
    204
    The resource was updated successfully

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

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

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

    summary:
    update the vSphere cloudaccount for the overlord
    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/v1alpha1/overlords/vsphere/{uid}/account

    summary:
    create the vSphere cloudaccount for the overlord
    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/v1alpha1/overlords/vsphere/{uid}/account/validate

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

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

    summary:
    update the vSphere cloud config for the overlord
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "clusterConfig": {
    "network":deprecated {
    "networkName": "string",
    "parentPoolUid": "string",
    "staticIp": "boolean"
    },
    "ntpServers": [
    "string"
    ],
    "placement":deprecated {
    "cluster": "string",
    "datacenter": "string",
    "datastore": "string",
    "folder": "string",
    "imageTemplateFolder": "string",
    "network": {
    "networkName": "string",
    "parentPoolUid": "string",
    "staticIp": "boolean"
    },
    "resourcePool": "string",
    "uid": "string"
    },
    "placements": [
    {
    "cluster": "string",
    "datacenter": "string",
    "datastore": "string",
    "folder": "string",
    "imageTemplateFolder": "string",
    "network": {
    "networkName": "string",
    "parentPoolUid": "string",
    "staticIp": "boolean"
    },
    "resourcePool": "string",
    "uid": "string"
    }
    ],
    "sshKeys": [
    "string"
    ],
    "staticIp": "boolean"
    },
    "size": "integer"
    }
    204
    The resource was updated successfully

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

    summary:
    create the vSphere cloud config for the overlord
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "clusterConfig": {
    "network":deprecated {
    "networkName": "string",
    "parentPoolUid": "string",
    "staticIp": "boolean"
    },
    "ntpServers": [
    "string"
    ],
    "placement":deprecated {
    "cluster": "string",
    "datacenter": "string",
    "datastore": "string",
    "folder": "string",
    "imageTemplateFolder": "string",
    "network": {
    "networkName": "string",
    "parentPoolUid": "string",
    "staticIp": "boolean"
    },
    "resourcePool": "string",
    "uid": "string"
    },
    "placements": [
    {
    "cluster": "string",
    "datacenter": "string",
    "datastore": "string",
    "folder": "string",
    "imageTemplateFolder": "string",
    "network": {
    "networkName": "string",
    "parentPoolUid": "string",
    "staticIp": "boolean"
    },
    "resourcePool": "string",
    "uid": "string"
    }
    ],
    "sshKeys": [
    "string"
    ],
    "staticIp": "boolean"
    },
    "size": "integer"
    }
    201
    Created successfully
    {
    "uid": "string"
    }

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/overlords/vsphere/{uid}/properties/computecluster/resources

    summary:
    Retrieves the vSphere computecluster resources for the specified overlord account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    datacenterstringyes
    computeclusterstringyes
    200
    (empty)
    {
    "computecluster": {
    "computecluster":deprecated "string",
    "datastores": [
    "string"
    ],
    "name": "string",
    "networks": [
    "string"
    ],
    "resourcePools": [
    "string"
    ]
    },
    "datacenter": "string"
    }

    deprecated

    https://api.spectrocloud.com/v1alpha1/overlords/vsphere/{uid}/properties/datacenter/resources

    summary:
    Retrieves the vSphere computecluster resources for the specified overlord account
    description:
    Deprecated. Use /overlords/vsphere/{uid}/properties/computecluster/resources
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    datacenterstringyes
    computeclusterstringno
    200
    (empty)
    {
    "computeclusters": [
    {
    "computecluster":deprecated "string",
    "datastores": [
    "string"
    ],
    "name": "string",
    "networks": [
    "string"
    ],
    "resourcePools": [
    "string"
    ]
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/overlords/vsphere/{uid}/properties/datacenters

    summary:
    Retrieves the vSphere datacenters & datacluster for the specified overlord account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    (empty)
    {
    "items": [
    {
    "computeclusters": [
    "string"
    ],
    "datacenter": "string",
    "folders": [
    "string"
    ]
    }
    ]
    }

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

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