REST API - get

vcenter vcha license: get

Gets the license of the active node of a VCHA cluster. This operation was added in vSphere API 7.0.0.1.

Request:

HTTP request

GET https://{server}/rest/vcenter/vcha/license
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "is_available"true
    }
}

Response Type:

Name Type Description
bold = required
value info Info structure containing the VCHA license.
value.is_available boolean Does the vCenter have the appropriate license for VCHA. This attribute was added in vSphere API 7.0.0.1.

Errors:

HTTP Status Code Type Description
403 unauthorized If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
500 error If any other error occurs.