POST /agents/jobs/{ID}?action=stop
Stops a Veeam Agent backup job having the specified ID. The Veeam Agent backup job is configured in Veeam Backup & Replication.
Request
To stop a job, send the POST HTTP request to the /jobs/{ID}?action=stop URL.
HTTP Request
|
POST https://<Enterprise-Manager>:9398/api/agents/jobs/{ID}?action=stop |
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 202 Accepted.
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 task that has been created to perform the requested operation. To track the status of the operation, send the GET /tasks/{ID} request.
The task resource also contains a link to the task deletion operation. To stop the task execution, send the DELETE /task/{ID} request to the URL in the link.
Example
The example below stops a job having ID 78c3919c-54d7-43fe-b047-485d3566f11f.
|
Request: POST https://localhost:9398/api/agents/jobs/78c3919c-54d7-43fe-b047-485d3566f11f?action=stop Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 202 Accepted Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |
To track the status of the operation, send the GET HTTP request to the received task resource:
|
Request: GET https://localhost:9398/api/tasks/task-1 Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |