Get Protected Site Details

Get Protected Site Details

Get details about an individual protected site.

Request
URI
GET
https://{api_host}/api/vcdr/v1alpha/cloud-file-systems/{cloud_file_system_id}/protected-sites/{id}
COPY
Path Parameters
string
cloud_file_system_id
Required

Unique identifier of an individual cloud file system. Use the cloud file system ID of the cloud file system for which you want to get a list of all protected sites.

string
id
Required

The unique identifier of the individual protected site for which you want to get details.


Authentication
This operation uses the following authentication methods.
Responses
200

OK. The request succeeded.

Returns ProtectedSiteDetails of type(s) application/json
{
    "id": "string",
    "name": "string",
    "type": "string"
}
string
id
Optional

The identifier of the protected site.

string
name
Optional

Name of the protected site.

string
type
Optional

The type of a protected site.

  • PROTECTED_SITE_TYPE_UNKNOWN: The type of the protected site is unknown.
  • PROTECTED_SITE_TYPE_ON_PREM: The protected site resides in a customer managed datacenter.
  • PROTECTED_SITE_TYPE_VMC: The protected site resides in a VMware Cloud (VMC) on AWS datacenter.

Possible values are : PROTECTED_SITE_TYPE_UNKNOWN, PROTECTED_SITE_TYPE_ON_PREM, PROTECTED_SITE_TYPE_VMC,

400

Bad request. The server could not understand the request.

Operation doesn't return any data structure

401

Unauthorized. The client has not authenticated.

Operation doesn't return any data structure

403

Forbidden. The client is not authorized.

Operation doesn't return any data structure

404

Not found. The server cannot find the specified resource.

Operation doesn't return any data structure

500

VMware Cloud DR-specific error.
An error unique to VMware Cloud DR was encountered while attempting to satisfy the request. See the returned object for details on the error.

Returns Error of type(s) application/json
"Error Object"
array of object
messages
Optional

A stack or error messages. The first element (top of the stack) is the broadest description of the failure.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcdr/v1alpha/cloud-file-systems/{cloud_file_system_id}/protected-sites/{id}