Snapservice. Sites Probe

Probe SSL connection to a remote vCenter and Data Protection Virtual Appliance. This API returns vCenter/Data Protection Virtual Appliance certificates.

If vCenter certificate is already not trusted, the API will return vCenter certificate with probe status as partial. User is expected to invoke probe API again with the user accepted vCenter certificate. Once the vCenter certificate accepted by the user is supplied to probe API, the API will return with probe status as completed along with Data Protection Virtual Appliance certificate. If Data Protection Virtual Appliance certificate is not trusted, user is expected to accept Data Protection appliance certificate and supply user accepted vCenter and Data Protection Virtual Appliance certificates as input to Add/Update site API.

If vCenter and Data Protection Virtual Appliance certificates are already trusted, the API will respond with probe status as completed. User can proceed with invoking Add/Update site API with no vCenter and Data Protection Virtual Appliance certificates.

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

POST

https://{host}/api/snapservice/sites?action=probe

COPY

Request Body

Spec used to probe remote vCenter and Data Protection Virtual Appliance connection.

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

Required

"Snapservice.Sites.ProbeSpec Object"

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Probe result containing remote vCenter and Data Protection Virtual Appliance certificates that can be used to call add or update site.

Returns Snapservice.Sites.ProbeResult of type(s) application/json

"Snapservice.Sites.ProbeResult Object"

400

Vapi.Std.Errors.InvalidArgument If validation of the spec 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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/snapservice/sites?action=probe

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Snapservice.sites Operations

POST

Snapservice. Sites Probe

GET