GET /jobs/{ID}
Returns a resource representation of the job resource having the specified ID.
Supported Platforms
The request is supported for the following platforms:
- VMware vSphere
- VMware Cloud Director
- Microsoft Hyper-V
Request
To get a resource representation of the job, send the GET HTTP request to the URL of the /jobs/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/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 /jobs/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the job, for example: urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512. |
Name | String | Name of the job, for example: DC Replication. |
JobType | String | Job type. Possible values:
|
Platform | String | Platform for which the job is created. Possible values:
|
Description | String | Description of the job specified at the time of the job creation. |
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:
|
NextRun | DateTime | Date and time of the next job run. The parameter accepts only UTC-formatted DateTime values. Note that this parameter can be used for scheduled jobs only. |
JobScheduleOptions | ScheduleOptionsInfoType | Options that define the schedule by which the job runs. For details, see Job Scheduling Options. |
JobInfo | — | Object that includes one of the following complex objects depending on the job type:
For details, see Job Info. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=Job.
Links
Reference | Relationship | Description |
|---|---|---|
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server where the job was configured. |
/jobs/{ID} | Alternate | Alternate URL of the /jobs/{ID} resource. |
/jobs/{ID} | Edit | URL for the PUT /jobs/{ID} request. |
/jobs/{ID}?action=start | Start | URL for the POST /jobs/{ID}?action=start request. It's available for backup and replication jobs. |
/jobs/{ID}?action=sync | Sync | URL for the POST /jobs/{ID}?action=sync request. It's available for backup copy jobs only. |
/jobs/{ID}?action=stop | Stop | URL for the POST /jobs/{ID}?action=stop request. |
/jobs/{ID}?action=retry | Retry | URL for the POST /jobs/{ID}?action=retry request. |
/jobs/{ID}?action=clone | Clone | URL for the POST /jobs/{ID}?action=clone request. |
/jobs/{ID}?action=toggleScheduleEnabled | ToggleScheduleEnabled | URL for the POST /jobs/{ID}?action=toggleScheduleEnabled request. |
/jobs/{ID}/includes | Down | URL of the /jobs/{ID}/includes resource — a collection of VMs and VM containers processed by the job. |
/jobs/{ID}/includes | Create | URL for the POST /jobs/{ID}/includes request. |
/jobs/{ID}/backupSessions | Down | URL of the /jobs/{ID}/includes resource — a collection of backup job sessions initiated for the job. |
Example
The example below returns an entity resource representation of the job having ID 5658281f-625e-4627-89dd-d2a0c48be99e.
Request: GET https://localhost:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <Job xmlns="http://www.veeam.com/ent/v1.0" Type="Job" Href="https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e?format=Entity" Name="DB Backup" UID="urn:veeam:Job:5658281f-625e-4627-89dd-d2a0c48be99e"> |