Validate License Key

Validate License Key

This request validates the license key of the provider appliance.

Request
URI
POST
https://{api_host}//license
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body

The license key.

LicenseKey of type(s) application/json
Required 
{
    "key": "AAAAA-BBBBB-CCCCC-DDDDD-EEEEE"
}
string
key
Optional

The license key.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LicenseInfo of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "expirationDate": 1675864569473,
    "isLicensed": true,
    "key": "AAAAA-BBBBB-CCCCC-DDDDD-EEEEE"
}
integer As int64 As int64
expirationDate
Optional

The expiration date of the license.

boolean
isLicensed
Optional

Whether the product is licensed.

string
key
Optional

The license key.


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
License Operations
POST
Validate License Key