GET /agents/jobs/{ID}
Returns a resource representation of the Veeam Agent backup job resource having the specified ID. The Veeam Agent backup job is configured in Veeam Backup & Replication.
Request
To get a resource representation of the Veeam Agent backup job, send the GET HTTP request to the URL of the /agents/jobs/{ID} resource:
HTTP Request
GET https://<Enterprise-Manager>:9398/api/agents/jobs/{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 /agents/jobs/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the Veeam Agent backup job, for example: urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512. |
Name | String | Name of the Veeam Agent backup job, for example: Linux job. |
JobType | String | Defines Veeam Agent backup job type. Possible value: AgentBackup. |
Platform | String | Platform for which the job is created. Possible values:
|
Description | String | Description of the job. |
ScheduleConfigured | Boolean | Defines whether scheduling options are specified for the job. Possible values:
|
ScheduleEnabled | Boolean | Defines whether schedule is enabled for the job. Possible values:
|
JobScheduleOptions | ScheduleOptionsInfoType | Options that define the schedule by which the job runs. For details, see Job Scheduling Options. |
JobInfo | — | Complex object that includes a collection of machines processed by the job. For details, see GET /jobs/{ID}/includes/{ID}. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=AgentBackupJob.
Links
Reference | Relationship | Description |
|---|---|---|
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server where the Veeam Agent backup job was configured. |
/agents/jobs/{ID} | Alternate | Alternate URL of the /agents/jobs/{ID} resource. |
/agents/jobs/{ID}/includes | Down | URL of the /agents/jobs/{ID}/includes resource — a list of protected computers and protection groups processed by the Veeam Agent backup job. |
/agents/jobs/{ID}?action=toggleScheduleEnabled | ToggleScheduleEnabled | URL for the POST /agents/jobs/{ID}?action=toggleScheduleEnabled request. |
/agents/jobs/{ID}/backupSessions | Down | URL of the /agents/backupSessions resource — a collection of backup sessions performed for the Veeam Agent backup job. |
/agents/jobs/{ID}?action=start | Start | URL for the POST /agents/jobs/{ID}?action=start request. |
/agents/jobs/{ID}?action=stop | Stop | URL for the POST /agents/jobs/{ID}?action=stop request. |
/agents/jobs/{ID}?action=retry | Retry | URL for the POST /agents/jobs/{ID}?action=retry request. |
Example
The example below returns an entity resource representation of the Veeam Agent backup job having ID a6deb158-b26c-4140-8b26-5a3cc344e8ec.
Request: GET https://localhost:9398/api/agents/jobs/a6deb158-b26c-4140-8b26-5a3cc344e8ec?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <AgentBackupJob xmlns="http://www.veeam.com/ent/v1.0" Type="AgentBackupJob" Href="https://srv12.tech.local:9398/api/agents/jobs/a6deb158-b26c-4140-8b26-5a3cc344e8ec?format=Entity" Name="Server Backup" UID="urn:veeam:AgentBackupJob:a6deb158-b26c-4140-8b26-5a3cc344e8ec"> |