Powered by Algolia

    Clouds

    https://api.spectrocloud.com/v1alpha1/clouds/aws/account/validate

    summary:
    Validate the specified AWS account credentials
    Parameters:
    NameTypeDescriptionRequired
    awsCloudAccountyes
    204
    Ok reponse without content

    https://api.spectrocloud.com/v1alpha1/clouds/aws/regions

    summary:
    Retrieves a list of AWS regions for the sepcified account
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    200
    (empty)
    {
    "regions": [
    {
    "endpoint": "string",
    "name": "string",
    "optInStatus": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/aws/regions/{region}/availabilityzones

    summary:
    Retrieves a list of AWS availability zones for the specified region
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    cloudAccountUidstringyes
    200
    (empty)
    {
    "zones": [
    {
    "name": "string",
    "state": "string",
    "zoneId": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/aws/regions/{region}/copydefaultimages

    summary:
    Copies the specified image from one region to another region
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    spectroClusterAwsImageTagno
    200
    (empty)
    {
    "operationId": "string"
    }

    https://api.spectrocloud.com/v1alpha1/clouds/aws/regions/{region}/images

    summary:
    Returns AWS image for the specified AMI name
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    awsImageRequestno
    200
    (empty)
    {
    "id": "string",
    "name": "string",
    "owner": "string"
    }

    https://api.spectrocloud.com/v1alpha1/clouds/aws/regions/{region}/instancetypes

    summary:
    Retrieves a list of AWS instance types
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    cpuGtEqnumberno
    memoryGtEqnumberno
    gpuGtEqnumberno
    200
    (empty)
    {
    "instanceTypes": [
    {
    "category": "string",
    "cpu": "number",
    "gpu": "number",
    "memory": "number",
    "nonSupportedZones": [
    "string"
    ],
    "price": "number",
    "type": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/aws/regions/{region}/keypairs

    summary:
    Retrieves a list of AWS keypairs
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    cloudAccountUidstringyes
    200
    (empty)
    {
    "keyNames": [
    "string"
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/aws/regions/{region}/vpcs

    summary:
    Retrieves a list of vpcs for the specified account
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    cloudAccountUidstringyes
    200
    (empty)
    {
    "vpcs": [
    {
    "name": "string",
    "subnets": [
    {
    "az": "string",
    "isPrivate": "boolean",
    "name": "string",
    "subnetId": "string"
    }
    ],
    "vpcId": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/azure/account/validate

    summary:
    Check if Azure account is valid
    description:
    Returns no contents if account is valid else error.
    Parameters:
    NameTypeDescriptionRequired
    azureCloudAccountyes
    204
    Ok reponse without content

    https://api.spectrocloud.com/v1alpha1/clouds/azure/regions

    summary:
    Retrieves a list of Azure regions
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringno
    subscriptionIdstringno
    200
    (empty)
    {
    "regions": [
    {
    "displayName": "string",
    "name": "string",
    "zones": [
    {
    "name": "string"
    }
    ]
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/azure/regions/{region}/instancetypes

    summary:
    Retrieves a list of Azure instance types
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    cpuGtEqnumberno
    memoryGtEqnumberno
    gpuGtEqnumberno
    200
    (empty)
    {
    "instanceTypes": [
    {
    "category": "string",
    "cpu": "number",
    "gpu": "number",
    "memory": "number",
    "nonSupportedZones": [
    "string"
    ],
    "price": "number",
    "type": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/azure/regions/{region}/subscriptions/{subscriptionId}/networks

    summary:
    Retrieves a list of Azure virtual network list for the sepcified account
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    regionstringyes
    subscriptionIdstringyes
    200
    (empty)
    {
    "virtualNetworkList": [
    {
    "id": "string",
    "location": "string",
    "name": "string",
    "subnets": [
    {
    "cidrBlock": "string",
    "name": "string",
    "securityGroupName": "string"
    }
    ],
    "type": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/azure/regions/{region}/subscriptions/{subscriptionId}/resourceGroups

    summary:
    Retrieves a list of Azure resource group for the sepcified account
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    regionstringyes
    subscriptionIdstringyes
    200
    (empty)
    {
    "resourceGroupList": [
    {
    "id": "string",
    "location": "string",
    "name": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/azure/regions/{region}/zones

    summary:
    Retrieves a list of Azure zones for the specified region
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    200
    (empty)
    {
    "zoneList": [
    {
    "id": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/azure/storageaccounttypes

    summary:
    Get Azure storage account types
    description:
    Returns Azure storage account types.
    200
    (empty)
    {
    "storageAccountTypes": [
    {
    "id": "string",
    "name": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/azure/subscriptions

    summary:
    Retrieves a list of Azure subscription list for the sepcified account
    description:
    Returns list of Azure subscription list.
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    200
    (empty)
    {
    "subscriptionList": [
    {
    "authorizationSource": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionId": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/azure/vhds/{vhd}/url

    summary:
    Returns the Azure vhd url for the specified vhd location
    Parameters:
    NameTypeDescriptionRequired
    vhdstringyes
    200
    (empty)
    {
    "name": "string",
    "url": "string"
    }

    https://api.spectrocloud.com/v1alpha1/clouds/gcp/account/validate

    summary:
    Validate the specified GCP account credentials
    Parameters:
    NameTypeDescriptionRequired
    gcpCloudAccountyes
    204
    Ok reponse without content

    https://api.spectrocloud.com/v1alpha1/clouds/gcp/images/{imageName}/url

    summary:
    Returns the Gcp image url for the specified image location
    Parameters:
    NameTypeDescriptionRequired
    imageNamestringyes
    200
    (empty)
    {
    "imageFamily": "string",
    "imageUrl": "string",
    "name": "string"
    }

    https://api.spectrocloud.com/v1alpha1/clouds/gcp/projects

    summary:
    Retrieves a list of GCP projects for the sepcified account
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    200
    (empty)
    {
    "projects": [
    {
    "id": "string",
    "name": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/gcp/projects/{project}/regions

    summary:
    Retrieves a list of GCP regions
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    projectstringyes
    200
    (empty)
    {
    "regions": [
    {
    "name": "string",
    "status": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/gcp/projects/{project}/regions/{region}/networks

    summary:
    Retrieves a list of GCP networks for the sepcified account
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    regionstringyes
    projectstringyes
    200
    (empty)
    {
    "networks": [
    {
    "name": "string",
    "subnets": [
    {
    "name": "string"
    }
    ]
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/gcp/projects/{project}/regions/{region}/zones

    summary:
    Retrieves a list of GCP zones for the sepcified account
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    regionstringyes
    projectstringyes
    200
    (empty)
    {
    "zones": [
    {
    "name": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/gcp/regions/{region}/instancetypes

    summary:
    Retrieves a list of GCP instance types
    Parameters:
    NameTypeDescriptionRequired
    regionstringyes
    cpuGtEqnumberno
    memoryGtEqnumberno
    gpuGtEqnumberno
    200
    (empty)
    {
    "instanceTypes": [
    {
    "category": "string",
    "cpu": "number",
    "gpu": "number",
    "memory": "number",
    "nonSupportedZones": [
    "string"
    ],
    "price": "number",
    "type": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/vsphere/account/validate

    summary:
    Check if Vsphere account is valid
    description:
    Returns no contents if account is valid else error.
    Parameters:
    NameTypeDescriptionRequired
    vsphereCloudAccountyes
    204
    Ok reponse without content

    https://api.spectrocloud.com/v1alpha1/clouds/vsphere/datacenters

    summary:
    Returns the vsphere data centers
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringno
    200
    (empty)
    {
    "items": [
    {
    "computeclusters": [
    "string"
    ],
    "datacenter": "string",
    "folders": [
    "string"
    ]
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/clouds/vsphere/datacenters/{uid}/computeclusters/{computecluster}

    summary:
    Returns the resources for vsphere compute cluster
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringyes
    computeclusterstringyes
    uidstringyes
    200
    (empty)
    {
    "computecluster": {
    "computecluster":deprecated "string",
    "datastores": [
    "string"
    ],
    "name": "string",
    "networks": [
    "string"
    ],
    "resourcePools": [
    "string"
    ]
    },
    "datacenter": "string"
    }

    https://api.spectrocloud.com/v1alpha1/clouds/vsphere/datacenters/{uid}/resources

    summary:
    Returns the resources for vsphere datacenter
    Parameters:
    NameTypeDescriptionRequired
    cloudAccountUidstringno
    computeclusterstringno
    uidstringyes
    200
    (empty)
    {
    "computeclusters": [
    {
    "computecluster":deprecated "string",
    "datastores": [
    "string"
    ],
    "name": "string",
    "networks": [
    "string"
    ],
    "resourcePools": [
    "string"
    ]
    }
    ]
    }