(GET) /cdpReplicas/{ID}

Returns a resource representation of a CDP replica having the specified ID. The CDP replica is created by the backup server connected to Veeam Backup Enterprise Manager.

Request

To get a CDP replica, you need to send the GET HTTP request to the URL of the /cdpReplicas/{ID} resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/cdpReplicas/{ID}

Request Headers

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can send this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Query Parameters

The following parameters can be used in queries.

Parameter

Type

Description

Can Be Used for Filtering

Can Be Used for Sorting

Uid

URN

ID of the CDP replica, for example: urn:veeam:Replica:urn:veeam:CdpReplica:24ae37ad-4d28-4568-8467-98d8770bb722.

True

True

Name

String

Name of the CDP replica, for example: CDP Policy 1.

True

True

PolicyId

URN

ID of the CDP policy parent to the replica, for example:145f3365-6ec0-44e9-9538-8c8c34ebdcce.

True

True

PolicyName

String

Name of the CDP policy parent to the replica, for example: CDP Policy 1.

True

True

BackupServerUid

URN

ID of the backup server parent to the CDP replica resource.

True

True

BackupServerName

String

Name of the backup server parent to the CDP replica resource.

True

True

RepositoryId

URN

ID of the backup repository where CDP replica metadata is stored.

True

True

RepositoryName

String

Name of the backup repository where CDP replica metadata is stored.

True

True

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /cdpReplicas/{ID} resource.

Example

A sample request below returns a replica having ID 24ae37ad-4d28-4568-8467-98d8770bb722.

Request:

GET https://localhost:9398/api/cdpReplicas/24ae37ad-4d28-4568-8467-98d8770bb722

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="CdpReplicaReference" Href="https://localhost:9398/api/cdpReplicas/24ae37ad-4d28-4568-8467-98d8770bb722" Name="CDP Policy 1" UID="urn:veeam:CdpReplica:24ae37ad-4d28-4568-8467-98d8770bb722">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/cca0b96b-4924-4461-8899-b831bc00176e" Name="enterprise03.tech.local" />
   <Link Rel="Alternate" Type="CdpReplica" Href="https://localhost:9398/api/cdpReplicas/24ae37ad-4d28-4568-8467-98d8770bb722?format=Entity" Name="CDP Policy 1" />
 </Links>
</EntityRef>

 

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.