How to use the REST API to obtain the license of Aria Operations
search cancel

How to use the REST API to obtain the license of Aria Operations

book

Article ID: 447072

calendar_today

Updated On:

Products

VCF Operations/Automation (formerly VMware Aria Suite)

Issue/Introduction

This article explains how to obtain the licenses applied to VMware Aria Operations using the REST API.

Environment

VMware Aria Operations 8.18.x

Resolution

Follow these steps to use curl commands to obtain the license.

  1. Run the following POST request command to acquire the API access token:
    curl -ks -X POST "https://<Ops-FQDN>/suite-api/api/auth/token/acquire" \
          -H "Accept: application/json" \
          -H "Content-Type: application/json" \
          -d '{"username": "admin", "password": "<PASSWORD>", "authSource": "local"}'

    Example output (The value for "token" is access token):

    {
      "token": "########-####-####-####-######################-####-####-####-############",
      "validity": 1783432729249,
      "expiresAt": "Tuesday, July 7, 2026 at 1:58:49 PM Coordinated Universal Time",
      "roles": []
    }


  2. Run the following GET request command against the license endpoint, passing the token in the header:
    curl -ks -X GET "https://<Ops-FQDN>/suite-api/api/deployment/licenses" \
           -H "Accept: application/json" \
           -H "Authorization: vRealizeOpsToken <ACCESS TOKEN>"

    Example output using the Step1's token (formatted with jq):

    $ curl -ks -X GET "https://<Ops-FQDN>/suite-api/api/deployment/licenses" -H "Accept: application/json" -H "Authorization: vRealizeOpsToken ########-####-####-####-######################-####-####-####-############"  | jq
    {
      "solutionLicenses": [
        {
          "id": "0ea44f9a-3635-4883-bc48-1471bab89dfb",
          "productName": "vRealize Operations Manager Evaluation",
          "licenseKey": "Evaluation - VMware vRealize Operations Management Suite",
          "expirationDate": 1786067940532,
          "capacity": "unlimited Virtual Machines",
          "edition": "ENTERPRISE",
          "licenseType": "EVALUATION",
          "statuses": [
            "30 days to expiry",
            "License expires on 8/7/26, 1:59 AM UTC",
            "Only powered on VMs will count towards the license usage"
          ]
        }
      ]
    }