Get Domain Licensing Info
Get the Licensing information of a domain
Request
URI
GET
https://{api_host}/v1/licensing-info/domains/{id}
COPY
Path Parameters
string
id
Required
The domain ID
Responses
200
Successful
Returns Array of LicensingInfo of type(s) application/json
[
{
"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
}
}
]
500
Internal server error
Returns Error of type(s) application/json
"Error Object"
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 object
causes
Optional
The underlying cause exceptions.
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.
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/licensing-info/domains/{id}
License Keys Operations
PUT
Set License Key For Resource
POST
Start License Check By Resource
GET
Get License Keys
POST
Add License Key
PATCH
Update License Key
GET
Get License Check Result By ID
GET
Get License Information
GET
Get System Licensing Info
GET
Get Domain Licensing Info
GET
Get License Key
DELETE
Remove License Key
GET
Get License Product Types