API docs by Redocly

License Activation API (v5)

Download OpenAPI specification:

LicenseActivationManagerAPI

/

Authorizations:
ApiKey

Responses

Response samples

Content type
text/plain
An error occurred while renewing the license

LicenseGen

/gen/LicenseGen/generate/domainlic

Authorizations:
ApiKey
Request Body schema:
scriptname
string
domainname
string
domainkey
string

Responses

Request samples

Content type
{
  • "scriptname": "example_script_name",
  • "domainname": "example.com",
  • "domainkey": "XXXX-XXXX-XXXX-XXXX"
}

Response samples

Content type
{
  "fileName": "license.dat"
}

/gen/LicenseGen/check/license-status

Authorizations:
ApiKey
Request Body schema:
domainKey
string

Responses

Request samples

Content type
{
  • "domainKey": "XXXX-XXXX-XXXX-XXXX"
}

Response samples

Content type
{
  "valid": true,
  "message": "Permanent License detected. No expiration date set."
}

LicenseUpdate

/update/LicenseUpdate/RenewDomainLicense

Authorizations:
ApiKey
Request Body schema:
domainKey
string
newValidToDate
string <date-time>

Responses

Request samples

Content type
{
  • "domainKey": "XXXX-XXXX-XXXX-XXXX",
  • "newValidToDate": "2026-12-30T13:02:38.0677627Z"
}

Response samples

Content type
License renewed successfully

LicenseVal

/val/LicenseVal/validate/singleuser

Authorizations:
ApiKey
Request Body schema:
licenseFileContent
string <byte>
computerID
string
serialKey
string
activationcode
string
publickey
string
activationkey
boolean
licenseHashCode
string
useSiteCodeForLicensing
boolean
siteCode
string

Responses

Request samples

Content type
{
  • "licenseFileContent": "VGhpcyBpcyBhIGxpY2Vuc2UgZmlsZSBjb250ZW50",
  • "computerID": "COMPUTER-IDXX-12345",
  • "serialKey": "SERIAL123456XXXSERIAL123456XXX",
  • "activationcode": "ACTIVATIONCODE123456XXXACTIVATIONCODE123456XXX",
  • "publickey": "<RSAKeyValue><Modulus>.......</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>",
  • "activationkey": true,
  • "licenseHashCode": "/",
  • "useSiteCodeForLicensing": true,
  • "siteCode": "SITECODE123"
}

Response samples

Content type
{
  "valid": true
}

/val/LicenseVal/validate/network

Authorizations:
ApiKey
Request Body schema:
networkLicenseFile
string <byte>
serverpath
required
string
programid
string
numberoflicenses
integer <int32>
serialnumber
string
validfrom
string
validto
string
publickey
string

Responses

Request samples

Content type
{
  • "networkLicenseFile": "VGhpcyBpcyBhIG5ldHdvcmsgbGljZW5zZSBmaWxlIGNvbnRlbnQ=",
  • "serverpath": "C:/ProgramData/Server/Path",
  • "programid": "PROGRAM001",
  • "numberoflicenses": 5,
  • "serialnumber": "SERIAL12345",
  • "validfrom": "2023-01-01T00:00:00Z",
  • "validto": "2024-01-01T00:00:00Z",
  • "publickey": "<RSAKeyValue><Modulus>...</Modulus><Exponent>...</Exponent></RSAKeyValue>"
}

Response samples

Content type
{
  "valid": true
}

/val/LicenseVal/validate/domain

Authorizations:
ApiKey
Request Body schema:
scriptname
string
domainname
string
domainkey
string
webLicenseFile
string <byte>
publickey
string

Responses

Request samples

Content type
{
  • "scriptname": "ScriptName",
  • "domainname": "example.com",
  • "domainkey": "DOMAIN12345",
  • "webLicenseFile": "VGhpcyBpcyBhIGRvbWFpbiBsaWNlbnNlIGZpbGUgY29udGVudA==",
  • "publickey": "<RSAKeyValue><Modulus>...</Modulus><Exponent>...</Exponent></RSAKeyValue>"
}

Response samples

Content type
{
  "valid": true
}

PublicLicenseGen

/api/PublicLicenseGen/generate

Authorizations:
ApiKey
Request Body schema:
scriptName
string
domainName
string
domainKey
string

Responses

Request samples

Content type
{
  • "scriptname": "example_script_name",
  • "domainname": "example.com",
  • "domainkey": "XXXX-XXXX-XXXX-XXXX"
}

Response samples

Content type
{
  "status": "success",
  "licenseFileBase64": "MIIBCg==",
  "licenseFileName": "licensefilename.lic"
}

SecurityTokens

/sec/SecurityTokens/issue/token

Authorizations:
ApiKey
Request Body schema:
identifier
string

Responses

Request samples

Content type
{
  • "identifier": "exampleIdentifier123"
}

Response samples

Content type
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

/sec/SecurityTokens/validate/token

Authorizations:
ApiKey
Request Body schema:
token
string
identifier
string

Responses

Request samples

Content type
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "identifier": "exampleIdentifier123"
}

Response samples

Content type
{
  "valid": true,
  "apiKey": "exampleApiKey123"
}

TokenLicensing

/lic/TokenLicensing/issue/token

Authorizations:
ApiKey
Request Body schema:
uniqueIdentifier
string
tokenSettingId
integer <int32>

Responses

Request samples

Content type
{
  • "uniqueIdentifier": "exampleUniqueIdentifier123",
  • "tokenSettingId": 1
}

Response samples

Content type
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

/lic/TokenLicensing/validate/token

Authorizations:
ApiKey
Request Body schema:
token
string
tokenSettingId
integer <int32>

Responses

Request samples

Content type
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "tokenSettingId": 1
}

Response samples

Content type
{
  "valid": true,
  "tokenInfo": {
    "uniqueIdentifier": "exampleUniqueIdentifier123",
    "issueDate": "2023-01-01T00:00:00Z",
    "expiryDate": "2024-01-01T00:00:00Z",
    "issuer": "exampleIssuer123",
    "audience": "exampleAudience123"
  }
}

/lic/TokenLicensing/generate/token-license

Authorizations:
ApiKey
Request Body schema:
tokenSerial
required
string
programID
required
string
uniqueIdentifier
string or null
boundToComputer
boolean

Responses

Request samples

Content type
{
  • "tokenSerial": "TOK123456789012345030",
  • "programID": "12345",
  • "uniqueIdentifier": "DEVICE12345",
  • "boundToComputer": true
}

Response samples

Content type
{
  "token": "EXAMPLE_TOKEN_123",
  "expiryDate": "2026-01-29T13:02:38.0836804Z"
}

/lic/TokenLicensing/generate/token-license-extended

Authorizations:
ApiKey
Request Body schema:
tokenSerial
required
string
programID
required
string
uniqueIdentifier
string or null
boundToComputer
boolean
name
string or null
email
string or null

Responses

Request samples

Content type
{
  • "name": "John Doe",
  • "email": "john@example.com",
  • "tokenSerial": "TOK123456789012345030",
  • "programID": "12345",
  • "uniqueIdentifier": "DEVICE12345",
  • "boundToComputer": true
}

Response samples

Content type
{
  "token": "EXAMPLE_TOKEN_123",
  "expiryDate": "2026-01-29T13:02:38.0853956Z"
}

/lic/TokenLicensing/token-license/maintenance-plan

Authorizations:
ApiKey
Request Body schema:
generatedToken
string

Responses

Request samples

Content type
{
  • "generatedToken": "BASE64TOKEN|SIGNATURE"
}

Response samples

Content type
{
  "maintenancePlanSupported": false,
  "hasMaintenancePlan": null
}

/lic/TokenLicensing/validate/token-license

Authorizations:
ApiKey
Request Body schema:
tokenLicense
required
string
programID
required
string
uniqueIdentifier
string or null

Responses

Request samples

Content type
{
  • "tokenLicense": "ABC123XYZ",
  • "programID": "12345",
  • "uniqueIdentifier": "DEVICE12345"
}

Response samples

Content type
{
  "Message": "Token license is valid.",
  "TokenSerial": "TOK1234567890",
  "ExpiryDate": "2026-01-29T13:02:38.0877918Z"
}

/lic/TokenLicensing/remove/token-license

Authorizations:
ApiKey
Request Body schema:
generatedToken
required
string

Responses

Request samples

Content type
{
  • "generatedToken": "ABC123XYZ"
}

Response samples

Content type
{
  "message": "Token license successfully removed."
}