Snapservice. Sites. Licenses List

Snapservice. Sites. Licenses List

List the licenses for the specified site. VMware live recovery licenses are always associated with the peer site. The result for local site will not include the VMware live recovery license information.

VSAN replication features are not supported when the peer site does not have any VMware live recovery licenses available.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.
Request
URI
GET
https://{host}/api/snapservice/sites/{site}/licenses
COPY
Path Parameters
string
site
Required

Identifier of the site.

The parameter must be an identifier for the resource type: com.vmware.snapservice.site.


Authentication
This operation uses the following authentication methods.
Responses
200

Information about the licenses for the specified site.

Returns Snapservice.Sites.Licenses.ListResult of type(s) application/json
"Snapservice.Sites.Licenses.ListResult Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json
"Vapi.Std.Errors.Unauthenticated Object"

403

If the caller is not authorized to perform the operation.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json
"Vapi.Std.Errors.Unauthorized Object"

404

If there is no site associated with site in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json
"Vapi.Std.Errors.NotFound Object"

500

If there is unknown internal error.

Returns Vapi.Std.Errors.Error of type(s) application/json
"Vapi.Std.Errors.Error Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/snapservice/sites/{site}/licenses