GET /query?type=CdpReplicaSession
Returns a collection of CDP replication sessions performed on backup servers connected to Veeam Backup Enterprise Manager. For details, see /cdpReplicaSessions.
Request
To get a collection of all CDP replication sessions, send the GET HTTP request to the query with the type parameter set to CdpReplicaSession.
HTTP Request
|
GET https://<Enterprise-Manager>:9398/api/query?type=CdpReplicaSession |
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:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
|
Parameter |
Type |
Description |
|---|---|---|
|
Id |
UidType |
ID of the CDP replication session, for example: urn:veeam:CdpReplicaSession:6b872a71-51e8-437a-8d45-5c6494b92f3f. |
|
Name |
String |
Name of the CDP replication session, for example: CDP Policy 1@2025-02-11 19:08:36. |
|
PolicyUid |
UidType |
UID of the CDP policy parent to the session, for example: urn:veeam:CdpPolicy:145f3365-6ec0-44e9-9538-8c8c34ebdcce. |
|
PolicyName |
String |
Name of the CDP policy parent to the session, for example: CDP Policy 1. |
|
BackupServerUid |
UidType |
UID of the backup server parent to the CDP replication session. |
|
BackupServerName |
String |
Name of the backup server parent to the CDP replication session. |
|
CreationTimeUTC |
DateTime |
Date and time when the session was started. The parameter accepts only UTC-formatted DateTime values, for example: 2025-08-14T12:31:30.389954Z. |
|
EndTimeUTC |
DateTime |
Date and time when the session was ended. The parameter accepts only UTC-formatted DateTime values, for example: 2025-08-14T12:31:31.000000Z. |
|
State |
String |
State of the CDP replication session. Possible values:
|
|
Result |
String |
Result of the CDP replication session. Possible values:
|
|
FailureMessage |
String |
Reason for which the CDP replication session has been completed with the Failed result. |
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:
|
Response Body
In the response body, the REST API returns a representation of the /cdpReplicaSessions resource collection.
Example
The example below returns an entity resource representation of a collection of CDP replication sessions that were created on June 15, 2025 or later.
|
Request: GET https://localhost:9398/api/query?type=CdpReplicaSession&format=Entities&filter=CreationTimeUTC>="2025-06-15" Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |