Clouds

→

https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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

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

{
  "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:

Name	Type	Description	Required
region	string		yes
cloudAccountUid	string		yes

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

{
  "keyNames": [
    "string"
  ]
}

→

https://api.spectrocloud.com/v1alpha1/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": [
    {
      "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:

Name	Type	Description	Required
azureCloudAccount			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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",
      "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:

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

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

{
  "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:

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/v1alpha1/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/v1alpha1/clouds/azure/storageaccounttypes

summary:

Get Azure storage account types

description:

Returns Azure storage account types.

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

{
  "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:

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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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",
      "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:

Name	Type	Description	Required
vsphereCloudAccount			yes

HTTP code: 204
Description: Ok reponse without content

→

https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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/v1alpha1/clouds/vsphere/env

summary:

Retrieves vsphere env

Parameters:

Name	Type	Description	Required
vsphereCloudAccount			yes

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

{
  "version": "string"
}

Edit on GitHub