Snapservice. Sites Delete$ Task

Delete the specified remote site. Deleting a site which is not added via SnapService is not supported.

The logged in interactive user must be a member of Administrators group on local site to execute the operation. If the remote site is not failed, the remote user must be a member of Administrators group on remote site too.

This operation was added in vSphere API 9.0.0.0.

Request

URI

DELETE

https://{host}/api/snapservice/sites/{site}?vmw-task=true

COPY

Path Parameters

string

site

Required

Site identifier.

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

Query Parameters

Snapservice.Sites.DeleteOptions

options

Optional

Additional options to for deleting the site.

If missing or null, additional options Snapservice.Sites.DeleteOptions for deleting site pair are skipped and default behavior for delete site is applied.

Request Body

Specification used for breaking site pair.

Snapservice.Sites.DeleteSpec of type(s) application/json

Required

"Snapservice.Sites.DeleteSpec Object"

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

202

Success!

Returns string of type(s) application/json

Operation doesn't return any data structure

400

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

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

Vapi.Std.Errors.NotAllowedInCurrentState If caller tries to delete site with active replications or a site which is not added via SnapService.

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"

404

If the site is not found.

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 -X DELETE -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/snapservice/sites/{site}?vmw-task=true

On This Page

Description

Request

Path Parameters

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Snapservice.sites Operations

POST