Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Retrieve Control Room license details API

  • Updated: 10/21/2020
    • Automation 360 v.x
    • Explore
    • RPA Workspace
    • API docs

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.

Procedure

  1. Use the GET method and endpoint URL: <your_control_room_url>/v2/license/details.
  2. Send the request.
    Response body: In a successful request, this endpoint returns the following data:
    • failSafeStatus: A numerical value that represents the Fail-Safe status of the Cloud Control Room. Values: 0 means the Control Room is connected, 1 means the Control Room is in Fail-Safe mode, and 2 means the Fail-Safe status has expired.

      If the Control Room was configured with a file license, the returned value is always 0.

      Control Room Fail-Safe status

    • controlRoomLicenseServerSyncStatus: A Boolean value that determines whether the license allocations in this Control Room are in sync with the license server.
    • licenseMode: Whether the Control Room license was configured from a file or though a connection with the license server.

      ../dashboards/cloud-administration-licenses.html#cloud-administration-licenses__entitlement-models

    In this first example response, the licenseMode confirms that the Control Room is on a file-based license, thus the failSafeStatus is 0 and no value is returned for the installedCrId.
    {
        "type": "PURCHASED",
        "installationDate": "2020-09-09T15:06:05.211Z",
        "expirationDate": "2021-06-30T18:29:59.999Z",
        "failSafeStatus": 0,
        "controlRoomLicenseServerSyncStatus": true,
        "installedCrId": "",
        "licenseMode": "FileLicense"
    }
    In the second example response, the licenseMode confirms that the Control Room in on a cloud-based license, the failSafeStatus has returned 1, which means that requests to other Control Room APIs will fail until the connection with the license server is reestablished, and the controlRoomLicenseServerSyncStatus has returned false.
    {
        "type": "PURCHASED",
        "installationDate": "2020-09-14T18:30:00Z",
        "expirationDate": "2021-04-27T18:30:00Z",
        "failSafeStatus": 1,
        "controlRoomLicenseServerSyncStatus": false,
        "installedCrId": "b96edac7-b7e3-57bf-b857-ad14ac754674",
        "licenseMode": "CloudLicense"
    }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.

Next steps

If the controlRoomLicenseServerSyncStatus parameter returns False, use the Sync endpoint to update the license allocations and expiration date from the license server.

Send Feedback