VM

List

Retrieve a list of VM information.

GET/api/Provider/VM

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

namenullable string

Name of the VM

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

usernullable string

VM User

servernullable string

FQDN or IP address of the RAS Server

stateVMState (enum)

VM State

0 = Unknown,1 = On,2 = Off,3 = Paused,9 = CloningFailed,17 = CloningCanceled

nativePoolIdnullable string

ID of Native Pool

isHostboolean

Whether the VM is host or not

isTemplateboolean

Whether the VM is template or not

ipnullable string

IP of the VM

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/VM', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "name": "text",
    "id": "text",
    "user": "text",
    "server": "text",
    "state": [
      "0 = Unknown",
      "1 = On",
      "2 = Off",
      "3 = Paused",
      "9 = CloningFailed",
      "17 = CloningCanceled"
    ],
    "nativePoolId": "text",
    "isHost": false,
    "isTemplate": false,
    "ip": "text"
  }
]

List Provider VMs

Retrieve a list of VM information of a specific Provider by ID.

GET/api/Provider/{providerId}/VM

Path parameters

providerId*integer (int32)

Provider ID

Response

200401404

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

namenullable string

Name of the VM

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

usernullable string

VM User

servernullable string

FQDN or IP address of the RAS Server

stateVMState (enum)

VM State

0 = Unknown,1 = On,2 = Off,3 = Paused,9 = CloningFailed,17 = CloningCanceled

nativePoolIdnullable string

ID of Native Pool

isHostboolean

Whether the VM is host or not

isTemplateboolean

Whether the VM is template or not

ipnullable string

IP of the VM

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "name": "text",
    "id": "text",
    "user": "text",
    "server": "text",
    "state": [
      "0 = Unknown",
      "1 = On",
      "2 = Off",
      "3 = Paused",
      "9 = CloningFailed",
      "17 = CloningCanceled"
    ],
    "nativePoolId": "text",
    "isHost": false,
    "isTemplate": false,
    "ip": "text"
  }
]

Get

Retrieve a specific VM by ID from a specific Provider by ID.

GET/api/Provider/{providerId}/VM/{id}

Path parameters

providerId*integer (int32)

Provider ID

id*string

VM ID

Response

200401404

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

namenullable string

Name of the VM

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

usernullable string

VM User

servernullable string

FQDN or IP address of the RAS Server

stateVMState (enum)

VM State

0 = Unknown,1 = On,2 = Off,3 = Paused,9 = CloningFailed,17 = CloningCanceled

nativePoolIdnullable string

ID of Native Pool

isHostboolean

Whether the VM is host or not

isTemplateboolean

Whether the VM is template or not

ipnullable string

IP of the VM

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "name": "text",
  "id": "text",
  "user": "text",
  "server": "text",
  "state": [
    "0 = Unknown",
    "1 = On",
    "2 = Off",
    "3 = Paused",
    "9 = CloningFailed",
    "17 = CloningCanceled"
  ],
  "nativePoolId": "text",
  "isHost": false,
  "isTemplate": false,
  "ip": "text"
}