License API

The License API contains endpoints to retrieve Control Room license details (such as expiration date and license mode) and manually sync the Control Room with the license server after license reallocation or renewal.

Nota: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

Manage licenses

Authenticate the user.
Use the POST method to generate an authentication JSON Web Token.
Retrieve Control Room license details API.
Retrieve details of the Control Room license, including license type, expiration date, Fail-Safe status, and license server sync status.
If the controlRoomLicenseServerSyncStatus parameter returns False, use the Sync endpoint to update the license allocations and expiration date from the license server.

List the license allocations

Authenticate the user.
Use the POST method to generate an authentication JSON Web Token.
If the license is cloud-based: If new licenses were purchased, or if licenses were reallocated between Control Room instances, use the Sync endpoint to update the license allocations and expiration date from the license server.
List details of the Control Room licenses
Retrieve Control Room metadata including the license type, number of available licenses, number of licenses used in a specific Control Room instance, and number of licenses used in all Control Room instances.