LicenseKey | Parallels REST API

Parallels REST API

SupportDocumentation

Get

get

Retrieve the list RAS Template license keys.

Path parameters

idinteger · int32Required

The ID of a RAS Template to obtain information from.

Responses

application/json; api-version=1.0

objectOptional

RAS Template License Keys Available to VDI/RDS Templates

application/json; api-version=1.0

get

GET /api/VDI/Template/{id}/LicenseKey HTTP/1.1
Host: 
Accept: */*

{
  "licenseKeyType": [
    "0 = KMS",
    "1 = MAK"
  ],
  "keys": [
    {
      "licenseKey": "text",
      "keyLimit": 1
    }
  ]
}

Add

post

Modify properties of a RAS Template license key.

Path parameters

idinteger · int32Required

The ID of a RAS Template to modify.

Body

Add a license key to the Template license keys list

keystring | nullableRequired

The license key.

keyLimitinteger · int32Required

The max limit for the license key.

Responses

application/json; api-version=1.0

post

POST /api/VDI/Template/{id}/LicenseKey HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 27

{
  "key": "text",
  "keyLimit": 1
}

No content

Delete

delete

Delete the specified license key info from the specified RAS Template configuration.

Path parameters

idinteger · int32Required

The ID of the RAS Template to remove license key from.

Body

Remove a license key from the Template license keys list

keystring | nullableRequired

The license key to remove.

Responses

application/json; api-version=1.0

delete

DELETE /api/VDI/Template/{id}/LicenseKey HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 14

{
  "key": "text"
}

No content