HomeGuidesAPI Reference
API Reference

Apply a new Orchestrator license key

Applies and validates a new license key to the Orchestrator. The encrypted key is decrypted to extract serial number, max appliances, and optional expiration date. For physical appliances, the key's serial number must match the server's MAC address. Virtual appliances accept any valid key and adopt its serial number. The action is logged to the system action log. License key format after decryption: SERIAL#MAX_APPLIANCES[#EXPIRATION_DATE].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

JSON object containing the encrypted license key to apply

Request body for setting a new license key

string
required

Encrypted license key string to apply. The key contains encoded serial number, max appliances, and optional expiration date.

Responses

401

Unauthorized - Valid authentication credentials required

403

Forbidden - User does not have READ_WRITE permission

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json