Get supported cloud providers.

GET

/cloud-providers

Returns a list of supported cloud providers and regions.

Authorizations

• publicOauth2

Parameters

Query Parameters

filter

Optional filters for cloud provider, region, and instance type characteristics.

object

cloudProvider

string

Example:

aws

region

string

Example:

us-east-1

minDisks

integer

minStorageGiB

integer

minMemoryGiB

integer

Responses

200

Set of available cloud providers

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

object

count

required

Number of items returned in the result.

integer

Example:

1

results

Array<object>

object

id

required

The ID of the cloud provider.

string

Allowed values:

aws

azure

gcp

name

required

Human friendly (i.e. branded) name of the cloud provider.

string

Example:

Amazon Web Services (AWS)

regions

required

Array<object>

object

name

required

string

Example:

us-east-1

instanceTypes

required

Array<object>

object

instanceType

required

string

Example:

trn1.32xlarge

vcpus

required

integer

Example:

128

memoryGib

required

integer

Example:

512

localStorage

required

object

numberOfDisks

required

integer

Example:

4

diskSizeGib

required

integer

Example:

1900

totalSizeGib

required

integer

Example:

7600

supportedArchitectures

required

Array<string>

Allowed values:

x86_64

arm64

Example

Content type: application/json

Copied!

{ 

{

"count": 1,

"results": [ 

{ 

"id": "aws",

"name": "Amazon Web Services (AWS)",

"regions": [ 

{ 

"name": "us-east-1",

"instanceTypes": [ 

{ 

"instanceType": "trn1.32xlarge",

"vcpus": 128,

"memoryGib": 512,

"localStorage": { 

"numberOfDisks": 4,

"diskSizeGib": 1900,

"totalSizeGib": 7600

},

"supportedArchitectures": [ 

"x86_64"

]

}

]

}

]

}

]

}

401

Access token is missing or invalid

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "invalid_token",

"message": "The access token expired."

}

403

Permission denied

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

501

The endpoint has not been implemented yet.

Response Schema

object

message

string

Example:

This endpoint has not been implemented yet.

Example

Content type: application/json

Copied!

{ 

{

"message": "This endpoint has not been implemented yet."

}