Read and Review Automation Anywhere Documentation

Automation Anywhere Version 11.3

Close Contents

Contents

Open Contents

License API

  • Updated: 5/07/2020
    • 11.3.x
    • Explore
    • Enterprise
    • API docs

License API

Request detailed license information for your Control Room installed licenses.

Prerequisites

JSON Web Token (JWT)
All Control Room APIs require a JSON Web Token (JWT) to access the APIs. Generate an authentication token using the Authentication API. Apply the token to each API you are going to execute.
Roles and licenses
You need to authenticate with a user that has the following permissions:
View licenses
Manage user's device licenses
Install licenses
Note: Administrator users have these permissions by default. Create a custom role to assign to non-administrator users to allow them to be able to view license information.
  • URL: http://<your_control_room_url>/v2/license
  • Method: GET

Procedure

  1. Add an authentication token to the request header.
    Note: Use the Authentication API to generate a JSON Web Token (JWT). Authenticate with a user that has the required roles and licenses.
    In Swagger:
    1. Click Authorize and add the JWT to the Value field.
    2. Click Authorize then click Close

    In a REST client: Create a custom header named X-Authorization with the JWT as the Attribute Value.

  2. Go to the License API URL. .../v2/license
    In Swagger:
    1. Click Try it out.
    2. Click Execute.
    In a REST client:
    1. Enter the License API URL in the URL field.
      http://<your_control_room_url>/v2/license
    2. Select the GET method.
    3. Click SEND.
    Response body:
    {
      "licenseType": "PURCHASED",
      "installedBy": 1,
      "installationDate": "2019-11-12T07:18:17.247Z",
      "expirationDate": "2020-05-10T23:59:59.999999999Z",
      "products": [
        {
          "id": 1,
          "name": "CONTROLROOM",
          "version": "11.3.4.0",
          "features": [
            {
              "id": 2,
              "name": "UNATTENDED_BOTRUNNER",
              "enable": true,
              "purchasedCount": 5,
              "usedCount": 1,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "FLOATING"
            },
            {
              "id": 1,
              "name": "BOT_CREATOR",
              "enable": true,
              "purchasedCount": 10,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "FLOATING"
            },
            {
              "id": 7,
              "name": "ATTENDED_BOTRUNNER",
              "enable": true,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "FLOATING"
            }
          ]
        },
        {
          "id": 2,
          "name": "ANALYTICS",
          "version": "11.3.4.0",
          "features": [
            {
              "id": 5,
              "name": "ANALYTICS_API",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "NONE"
            },
            {
              "id": 4,
              "name": "ANALYTICS_CLIENT",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "NONE"
            }
          ]
        },
        {
          "id": 4,
          "name": "COGNITIVE",
          "version": "",
          "features": [
            {
              "id": 3,
              "name": "IQBOT_RUNNER",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "NONE"
            },
            {
              "id": 8,
              "name": "IQBOT_PAGES",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "NUMBER",
              "licenseModel": "NONE"
            }
          ]
        },
        {
          "id": 3,
          "name": "BOTFARM",
          "version": "",
          "features": [
            {
              "id": 6,
              "name": "BOTFARM_RUNNER",
              "enable": false,
              "purchasedCount": 0,
              "usedCount": 0,
              "licenseCountUnit": "SECONDS",
              "licenseModel": "HOURLY"
            }
          ]
        }
      ]
    }
    Response header:
     cache-control: no-cache, no-store, max-age=0, must-revalidate 
     content-length: 1474 
     content-security-policy: default-src 'self' 
     content-type: application/json 
     date: Wed, 13 Nov 2019 10:33:56 GMT 
     expires: 0 
     pragma: no-cache 
     x-content-type-options: nosniff 
     x-frame-options: SAMEORIGIN 
     x-xss-protection: 1; mode=block 

Next steps

You can also use c URL in a command or terminal window to make this API request.
curl -X GET "http://<your_control_room_url>/v2/license" -H "accept: application/json" -H "X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxOCIsImNsaWVudFR5cGUiOiJXRUIiLCJsaWNlbnNlcyI6WyJERVZFTE9QTUVOVCJdLCJhbmFseXRpY3NMaWNlbnNlc1B1cmNoYXNlZCI6eyJBbmFseXRpY3NDbGllbnQiOnRydWUsIkFuYWx5dGljc0FQSSI6dHJ1ZX0sImlhdCI6MTU3MzY0MTIxOCwiZXhwIjoxNTczNjQyNDE4LCJpc3MiOiJBdXRvbWF0aW9uQW55d2hlcmUiLCJuYW5vVGltZSI6NDE5MDkwNzU3ODk4MjIwMCwiY3NyZlRva2VuIjoiN2YxNDJiODQ3OGRhY2MzYzUzNjFiNzQwNTljOTFjMmYifQ.b5FECqRdLb4tOWrScYSGwydJ2kHdx4XX_9LYQjKX-taOynEE0P1KozHrYEsqERMQFKNTdUWnkKzHfXHWJ63IVzsSamSRLxWTWF0LiVkrrrdSA5mOtBJd3AdVC2Zxk828T2DGKX7O4U-kzSos-LM9Hcx6gug86BWPubjuHbH5RZKUgXVYujcHIpw_2sPfQFHjHdvZWb2HwuTeTm_xxiTRS4LFOwoGh3lZdmOZ8ckmGQCkB-bX28a4dfyLCPBAB9XDYGKJ70IeQRgx4mhYVJ2g228iSe8GPWYcg2RiwedawP_vxy6VLY6EDqUB7nbt5GuWf6W174S_AQei4LVYRQvsPQ"
Send Feedback