VM

List

get

Retrieve a list of VM information.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve VM information (optional)

Responses

200

Success

application/json; api-version=1.0

Virtual Machine

siteIdinteger · int32Optional

Site ID

namestring · nullableOptional

Name of the VM

idstring · nullableOptional

ID of the VM

providerIdinteger · int32Optional

Provider ID

userstring · nullableOptional

VM User

serverstring · nullableOptional

FQDN or IP address of the RAS Server

statestring · enumOptional

VM State

Possible values:

nativePoolIdstring · nullableOptional

ID of Native Pool

isHostbooleanOptional

Whether the VM is host or not

isTemplatebooleanOptional

Whether the VM is template or not

ipstring · nullableOptional

IP of the VM

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Provider/VM

HTTPcURLJavaScriptPython

GET /api/Provider/VM HTTP/1.1
Accept: */*

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

List Provider VMs

get

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

Path parameters

providerIdinteger · int32Required

Provider ID

Responses

200

Success

application/json; api-version=1.0

Virtual Machine

siteIdinteger · int32Optional

Site ID

namestring · nullableOptional

Name of the VM

idstring · nullableOptional

ID of the VM

providerIdinteger · int32Optional

Provider ID

userstring · nullableOptional

VM User

serverstring · nullableOptional

FQDN or IP address of the RAS Server

statestring · enumOptional

VM State

Possible values:

nativePoolIdstring · nullableOptional

ID of Native Pool

isHostbooleanOptional

Whether the VM is host or not

isTemplatebooleanOptional

Whether the VM is template or not

ipstring · nullableOptional

IP of the VM

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Provider/{providerId}/VM

HTTPcURLJavaScriptPython

GET /api/Provider/{providerId}/VM HTTP/1.1
Accept: */*

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

Get

get

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

Path parameters

providerIdinteger · int32Required

Provider ID

idstringRequired

VM ID

Responses

200

Success

application/json; api-version=1.0

Virtual Machine

siteIdinteger · int32Optional

Site ID

namestring · nullableOptional

Name of the VM

idstring · nullableOptional

ID of the VM

providerIdinteger · int32Optional

Provider ID

userstring · nullableOptional

VM User

serverstring · nullableOptional

FQDN or IP address of the RAS Server

statestring · enumOptional

VM State

Possible values:

nativePoolIdstring · nullableOptional

ID of Native Pool

isHostbooleanOptional

Whether the VM is host or not

isTemplatebooleanOptional

Whether the VM is template or not

ipstring · nullableOptional

IP of the VM

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

HTTPcURLJavaScriptPython

GET /api/Provider/{providerId}/VM/{id} HTTP/1.1
Accept: */*

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