GET /agents/jobs/{ID}/includes/{ID}
Returns a representation of a protected computer or a protection group having the specified ID and processed by the Veeam Agent backup job with the specified ID.
Request
To get a representation of a protected computer or a protection group processed by the Veeam Agent backup job, send the GET HTTP request to the URL of the /agents/jobs/{ID}/includes/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/agents/jobs/{ID}/includes/{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:
|
In the response body, the REST API returns an entity reference of the /agents/jobs/{ID}/includes/{ID} resource that contains the following parameters.
Element | Type | Description |
|---|---|---|
ObjectInJobId | String | ID of the protected computer or protection group, for example: e310aa12-eff2-41f4-97c8-631b677fc17f. |
Name | String | Name of the protected computer or protection group, for example: DC-SRV. |
DisplayName | String | Display name of the protected computer or protection group, for example: DC-SRV. |
GuestProcessingOptions | GuestProcessingOptionsType | Options for application-aware image processing. For details, see Guest Processing Options. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=ObjectInAgentBackupJob.
Example
A sample request below returns a resource representation of the VM having ID 83071dc0-44f2-49b6-b431-1cb79ed66639 that is processed by the job having ID da4a15c2-04e7-4135-b876-577249d3d720.
Request: GET https://localhost:9398/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <?xml version="1.0" encoding="utf-8"?> |