LicenseKey | Parallels REST API

Parallels REST API

Products Support Partners Documentation

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

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/Template/{id}/LicenseKey'

200

401

404

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

Success

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/Template/{id}/LicenseKey' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "key": "text",
    "keyLimit": 1
  }'

201

401

404

No Content

Created

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/Template/{id}/LicenseKey' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "key": "text"
  }'

204

401

404

No Content