GET /cdpPolicies/{ID}
Returns a resource representation of the CDP policy resource having the specified ID.
Request
To get a resource representation of the CDP policy, send the GET HTTP request to the URL of the /cdpPolicies/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/cdpPolicies/{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:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
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 an entity or an entity reference of the /cdpPolicies/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the CDP policy, for example: urn:veeam:CdpPolicy:bc933bb6-0cc5-47b6-a1ec-e062b9e29877. |
Name | String | Name of the CDP policy, for example: CDP Policy 1. |
PolicyType | String | Policy type. Possible value: CdpReplica. |
Platform | String | Platform for which the job is created. Possible values:
|
Description | String | Description of the CDP policy. |
ScheduleConfigured | Boolean | Defines whether scheduling options are specified for the CDP policy. Possible values:
|
ScheduleEnabled | Boolean | Defines whether schedule is enabled for the CDP policy. Possible values:
|
NextRun | DateTime | Date and time of the next run of the CDP policy. The parameter accepts only UTC-formatted DateTime values. |
PolicyScheduleOptions | ScheduleOptionsInfoType | Options that define the schedule by which the CDP policy runs. For details, see Policy Scheduling Options. |
CdpPolicyInfo | — | Complex object that includes a collection of VMs and VM containers processed by the CDP policy. For details, see GET /cdpPolicies/{ID}/includes. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=CdpPolicy.
Links
Reference | Relationship | Description |
|---|---|---|
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server where the CDP policy was configured. |
/cdpPolicies/{ID} | Alternate | Alternate URL of the /cdpPolicies/{ID} resource. |
/cdpPolicies/{ID} | Edit | URL for the PUT /cdpPolicies/{ID} request. |
/cdpPolicies/{ID}?action=disable | Disable | URL for the POST /cdpPolicies/{ID}?action=disable request. |
/cdpPolicies/{ID}?action=enable | Enable | URL for the POST /cdpPolicies/{ID}&action=enable request. |
/cdpPolicies/{ID}/includes | Down | URL of the /cdpPolicies/{ID}/includes resource — a collection of VMs and VM containers processed by the CDP policy. |
/cdpPolicies/{ID}/includes | Create | URL for the POST /cdpPolicies/{ID}/includes request. |
/cdpPolicies/{ID}/cdpReplicaSessions | Down | URL of the /cdpPolicies/{ID}/cdpReplicaSessions resource — a collection of CDP replication sessions of the CDP policy. |
Example
The example below returns an entity resource representation of the CDP policy having ID bc933bb6-0cc5-47b6-a1ec-e062b9e29877.
Request: GET https://localhost:9398/api/cdpPolicies/bc933bb6-0cc5-47b6-a1ec-e062b9e29877?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <CdpPolicy xmlns="http://www.veeam.com/ent/v1.0" Type="CdpPolicy" Href="https://localhost:9398/api/cdpPolicies/bc933bb6-0cc5-47b6-a1ec-e062b9e29877?format=Entity" Name="CDP Policy 1" UID="urn:veeam:CdpPolicy:bc933bb6-0cc5-47b6-a1ec-e062b9e29877"> |