VM | Parallels REST API

Parallels REST API

SupportDocumentation

List

get

Retrieve a list of VM information.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve VM information (optional)

Responses

application/json; api-version=1.0

object[]Optional

Virtual Machine

application/json; api-version=1.0

get

GET /api/Provider/VM HTTP/1.1
Host: 
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

application/json; api-version=1.0

object[]Optional

Virtual Machine

application/json; api-version=1.0

get

GET /api/Provider/{providerId}/VM HTTP/1.1
Host: 
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

application/json; api-version=1.0

objectOptional

Virtual Machine

application/json; api-version=1.0

get

GET /api/Provider/{providerId}/VM/{id} HTTP/1.1
Host: 
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"
}