Returns a collection of CDP replicas created by backup servers connected to Veeam Backup Enterprise Manager. For details, see /cdpReplicas.
To get a collection of replicas, send the GET HTTP request to the query with the type parameter set to CdpReplica.
The request contains the following headers:
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.
Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format.
In the query, you can use the following parameters for filtering and sorting.
UID of the CDP replica, for example: urn:veeam:Replica:urn:veeam:CdpReplica:24ae37ad-4d28-4568-8467-98d8770bb722.
Name of the CDP replica, for example: CDP Policy 1.
ID of the CDP policy parent to the replica, for example:145f3365-6ec0-44e9-9538-8c8c34ebdcce.
Name of the CDP policy parent to the replica, for example: CDP Policy 1.
UID of the backup server parent to the CDP replica resource.
Name of the backup server parent to the CDP replica resource.
The server returns the following response to the client.
A successfully completed operation returns response code 200 OK.
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
The length of the response body.
The media type and syntax of the request body message. Possible values:
In the response body, the REST API returns a representation of the /cdpReplicas resource collection.
The example below returns an entity resource representation of a collection of CDP replicas created by the CDP policy with name CDP Policy.
GET https://localhost:9398/api/query?type=cdpReplica&format=Entities&filter=PolicyName=="CDP Policy"