Cloud

Generic cloud endpoints

Get all available cloud provider details

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

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

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/provider

HTTPcURLJavaScriptPython

GET /v3/cloud/provider HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "shortName": "text",
    "active": 1
  }
]

Get all available data center locations for a specific cloud provider

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

providerIdstringRequired

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

Responses

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.

403

Invalid credentials

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

GET /v3/cloud/provider/{providerId}/dcLocation HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "continentId": 1,
    "country": "text",
    "displayName": "text",
    "providerId": 1,
    "availabilityZones": [
      "text"
    ],
    "regionName": "text",
    "pingSiteIds": [
      "text"
    ]
  }
]

Get all data center locations of all cloud providers

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

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.

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/dcLocation

HTTPcURLJavaScriptPython

GET /v3/cloud/dcLocation HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "continentId": 1,
    "country": "text",
    "displayName": "text",
    "providerId": 1,
    "availabilityZones": [
      "text"
    ],
    "regionName": "text",
    "pingSiteIds": [
      "text"
    ]
  }
]

Get details for a specific data center location

get

Authorizations

ApiKey

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

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.

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/dcLocation/{dcLocationId}

HTTPcURLJavaScriptPython

GET /v3/cloud/dcLocation/{dcLocationId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "continentId": 1,
    "country": "text",
    "displayName": "text",
    "providerId": 1,
    "availabilityZones": [
      "text"
    ],
    "regionName": "text",
    "pingSiteIds": [
      "text"
    ]
  }
]

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

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

i3dDcLocationIdinteger · integerRead-onlyRequired

An i3D.net dcLocationId

cloudDcLocationIdinteger · integerRead-onlyRequired

A cloud dcLocationId

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/dcLocation/vicinityMapping

HTTPcURLJavaScriptPython

GET /v3/cloud/dcLocation/vicinityMapping HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "i3dDcLocationId": 1,
    "cloudDcLocationId": 1
  }
]

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

get

Authorizations

ApiKey

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

200

OK

application/json

i3dDcLocationIdinteger · integerRead-onlyRequired

An i3D.net dcLocationId

cloudDcLocationIdinteger · integerRead-onlyRequired

A cloud dcLocationId

403

Invalid credentials

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

GET /v3/cloud/dcLocation/{dcLocationIds}/vicinityMapping HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "i3dDcLocationId": 1,
    "cloudDcLocationId": 1
  }
]

Get cloud provider instance types

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

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

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/instanceType

HTTPcURLJavaScriptPython

GET /v3/cloud/instanceType HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "instanceTypeId": 1,
    "cloudProviderId": 1,
    "dcLocationId": 1,
    "instanceType": "text",
    "numCores": 1,
    "memory": 1,
    "storage": "text",
    "status": 1
  }
]

Get cloud provider instance types for a specific dcLocationId

get

Authorizations

ApiKey

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

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

403

Invalid credentials

404

Invalid dcLocationId

500

Internal Server Error

application/json

get

/v3/cloud/instanceType/{dcLocationId}

HTTPcURLJavaScriptPython

GET /v3/cloud/instanceType/{dcLocationId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "instanceTypeId": 1,
    "cloudProviderId": 1,
    "dcLocationId": 1,
    "instanceType": "text",
    "numCores": 1,
    "memory": 1,
    "storage": "text",
    "status": 1
  }
]

Get available cloud provider CPU platforms

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

providerIdinteger · integerRequired

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

dcLocationIdinteger · integerRequired

cpuPlatformstring · nullableRequired

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/cpuPlatform

HTTPcURLJavaScriptPython

GET /v3/cloud/cpuPlatform HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "providerId": 1,
    "dcLocationId": 1,
    "cpuPlatform": "text"
  }
]

Get available cloud provider CPU platforms for a specific dcLocationId

get

Authorizations

ApiKey

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

200

OK

application/json

providerIdinteger · integerRequired

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

dcLocationIdinteger · integerRequired

cpuPlatformstring · nullableRequired

403

Invalid credentials

404

Invalid dcLocationId

500

Internal Server Error

application/json

get

/v3/cloud/cpuPlatform/{dcLocationId}

HTTPcURLJavaScriptPython

GET /v3/cloud/cpuPlatform/{dcLocationId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "providerId": 1,
    "dcLocationId": 1,
    "cpuPlatform": "text"
  }
]

Get all available virtual machine logs

get

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

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

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

Responses

200

OK

application/json

cloudInstanceIdstringRead-onlyRequired

titlestringRead-onlyRequired

logstringRead-onlyRequired

timestampinteger · integerRead-onlyRequired

Unix timestamp

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/vm/log

HTTPcURLJavaScriptPython

GET /v3/cloud/vm/log HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "cloudInstanceId": "text",
    "title": "text",
    "log": "text",
    "timestamp": 1
  }
]

Get all available virtual machine errors

get

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

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

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

Responses

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

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/vm/error

HTTPcURLJavaScriptPython

GET /v3/cloud/vm/error HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "hostId": 1,
    "message": "text",
    "arguments": [
      "text"
    ],
    "solved": 1,
    "createdAt": 1
  }
]

Get all available virtual machine uptime

get

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

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

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

Responses

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

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/vm/uptime

HTTPcURLJavaScriptPython

GET /v3/cloud/vm/uptime HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "cloudInstanceId": 1,
    "providerInstanceId": "text",
    "providerId": 1,
    "hostId": 1,
    "instanceType": "text",
    "dcLocationId": 1,
    "startTime": 1,
    "stopTime": 1,
    "upTime": 1
  }
]

Get list of all the cloud instances

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

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

Responses

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

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/cloud/instance

HTTPcURLJavaScriptPython

GET /v3/cloud/instance HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "providerInstanceId": "text",
    "providerImageId": "text",
    "providerId": 1,
    "dediServerId": 1,
    "applicationId": 1,
    "fleetId": 1,
    "regionId": 1,
    "dcLocationId": 1,
    "instanceTypeId": 1,
    "availabilityZone": "text",
    "name": "text",
    "tag": "text",
    "publicIpAddress": "text",
    "status": 1,
    "createdAt": 1
  }
]