1 of 3

Licensing

Activate

Deactivate

Licensing

Get

Retrieve the current license setting.

GET/api/License

Query parameters

UseCacheboolean

Specifies whether to retrieve the number of current licensed users from cache or calculate it on demand.

Response

Success

Body

licenseTypenullable string

License Type (Permanent, PrePaid, PostPaid, ExtTrial, LegacyTrial, or NormalTrial)

expiryDatenullable string

Expiry date of License

installedUsersnullable string

Maximum number of licensed users

usersPeaknullable string

Maximum amount of connected users since the product was installed (calculated together with the Usage Today).

usersLicenseInfonullable string

Amount of users currently connected

gracePeriodStatenullable string

State of Grace period

gracePeriodDaysLeftnullable string

Days left for Grace period

typeLicenseType (enum)

License Type

1 = Permanent,2 = PrePaid,3 = PostPaid,4 = ExtTrial,5 = LegacyTrial,6 = NormalTrial

needsAttentionboolean

RAS licensing requires attention.

statusMessagenullable string

The current status message of the RAS License.

alertMessagenullable string

The alert message a RAS Administrator should be notificed about.

Request

Response

Deactivate

Deactivate the current license key used by Parallels RAS.

POST/api/License/deactivate

Body

License settings

email*nullable string

The email address you use to log in to Parallels My Account.

password*nullable string

Your Parallels account password.

Response

No Content

Request

Response

Activate

Activate Parallels RAS using a valid license key. Also allows to activate Parallels RAS as a trial version. Trial version will be activated if the key is empty.

POST/api/License/activate

Body

License settings.

email*nullable string

The email address you use to log in to Parallels My Account.

password*nullable string

Your Parallels account password.

keynullable string

Parallels RAS License Key. The key must be registered in Parallels My Account. To activate Parallels RAS as a trial version, omit this parameter.

macAddressnullable string

Bind the license activation with a specific MAC address. The MAC address should be in the format XX-XX-XX-XX-XX-XX. To select a MAC address automatically, omit this parameter.

Response

No Content

Request

Response

Deactivate

Deactivate the current license key used by Parallels RAS.

POST/api/License/deactivate

Body

License settings

email*nullable string

The email address you use to log in to Parallels My Account.

password*nullable string

Your Parallels account password.

Response

No Content

Request

Response

Activate

Activate Parallels RAS using a valid license key. Also allows to activate Parallels RAS as a trial version. Trial version will be activated if the key is empty.

POST/api/License/activate

Body

License settings.

email*nullable string

The email address you use to log in to Parallels My Account.

password*nullable string

Your Parallels account password.

keynullable string

Parallels RAS License Key. The key must be registered in Parallels My Account. To activate Parallels RAS as a trial version, omit this parameter.

macAddressnullable string

Bind the license activation with a specific MAC address. The MAC address should be in the format XX-XX-XX-XX-XX-XX. To select a MAC address automatically, omit this parameter.

Response

No Content

Request

Response

Get

Retrieve the current license setting.

GET/api/License

Query parameters

UseCacheboolean

Specifies whether to retrieve the number of current licensed users from cache or calculate it on demand.

Response

Success

Body

licenseTypenullable string

License Type (Permanent, PrePaid, PostPaid, ExtTrial, LegacyTrial, or NormalTrial)

expiryDatenullable string

Expiry date of License

installedUsersnullable string

Maximum number of licensed users

usersPeaknullable string

Maximum amount of connected users since the product was installed (calculated together with the Usage Today).

usersLicenseInfonullable string

Amount of users currently connected

gracePeriodStatenullable string

State of Grace period

gracePeriodDaysLeftnullable string

Days left for Grace period

typeLicenseType (enum)

License Type

1 = Permanent,2 = PrePaid,3 = PostPaid,4 = ExtTrial,5 = LegacyTrial,6 = NormalTrial

needsAttentionboolean

RAS licensing requires attention.

statusMessagenullable string

The current status message of the RAS License.

alertMessagenullable string

The alert message a RAS Administrator should be notificed about.

Request

Response

const response = await fetch('/api/License/deactivate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "email": "text",
      "password": "text"
    }),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/License/activate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "email": "text",
      "password": "text"
    }),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

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

{
  "licenseType": "text",
  "expiryDate": "text",
  "installedUsers": "text",
  "usersPeak": "text",
  "usersLicenseInfo": "text",
  "gracePeriodState": "text",
  "gracePeriodDaysLeft": "text",
  "type": [
    "1 = Permanent",
    "2 = PrePaid",
    "3 = PostPaid",
    "4 = ExtTrial",
    "5 = LegacyTrial",
    "6 = NormalTrial"
  ],
  "needsAttention": false,
  "statusMessage": "text",
  "alertMessage": "text"
}