Snapservice. Sites List

Snapservice. Sites List

List the local and remote sites.

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
COPY
Query Parameters
Snapservice.Sites.FilterSpec
filter
Optional

Specification of matching sites for which information should be returned.

If missing or null, the behavior is equivalent to a Snapservice.Sites.FilterSpec with all properties missing or null which means all sites match the filter.

string of array
sites
Optional

Identifiers of sites that can match the filter.

This property was added in vSphere API 9.0.0.0.

If missing or null or empty, sites with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.site. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.site.

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the sites matching the Snapservice.Sites.FilterSpec.

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

400

Vapi.Std.Errors.InvalidArgument If validation of the filter fails.

Vapi.Std.Errors.Unsupported If the API is not supported.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error 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"

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
On This Page
Snapservice.sites Operations
POST
Snapservice. Sites Probe
GET
Snapservice. Sites List
GET
Snapservice. Sites Get
POST
Snapservice. Sites Add$ Task
DELETE
Snapservice. Sites Delete$ Task
PATCH
Snapservice. Sites Update$ Task