GET /query?type=ObjectInAgentBackupJob
Returns a list of protected computers and protection groups processed by Veeam Agent backup jobs. For details, see /agents/jobs/{ID}/includes.
Request
To get a list of protected computers and protection groups processed by Veeam Agent backup jobs, send the GET HTTP request to the query with the type parameter set to ObjectInAgentBackupJob.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/query?type=ObjectInAgentBackupJob |
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 |
|---|---|---|
UID | String | ID of the file or folder processed by the job, for example: 6fefb504-856d-4c31-b767-76af5567c407. |
DisplayName | String | Name of the file or folder processed by the job, for example: \\srv12\share\archive. |
JobUid | UidType | UID of the file share backup job parent to the file or folder resource, for example: urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512. |
JobName | String | Name of the file share backup job parent to the file or folder resource, for example: Shared Files Backup. |
FileServerUid | UidType | UID of the file share parent to the file or folder resource, for example: urn:veeam:FileServer:517be4c8-9c43-4e7c-9f59-4e368d3a8f3c. |
FileServerName | String | Name of the file share parent to the file or folder resource, for example: \\srv12\share. |
BackupServerUid | UidType | UID of the backup server on which the file share parent to the file or folder resource is added, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15. |
BackupServerName | String | Name of the backup server on which the file share parent to the file or folder resource is added, for example: srv01. |
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. |
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 /agents/jobs/{ID}/includes resource collection.
Example
The example below returns an entity resource representation of a collection of files and folders processed by file share backup jobs created on the enterprise06.tech.local backup server. The results are ordered in the acceding order by the JobName parameter.
Request: GET https://localhost:9398/api/query?type=NasObject&format=Entities&sortAsc=JobName&filter=BackupServerName=="enterprise06.tech.local"
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |