LicenseKey

PreviousExitMaintenance NextOptimization

Was this helpful?

Get

Retrieve the list RAS Template license keys.

GET/api/RDS/Template/{id}/LicenseKey

Path parameters

id*integer (int32)

The ID of a RAS Template to obtain information from.

Response

Success

Body

licenseKeyTypeenum

License Key Type

0 = KMS,1 = MAK

keysnullable array of object

List of template license keys.

Request

const response = await fetch('/api/RDS/Template/{id}/LicenseKey', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Add

Modify properties of a RAS Template license key.

POST/api/RDS/Template/{id}/LicenseKey

Path parameters

id*integer (int32)

The ID of a RAS Template to modify.

Body

VDI Template License Key configuration

key*nullable string

The license key.

keyLimit*integer (int32)

The max limit for the license key.

Response

Created

Request

const response = await fetch('/api/RDS/Template/{id}/LicenseKey', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "key": "text",
      "keyLimit": 1
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete

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

DELETE/api/RDS/Template/{id}/LicenseKey

Path parameters

id*integer (int32)

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

Body

Template License Key configuration

key*nullable string

The license key to remove.

Response

No Content

Request

const response = await fetch('/api/RDS/Template/{id}/LicenseKey', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "key": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}