Get License Information

Retrieve licensing information

Request

URI

GET

https://{api_host}/v1/licensing-info

COPY

Query Parameters

string

resourceType

Optional

Resource type

resourceType example

SYSTEM,DOMAIN

string of array

resourceIds

Optional

Resource IDs

Responses

200

Successful

[
    {
        "resourceType": "One among: SYSTEM, DOMAIN, CLUSTER, NSXT_CLUSTER",
        "resourceId": "string",
        "licensingMode": "One among: SUBSCRIPTION, PERPETUAL, MIXED",
        "subscriptionStatus": "One among: UNSUBSCRIBED, ACTIVE, EXPIRED",
        "subscribedState": "One among: UNSUBSCRIBED, PARTIALLY_SUBSCRIBED, SUBSCRIBED",
        "isRegistered": false,
        "isSubscribed": false,
        "daysRemainingToSubscribe": 0,
        "entitlements": {
            "hasNsxEntitlement": false
        }
    }
]

400

Bad Request

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of ErrorCause

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

500

Internal server error

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.