Clouds

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

summary:
Retrieves a aws external id
200
(empty)
{
"accountId": "string",
"externalId": "string"
}

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

summary:
Validate the specified AWS account credentials
Parameters:
NameTypeDescriptionRequired
awsCloudAccountyes
204
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:
NameTypeDescriptionRequired
cloudWatchConfigyes
204
Ok reponse without content

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

summary:
Get aws ecr authorization token
{
"awsCloudAccount": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
},
"endpoint": "string",
"isPrivate": "boolean"
}
200
(empty)
{
"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:
NameTypeDescriptionRequired
ecrImageEntityyes
204
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:
NameTypeDescriptionRequired
ecrRegistryCredentialsyes
204
Ok reponse without content

https://api.spectrocloud.com/v1/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/v1/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/v1/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/v1/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/v1/clouds/aws/regions/{region}/instancetypes

summary:
Retrieves a list of AWS instance types
Parameters:
NameTypeDescriptionRequired
regionstringyes
cpuGtEqnumberno
memoryGtEqnumberno
gpuGtEqnumberno
200
(empty)
{
"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:
NameTypeDescriptionRequired
regionstringyes
cloudAccountUidstringyes
200
(empty)
{
"keyNames": [
"string"
]
}

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

summary:
Retrieves a list of AWS storage types
Parameters:
NameTypeDescriptionRequired
regionstringyes
200
(empty)
{
"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:
NameTypeDescriptionRequired
regionstringyes
cloudAccountUidstringyes
200
(empty)
{
"vpcs": [
{
"cidrBlock": "string",
"name": "string",
"subnets": [
{
"az": "string",
"isPrivate": "boolean",
"name": "string",
"subnetId": "string"
}
],
"vpcId": "string"
}
]
}

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:
NameTypeDescriptionRequired
azureCloudAccountyes
204
Ok reponse without content

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

summary:
Retrieves a list of Azure groups
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringno
200
(empty)
{
"groups": [
{
"id": "string",
"name": "string"
}
]
}

https://api.spectrocloud.com/v1/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/v1/clouds/azure/regions/{region}/instancetypes

summary:
Retrieves a list of Azure instance types
Parameters:
NameTypeDescriptionRequired
regionstringyes
cpuGtEqnumberno
memoryGtEqnumberno
gpuGtEqnumberno
200
(empty)
{
"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:
NameTypeDescriptionRequired
regionstringyes
200
(empty)
{
"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}/aksClusterName/validate

summary:
Check if Azure cluster name is valid
description:
Returns no contents if azure cluster name is valid else error.
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringyes
namestringyes
regionstringyes
subscriptionIdstringyes
resourceGroupstringyes
204
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:
NameTypeDescriptionRequired
cloudAccountUidstringyes
regionstringyes
subscriptionIdstringyes
200
(empty)
{
"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:
NameTypeDescriptionRequired
cloudAccountUidstringyes
regionstringyes
subscriptionIdstringyes
200
(empty)
{
"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:
NameTypeDescriptionRequired
regionstringyes
200
(empty)
{
"zoneList": [
{
"id": "string"
}
]
}

https://api.spectrocloud.com/v1/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/v1/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/v1/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/v1/clouds/gcp/account/validate

summary:
Validate the specified GCP account credentials
Parameters:
NameTypeDescriptionRequired
gcpCloudAccountyes
204
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:
NameTypeDescriptionRequired
imageNamestringyes
200
(empty)
{
"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:
NameTypeDescriptionRequired
cloudAccountUidstringyes
200
(empty)
{
"projects": [
{
"id": "string",
"name": "string"
}
]
}

https://api.spectrocloud.com/v1/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/v1/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/v1/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/v1/clouds/gcp/regions/{region}/instancetypes

summary:
Retrieves a list of GCP instance types
Parameters:
NameTypeDescriptionRequired
regionstringyes
cpuGtEqnumberno
memoryGtEqnumberno
gpuGtEqnumberno
200
(empty)
{
"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:
NameTypeDescriptionRequired
regionstringyes
200
(empty)
{
"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:
NameTypeDescriptionRequired
accountyes
204
Ok reponse without content

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

summary:
Returns the maas zones
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringno
200
(empty)
{
"items": [
{
"description": "string",
"name": "string"
}
]
}

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

summary:
Returns the maas domains
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringno
200
(empty)
{
"items": [
{
"name": "string"
}
]
}

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

summary:
Returns the maas pools
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringno
200
(empty)
{
"items": [
{
"description": "string",
"name": "string"
}
]
}

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

summary:
Returns the maas subnets
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringno
200
(empty)
{
"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:
NameTypeDescriptionRequired
openstackCloudAccountyes
204
Ok reponse without content

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

summary:
Returns the openstack azs
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringno
projectstringno
regionstringno
domainstringno
200
(empty)
{
"azs": [
{
"name": "string"
}
]
}

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

summary:
Returns the openstack flavors
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringno
projectstringno
regionstringno
domainstringno
200
(empty)
{
"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:
NameTypeDescriptionRequired
cloudAccountUidstringno
projectstringno
regionstringno
domainstringno
200
(empty)
{
"items": [
{
"name": "string",
"publicKey": "string"
}
]
}

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

summary:
Returns the openstack networks
Parameters:
NameTypeDescriptionRequired
cloudAccountUidstringno
projectstringno
regionstringno
domainstringno
200
(empty)
{
"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:
NameTypeDescriptionRequired
cloudAccountUidstringno
200
(empty)
{
"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:
NameTypeDescriptionRequired
cloudAccountUidstringno
200
(empty)
{
"domains": [
{
"description": "string",
"id": "string",
"name": "string"
}
],
"regions": [
{
"description": "string",
"id": "string",
"parentRegionId": "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:
NameTypeDescriptionRequired
vsphereCloudAccountyes
204
Ok reponse without content

https://api.spectrocloud.com/v1/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/v1/clouds/vsphere/datacenters/{uid}/computeclusters/{computecluster}

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

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

summary:
Retrieves vsphere env
Parameters:
NameTypeDescriptionRequired
vsphereCloudAccountyes
200
(empty)
{
"version": "string"
}

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

summary:
Retrieves the cloud instance price based on zone
Parameters:
NameTypeDescriptionRequired
cloudTypestringyes
instanceTypestringyes
zonestringyes
200
(empty)
{
"spotPrice": "number"
}