This is an archive version of the document. To get the most up-to-date information, see the current version.(DELETE) /jobs/{ID}/includes/{ID}
Deletes a VM or a VM container that has the specified ID and is processed by the job with the specified ID.
|
If a job processes only one object (VM or VM container), you cannot delete this object via Veeam Backup Enterprise ManagerRESTful API. |
Note:Request
To remove a VM or a VM container from the job so that the VM or VM container is no longer processed, you need to send the DELETE HTTP request to the URL of the /jobs/{ID}/includes/{ID} resource.
HTTP Request
DELETE https://<Enterprise-Manager>:9398/api/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. To learn more, 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.
Query Parameters
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, Veeam Backup Enterprise Manager returns an ID of the task that has been created to perform the requested action, and the task state. You can check the operation results by sending the GET HTTP request to the URL of the task resource.
Additionally, Veeam Backup Enterprise Manager returns a link to the task deletion operation. You can send the DELETE HTTP request to the URL in the link to stop the task execution.
Example
The example below removes a VM having ID 27a1d57f-7c15-43c6-9162-d05aff1c9bb9 from the job having ID d1b85018-2769-45be-89bc-03f66b60e6cb.
Request: DELETE https://localhost:9398/api/jobs/d1b85018-2769-45be-89bc-03f66b60e6cb/includes/27a1d57f-7c15-43c6-9162-d05aff1c9bb9
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 trace the status of the operation, send the GET HTTP request to the URL of 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"> |