GET /cdpReplicaSessions/{ID}

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.

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

UID

UidType

UID 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.

PolicyType

String

Policy type. Possible value: CdpReplica.

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:

• Starting
• Stopping
• Working
• Pausing
• Resuming
• Stopped

Result

String

Result of the CDP replication session. Possible values:

• Success
• Warning
• Failed

Progress

Int

Progress of the CDP replication session (between 1 and 100).

FailureMessage

String

Reason for which the CDP replication session has been completed with the Failed result.

IsRetry

Bool

Defines whether the CDP replication session has been retried or not. Possible values:

• True
• False

/backupServers/{ID}

Up

URL of the /backupServers/{ID} resource — a backup server where the CDP policy was configured.

/cdpPolicies/{ID}

Up

URL of the /cdpPolicies/{ID} resource — a CDP policy that processes the replica.

/cdpReplicaSessions/{ID}

Alternate

Alternate URL of the /cdpReplicaSessions/{ID} resource.

/cdpReplicaSessions/{ID}/cdpReplicaTaskSessions

Down

URL of the /cdpReplicaSessions/{ID}/cdpReplicaTaskSessions resource — a collection of CDP replication task sessions of the CDP replication session.