GET Licenses | vRealize Log Insight API

GET Licenses

Retrieve the license state, including a list of licenses.

Request

URI

GET

https://{api_host}/api/v2/licenses

COPY

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Successfully retrieved the License information

Returns licenses.get.response of type(s) application/json

{
    "maxOsis": 0,
    "maxCpus": 0,
    "maxCores": 0,
    "hasCpu": true,
    "hasOsi": true,
    "hasCore": false,
    "averageOsiUsage": 8,
    "entitlementType": "LICENSE_KEY",
    "licenses": [
        {
            "id": "7768d5c7-0039-4f27-a600-8f021488eea9",
            "status": "Active",
            "error": "",
            "configuration": "10 Operating System Instances (OSIs)",
            "licenseKey": "0H00J-0DHDK-H8CAE-0P8U4-1R40H",
            "infinite": true,
            "count": 10,
            "typeEnum": "SUITE_HYBRID",
            "expirationDate": 0,
            "createdDate": 1706715105584
        }
    ],
    "entitlement": {
        "entitlementId": "550e8400-e29b-41d4-a716-446655440000",
        "vcId": "111e8400-e29b-22d4-a716-447755441200",
        "isVCEntitled": false,
        "updateDate": 1706714980307,
        "expirationDate": 1806416980308,
        "vcEntitlementType": "vc.vcf",
        "validUntil": 1714490980307,
        "isEvaluationPeriod": true
    }
}

401

Operation doesn't return any data structure

440

Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json

{
    "errorMessage": "The operation failed due to an internal error."
}

string

errorMessage

Required

A message describing the error.

string

errorCode

Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,

object

errorDetails

Optional

Dynamic error details, where the field name can vary depending on the request field and error code.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/licenses

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Licenses Operations

DELETE Licenses License Id