Clouds

→

https://api.spectrocloud.com/v1/clouds/aws/account/sts

summary:

Retrieves a aws external id

HTTP code: 200
Description: (empty)
Response body:

{
  "accountId": "string",
  "externalId": "string"
}

→

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

summary:

Validate the specified AWS account credentials

Parameters:

Name	Type	Description	Required
awsCloudAccount			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/clouds/aws/cloudwatch/validate

summary:

validates aws cloud watch credentials

description:

Validates aws cloud watch credentials

Parameters:

Name	Type	Description	Required
cloudWatchConfig			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/clouds/aws/cost

summary:

Retrieves AWS cloud account usage cost from cost explorer.

Body

{
  "accountId": "string",
  "credentials": {
    "accessKey": "string",
    "credentialType": "string",
    "secretKey": "string",
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  },
  "filter": {
    "endTime": "date-time",
    "iamUserId": "string",
    "startTime": "date-time"
  }
}

HTTP code: 200
Description: (empty)
Response body:

{
  "cost": {
    "monthlyCosts": [
      {
        "amount": "number",
        "timestamp": "integer"
      }
    ],
    "total": "number"
  }
}

→

https://api.spectrocloud.com/v1/clouds/aws/ecr/authToken

summary:

Get aws ecr authorization token

Body

{
  "awsCloudAccount": {
    "accessKey": "string",
    "credentialType": "string",
    "secretKey": "string",
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  },
  "endpoint": "string",
  "isPrivate": "boolean",
  "region": "string"
}

HTTP code: 200
Description: (empty)
Response body:

{
  "password": "string",
  "username": "string"
}

→

https://api.spectrocloud.com/v1/clouds/aws/ecr/image/validate

summary:

validates ecr registry image

description:

Validates aws ecr registry image

Parameters:

Name	Type	Description	Required
ecrImageEntity			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/clouds/aws/ecr/validate

summary:

validates ecr registry credentials

description:

Validates aws ecr registry credentials

Parameters:

Name	Type	Description	Required
ecrRegistryCredentials			yes

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Retrieves a list of AWS regions for the sepcified account

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "regions": [
    {
      "endpoint": "string",
      "name": "string",
      "optInStatus": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of AWS availability zones for the specified region

Parameters:

Name	Type	Description	Required
region	string		yes
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "zones": [
    {
      "name": "string",
      "state": "string",
      "zoneId": "string"
    }
  ]
}

→

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

summary:

Copies the specified image from one region to another region

Parameters:

Name	Type	Description	Required
region	string		yes
spectroClusterAwsImageTag			no

HTTP code: 200
Description: (empty)
Response body:

{
  "operationId": "string"
}

→

https://api.spectrocloud.com/v1/clouds/aws/regions/{region}/eksClusters/name/validate

summary:

Check if Aws cluster name is valid

description:

Returns no contents if aws cluster name is valid else error.

Parameters:

Name	Type	Required
cloudAccountUid	string	yes
name	string	yes
region	string	yes

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Returns AWS image for the specified AMI name

Parameters:

Name	Type	Description	Required
region	string		yes
awsImageRequest			no

HTTP code: 200
Description: (empty)
Response body:

{
  "id": "string",
  "name": "string",
  "owner": "string"
}

→

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

summary:

Retrieves a list of AWS instance types

Parameters:

Name	Type	Required
region	string	yes
cpuGtEq	number	no
memoryGtEq	number	no
gpuGtEq	number	no
cloudAccountUid	string	no

HTTP code: 200
Description: (empty)
Response body:

{
  "instanceTypes": [
    {
      "category": "string",
      "cost": {
        "price": [
          {
            "onDemand": "number",
            "os": "string",
            "spot": "number"
          }
        ]
      },
      "cpu": "number",
      "gpu": "number",
      "memory": "number",
      "nonSupportedZones": [
        "string"
      ],
      "price": "number",
      "supportedArchitectures": [
        "string"
      ],
      "type": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of AWS keypairs

Parameters:

Name	Type	Description	Required
region	string		yes
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "keyNames": [
    "string"
  ]
}

→

https://api.spectrocloud.com/v1/clouds/aws/regions/{region}/storagetypes

summary:

Retrieves a list of AWS storage types

Parameters:

Name	Type	Description	Required
region	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "storageTypes": [
    {
      "cost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      },
      "iopsCost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      },
      "kind": "string",
      "name": "string",
      "throughputCost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      }
    }
  ]
}

→

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

summary:

Retrieves a list of vpcs for the specified account

Parameters:

Name	Type	Description	Required
region	string		yes
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "vpcs": [
    {
      "cidrBlock": "string",
      "name": "string",
      "subnets": [
        {
          "az": "string",
          "isPrivate": "boolean",
          "name": "string",
          "subnetId": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/aws/s3/validate

summary:

Validate the aws S3 bucket

Parameters:

Name	Type	Description	Required
awsS3Credential			yes

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Check if Azure account is valid

description:

Returns no contents if account is valid else error.

Parameters:

Name	Type	Description	Required
azureCloudAccount			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/clouds/azure/groups

summary:

Retrieves a list of Azure groups

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "groups": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of Azure regions

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no
subscriptionId	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "regions": [
    {
      "displayName": "string",
      "name": "string",
      "zones": [
        {
          "name": "string"
        }
      ]
    }
  ]
}

→

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

summary:

Retrieves a list of Azure instance types

Parameters:

Name	Type	Required
region	string	yes
cpuGtEq	number	no
memoryGtEq	number	no
gpuGtEq	number	no

HTTP code: 200
Description: (empty)
Response body:

{
  "instanceTypes": [
    {
      "category": "string",
      "cost": {
        "price": [
          {
            "onDemand": "number",
            "os": "string",
            "spot": "number"
          }
        ]
      },
      "cpu": "number",
      "gpu": "number",
      "memory": "number",
      "nonSupportedZones": [
        "string"
      ],
      "price": "number",
      "supportedArchitectures": [
        "string"
      ],
      "type": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/azure/regions/{region}/storagetypes

summary:

Retrieves a list of Azure storage types

Parameters:

Name	Type	Description	Required
region	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "storageTypes": [
    {
      "cost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      },
      "iopsCost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      },
      "kind": "string",
      "name": "string",
      "throughputCost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/azure/regions/{region}/subscriptions/{subscriptionId}/aksClusters/name/validate

summary:

Check if Azure cluster name is valid

description:

Returns no contents if azure cluster name is valid else error.

Parameters:

Name	Type	Required
cloudAccountUid	string	yes
name	string	yes
region	string	yes
subscriptionId	string	yes
resourceGroup	string	yes

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Retrieves a list of Azure virtual network list for the sepcified account

Parameters:

Name	Type	Required
cloudAccountUid	string	yes
region	string	yes
subscriptionId	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "virtualNetworkList": [
    {
      "addressSpaces": [
        "string"
      ],
      "id": "string",
      "location": "string",
      "name": "string",
      "subnets": [
        {
          "cidrBlock": "string",
          "name": "string",
          "securityGroupName": "string"
        }
      ],
      "type": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of Azure resource group for the sepcified account

Parameters:

Name	Type	Required
cloudAccountUid	string	yes
region	string	yes
subscriptionId	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "resourceGroupList": [
    {
      "id": "string",
      "location": "string",
      "name": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of Azure zones for the specified region

Parameters:

Name	Type	Description	Required
region	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "zoneList": [
    {
      "id": "string"
    }
  ]
}

→

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

summary:

Get Azure storage account types

description:

Returns Azure storage account types.

Parameters:

Name	Type	Description	Required
region	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "storageAccountTypes": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of Azure subscription list for the sepcified account

description:

Returns list of Azure subscription list.

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "subscriptionList": [
    {
      "authorizationSource": "string",
      "displayName": "string",
      "state": "string",
      "subscriptionId": "string"
    }
  ]
}

→

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

summary:

Returns the Azure vhd url for the specified vhd location

Parameters:

Name	Type	Description	Required
vhd	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "name": "string",
  "url": "string"
}

→

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

summary:

Validate the specified GCP account credentials

Parameters:

Name	Type	Description	Required
gcpCloudAccount			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/clouds/gcp/image/container/validate

summary:

Validates the image with tag

Parameters:

Name	Type	Description	Required
imagePath	string		yes
tag	string		yes

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Returns the Gcp image url for the specified image location

Parameters:

Name	Type	Description	Required
imageName	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "imageFamily": "string",
  "imageUrl": "string",
  "name": "string"
}

→

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

summary:

Retrieves a list of GCP projects for the sepcified account

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "projects": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of GCP regions

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		yes
project	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "regions": [
    {
      "name": "string",
      "status": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of GCP networks for the sepcified account

Parameters:

Name	Type	Required
cloudAccountUid	string	yes
region	string	yes
project	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "networks": [
    {
      "name": "string",
      "subnets": [
        {
          "name": "string"
        }
      ]
    }
  ]
}

→

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

summary:

Retrieves a list of GCP zones for the sepcified account

Parameters:

Name	Type	Required
cloudAccountUid	string	yes
region	string	yes
project	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "zones": [
    {
      "name": "string"
    }
  ]
}

→

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

summary:

Retrieves a list of GCP instance types

Parameters:

Name	Type	Required
region	string	yes
cpuGtEq	number	no
memoryGtEq	number	no
gpuGtEq	number	no

HTTP code: 200
Description: (empty)
Response body:

{
  "instanceTypes": [
    {
      "category": "string",
      "cost": {
        "price": [
          {
            "onDemand": "number",
            "os": "string",
            "spot": "number"
          }
        ]
      },
      "cpu": "number",
      "gpu": "number",
      "memory": "number",
      "nonSupportedZones": [
        "string"
      ],
      "price": "number",
      "supportedArchitectures": [
        "string"
      ],
      "type": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/gcp/regions/{region}/storagetypes

summary:

Retrieves a list of Gcp storage types

Parameters:

Name	Type	Description	Required
region	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "storageTypes": [
    {
      "cost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      },
      "iopsCost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      },
      "kind": "string",
      "name": "string",
      "throughputCost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/maas/account/validate

summary:

Check if Maas account is valid

description:

Returns no contents if account is valid else error.

Parameters:

Name	Type	Description	Required
account			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/clouds/maas/azs

summary:

Returns the maas zones

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "description": "string",
      "name": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/maas/domains

summary:

Returns the maas domains

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "name": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/maas/resourcePools

summary:

Returns the maas pools

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "description": "string",
      "name": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/maas/subnets

summary:

Returns the maas subnets

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "id": "integer",
      "name": "string",
      "space": "string",
      "vlans": {
        "fabric": "string",
        "id": "integer",
        "name": "string"
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/openstack/account/validate

summary:

Check if OpenStack account is valid

description:

Returns no contents if account is valid else error.

Parameters:

Name	Type	Description	Required
openstackCloudAccount			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/clouds/openstack/azs

summary:

Returns the openstack azs

Parameters:

Name	Type	Required
cloudAccountUid	string	no
project	string	no
region	string	no
domain	string	no

HTTP code: 200
Description: (empty)
Response body:

{
  "azs": [
    {
      "name": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/openstack/flavors

summary:

Returns the openstack flavors

Parameters:

Name	Type	Required
cloudAccountUid	string	no
project	string	no
region	string	no
domain	string	no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "disk": "integer",
      "ephemeral": "integer",
      "id": "string",
      "memory": "integer",
      "name": "string",
      "vcpus": "integer"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/openstack/keypairs

summary:

Returns the openstack keypair

Parameters:

Name	Type	Required
cloudAccountUid	string	no
project	string	no
region	string	no
domain	string	no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "name": "string",
      "publicKey": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/openstack/networks

summary:

Returns the openstack networks

Parameters:

Name	Type	Required
cloudAccountUid	string	no
project	string	no
region	string	no
domain	string	no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "description": "string",
      "id": "string",
      "name": "string",
      "subnets": [
        {
          "description": "string",
          "id": "string",
          "name": "string"
        }
      ]
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/openstack/projects

summary:

Returns the openstack projects

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "description": "string",
      "domainId": "string",
      "id": "string",
      "name": "string",
      "parentProjectId": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/openstack/regions

summary:

Returns the openstack regions

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "domains": [
    {
      "description": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "regions": [
    {
      "description": "string",
      "id": "string",
      "parentRegionId": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/tencent/account/validate

summary:

Validate the specified Tencent account credentials

Parameters:

Name	Type	Description	Required
account			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1/clouds/tencent/regions

summary:

Retrieves a list of Tencent regions for the sepcified account

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "regions": [
    {
      "name": "string",
      "state": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/tencent/regions/{region}/instancetypes

summary:

Retrieves a list of Tencent instance types

Parameters:

Name	Type	Required
region	string	yes
cpuGtEq	number	no
memoryGtEq	number	no
gpuGtEq	number	no
cloudAccountUid	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "instanceTypes": [
    {
      "category": "string",
      "cost": {
        "price": [
          {
            "onDemand": "number",
            "os": "string",
            "spot": "number"
          }
        ]
      },
      "cpu": "number",
      "gpu": "number",
      "memory": "number",
      "nonSupportedZones": [
        "string"
      ],
      "price": "number",
      "supportedArchitectures": [
        "string"
      ],
      "type": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/tencent/regions/{region}/keypairs

summary:

Retrieves a list of keypairs for the specified account

Parameters:

Name	Type	Description	Required
region	string		yes
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "keypairs": [
    {
      "id": "string",
      "name": "string",
      "publickey": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/tencent/regions/{region}/securitygroups

summary:

Retrieves a list of secutity groups for the specified account

Parameters:

Name	Type	Description	Required
region	string		yes
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "groups": [
    {
      "id": "string",
      "isDefault": "boolean",
      "name": "string",
      "projectId": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/tencent/regions/{region}/storagetypes

summary:

Retrieves a list of Tencent storage types

Parameters:

Name	Type	Required
region	string	yes
cloudAccountUid	string	yes
zone	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "storageTypes": [
    {
      "cost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      },
      "iopsCost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      },
      "kind": "string",
      "name": "string",
      "throughputCost": {
        "discountedUsage": "string",
        "price": [
          {
            "limit": "string",
            "price": "string"
          }
        ]
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/tencent/regions/{region}/vpcs

summary:

Retrieves a list of vpcs for the specified account

Parameters:

Name	Type	Description	Required
region	string		yes
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "vpcs": [
    {
      "cidrBlock": "string",
      "name": "string",
      "subnets": [
        {
          "cidrBlock": "string",
          "name": "string",
          "subnetId": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clouds/tencent/regions/{region}/zones

summary:

Retrieves a list of Tencent availability zones for the specified region

Parameters:

Name	Type	Description	Required
region	string		yes
cloudAccountUid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "zones": [
    {
      "name": "string",
      "state": "string",
      "zoneId": "string"
    }
  ]
}

→

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

summary:

Check if Vsphere account is valid

description:

Returns no contents if account is valid else error.

Parameters:

Name	Type	Description	Required
vsphereCloudAccount			yes

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Returns the vsphere data centers

Parameters:

Name	Type	Description	Required
cloudAccountUid	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "computeclusters": [
        "string"
      ],
      "datacenter": "string",
      "folders": [
        "string"
      ]
    }
  ]
}

→

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

summary:

Returns the resources for vsphere compute cluster

Parameters:

Name	Type	Required
cloudAccountUid	string	yes
computecluster	string	yes
uid	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "computecluster": {
    "datastores": [
      "string"
    ],
    "name": "string",
    "networks": [
      "string"
    ],
    "resourcePools": [
      "string"
    ]
  },
  "datacenter": "string"
}

→

https://api.spectrocloud.com/v1/clouds/vsphere/env

summary:

Retrieves vsphere env

Parameters:

Name	Type	Description	Required
vsphereCloudAccount			yes

HTTP code: 200
Description: (empty)
Response body:

{
  "version": "string"
}

→

https://api.spectrocloud.com/v1/clouds/{cloudType}/instance/spotprice

summary:

Retrieves the cloud instance price based on zone

Parameters:

Name	Type	Description	Required
cloudType	string		yes
instanceType	string		yes
zone	string		yes
timestamp	string	Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.	no

HTTP code: 200
Description: (empty)
Response body:

{
  "spotPrice": "number"
}

→

https://api.spectrocloud.com/v1/clouds/{cloud}/compute/{type}/rate

summary:

Returns the cloud compute rate

Parameters:

Name	Type	Required
cloud	string	yes
type	string	yes
region	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "compute": "number",
  "storage": "number",
  "total": "number"
}

→

https://api.spectrocloud.com/v1/clouds/{cloud}/storage/{type}/rate

summary:

Returns the cloud storage rate

Parameters:

Name	Type	Required
cloud	string	yes
type	string	yes
region	string	yes
maxDiskType	integer	no

HTTP code: 200
Description: (empty)
Response body:

{
  "compute": "number",
  "storage": "number",
  "total": "number"
}

Edit on GitHub