Cloud

Generic cloud endpoints

Get all available cloud provider details

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Cloud provider ID

namestringRead-onlyRequired

Cloud provider's name

shortNamestringRead-onlyRequired

Cloud provider's short name (abbreviation)

activeinteger · integerRead-onlyRequired

Cloud provider's status

get
/v3/cloud/provider

Get all available data center locations for a specific cloud provider

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
providerIdstringRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Datacenter location ID

continentIdinteger · integerRead-onlyRequired

Continent ID

  • 1: Africa
  • 2: Antarctica
  • 3: Asia
  • 4: Australia
  • 5: Europe
  • 6: Middle East
  • 7: North America
  • 8: South America
countrystringRead-onlyRequired

Country name

displayNamestringRead-onlyRequired

The datacenter location's name

providerIdinteger · integerRead-onlyRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

availabilityZonesstring[]Read-onlyRequired

Data center availability zones (only applies to cloud data centers)

regionNamestringRead-onlyRequired

Data center region name (only applies to cloud data centers)

pingSiteIdsstring[]Required

Host name for the corresponding data center location.

get
/v3/cloud/provider/{providerId}/dcLocation

Get all data center locations of all cloud providers

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Datacenter location ID

continentIdinteger · integerRead-onlyRequired

Continent ID

  • 1: Africa
  • 2: Antarctica
  • 3: Asia
  • 4: Australia
  • 5: Europe
  • 6: Middle East
  • 7: North America
  • 8: South America
countrystringRead-onlyRequired

Country name

displayNamestringRead-onlyRequired

The datacenter location's name

providerIdinteger · integerRead-onlyRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

availabilityZonesstring[]Read-onlyRequired

Data center availability zones (only applies to cloud data centers)

regionNamestringRead-onlyRequired

Data center region name (only applies to cloud data centers)

pingSiteIdsstring[]Required

Host name for the corresponding data center location.

get
/v3/cloud/dcLocation

Get details for a specific data center location

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
dcLocationIdstringRequired

i3D.net or cloud data center location ID. For a list of all data center locations see GET /v3/cloud/dcLocation

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Datacenter location ID

continentIdinteger · integerRead-onlyRequired

Continent ID

  • 1: Africa
  • 2: Antarctica
  • 3: Asia
  • 4: Australia
  • 5: Europe
  • 6: Middle East
  • 7: North America
  • 8: South America
countrystringRead-onlyRequired

Country name

displayNamestringRead-onlyRequired

The datacenter location's name

providerIdinteger · integerRead-onlyRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

availabilityZonesstring[]Read-onlyRequired

Data center availability zones (only applies to cloud data centers)

regionNamestringRead-onlyRequired

Data center region name (only applies to cloud data centers)

pingSiteIdsstring[]Required

Host name for the corresponding data center location.

get
/v3/cloud/dcLocation/{dcLocationId}

Get a mapping of all cloud datacenter locations in the vicinity of i3D.net dcLocations

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
i3dDcLocationIdinteger · integerRead-onlyRequired

An i3D.net dcLocationId

cloudDcLocationIdinteger · integerRead-onlyRequired

A cloud dcLocationId

get
/v3/cloud/dcLocation/vicinityMapping

Get a mapping of all cloud data center locations in the vicinity of a i3D.net dcLocation

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
dcLocationIdsstringRequired

Comma separated array of data center location Ids, example: id1,id2. For a list of all data center locations see GET /v3/cloud/dcLocation

Responses
chevron-right
200

OK

application/json
i3dDcLocationIdinteger · integerRead-onlyRequired

An i3D.net dcLocationId

cloudDcLocationIdinteger · integerRead-onlyRequired

A cloud dcLocationId

get
/v3/cloud/dcLocation/{dcLocationIds}/vicinityMapping

Get cloud provider instance types

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
instanceTypeIdinteger · integerRead-onlyRequired
cloudProviderIdinteger · integerRead-onlyRequired

The cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider)

dcLocationIdinteger · integerRead-onlyRequired
instanceTypestringRead-onlyRequired
numCoresinteger · integerRead-onlyRequired
memoryinteger · integerRead-onlyRequired
storagestringRead-onlyRequired
statusinteger · integerRead-onlyRequired

It will show either instance type is available or not

get
/v3/cloud/instanceType

Get cloud provider instance types for a specific dcLocationId

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
dcLocationIdintegerRequired

The Id of the data center location. For a list of all data center locations see GET /v3/cloud/dcLocation

Responses
chevron-right
200

OK

application/json
instanceTypeIdinteger · integerRead-onlyRequired
cloudProviderIdinteger · integerRead-onlyRequired

The cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider)

dcLocationIdinteger · integerRead-onlyRequired
instanceTypestringRead-onlyRequired
numCoresinteger · integerRead-onlyRequired
memoryinteger · integerRead-onlyRequired
storagestringRead-onlyRequired
statusinteger · integerRead-onlyRequired

It will show either instance type is available or not

get
/v3/cloud/instanceType/{dcLocationId}

Get available cloud provider CPU platforms

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

dcLocationIdinteger · integerRequired
cpuPlatformstring · nullableRequired
get
/v3/cloud/cpuPlatform

Get available cloud provider CPU platforms for a specific dcLocationId

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
dcLocationIdintegerRequired

The Id of the data center location. For a list of all data center locations see GET /v3/cloud/dcLocation

Responses
chevron-right
200

OK

application/json
providerIdinteger · integerRequired

Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider

dcLocationIdinteger · integerRequired
cpuPlatformstring · nullableRequired
get
/v3/cloud/cpuPlatform/{dcLocationId}

Get all available virtual machine logs

get

For a list of cloud providers see GET /v3/cloud/provider)

Authorizations
PRIVATE-TOKENstringRequired
Header parameters
RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses
chevron-right
200

OK

application/json
cloudInstanceIdstringRead-onlyRequired
titlestringRead-onlyRequired
logstringRead-onlyRequired
timestampinteger · integerRead-onlyRequired

Unix timestamp

get
/v3/cloud/vm/log

Get all available virtual machine errors

get

For a list of cloud providers see GET /v3/cloud/provider)

Authorizations
PRIVATE-TOKENstringRequired
Header parameters
RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

ID of the virtual machine error

hostIdinteger · integerRead-onlyRequired

ID of the host

messagestringRead-onlyRequired

Message of error

argumentsstring[]Read-onlyRequired

Arguments generated by the systems

solvedinteger · integerRead-onlyRequired

Status of the error

createdAtinteger · integerRead-onlyRequired

Unix timestamp

get
/v3/cloud/vm/error

Get all available virtual machine uptime

get

For a list of cloud providers see GET /v3/cloud/provider

Authorizations
PRIVATE-TOKENstringRequired
Header parameters
RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses
chevron-right
200

OK

application/json
cloudInstanceIdinteger · integerRead-onlyRequired

ID of the VM

providerInstanceIdstringRead-onlyRequired

The virtual machine ID generated by the cloud provider

providerIdinteger · integerRead-onlyRequired

Cloud provider ID

hostIdinteger · integerRead-onlyRequired

The ID of this host

instanceTypestringRead-onlyRequired

The name of the instance type

dcLocationIdinteger · integerRead-onlyRequired

Datacenter location ID. Points to one of GET /v3/cloud/dcLocation

startTimeinteger · integerRead-onlyRequired

Unix timestamp of when the VM was created

stopTimeinteger · integerRead-onlyRequired

Unix timestamp of when the VM was destroyed

upTimeinteger · integerRead-onlyRequired

Uptime in seconds. For a running VM

get
/v3/cloud/vm/uptime

Get list of all the cloud instances

get
Authorizations
PRIVATE-TOKENstringRequired
Header parameters
RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired
providerInstanceIdstringRead-onlyRequired
providerImageIdstringRead-onlyRequired
providerIdinteger · integerRead-onlyRequired

Cloud Provider ID. For a list of cloud providers see GET /v3/cloud/provider

dediServerIdinteger · integerRead-onlyRequired
applicationIdinteger · integerRead-onlyRequired
fleetIdinteger · integerRead-onlyRequired
regionIdinteger · integerRead-onlyRequired
dcLocationIdinteger · integerRead-onlyRequired
instanceTypeIdinteger · integerRead-onlyRequired
availabilityZonestringRead-onlyRequired
namestringRead-onlyRequired
tagstringRead-onlyRequired
publicIpAddressstringRead-onlyRequired
statusinteger · integerRead-onlyRequired
createdAtinteger · integerRead-onlyRequired

Unix timestamp

get
/v3/cloud/instance

Last updated

Was this helpful?