Get Protected Sites | VMware Live Cyber Recovery API

Get Protected Sites

Get a list of all protected sites associated with an individual cloud file system.

Request

URI

GET

https://{orchestrator_fqdn}/api/vcdr/v1alpha/cloud-file-systems/{cloud_file_system_id}/protected-sites

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.

Query Parameters

integer

limit

Optional

The maximum number of results to return with the call. The maximum is 500, and the default is 50 results.

Note: The pre-release version of this API differs from this documentation. This parameter is ignored.

ProtectedSitesFilterSpec

filter_spec

Optional

Used to filter the results.

Note: The pre-release version of this API differs from this documentation. This parameter is ignored. All protected sites are returned.

string

cursor

Optional

An opaque string previously returned by this API that can be passed to this API in order to get the next set of results. If this property is not passed, enumeration of starts from the beginning.

Note: The pre-release version of this API differs from this documentation. This parameter is ignored. All protected sites are returned when making this API call.

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

OK. The request succeeded.

Returns GetProtectedSitesResponse of type(s) application/json

{
    "cursor": "string",
    "protected_sites": [
        {
            "id": "string",
            "name": "string"
        }
    ]
}

string

cursor

Optional

An opaque string that can be passed back to this API in order to get the next set of results. If this poperty is not present, no more results are available.

array of ProtectedSiteSummary

protected_sites

Optional

An array of summary information concerning protected sites.

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 Live Cyber Recovery-specific error.
An error unique to VMware Live Cyber Recovery was encountered while attempting to satisfy the request. See the returned object for details on the error.

Returns Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ]
        }
    ]
}

array of LocalizableMessage

messages

Optional

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

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body