This is an archive version of the document. To get the most up-to-date information, see the current version.Delete Job Configured for Veeam Agent for Microsoft Windows
You can delete a Veeam Agent for Microsoft Windows job with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To delete a Veeam Agent for Microsoft Windows job with the specified UID, send the DELETE HTTP request to the URL of the /infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid} resource. Additionally you must create a query string that defines whether job restore points are removed.
HTTP Request
DELETE https://<hostname>:1280/api/v3/infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}?removeRestorePoints=true |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
backupAgentUid | Path | String (uuid) | Yes | — | Veeam backup agent UID |
backupAgentJobUid | Path | String (uuid) | Yes | — | Veeam backup agent job UID |
removeRestorePoints | Query | Boolean | Yes | — | Defines whether restore points must be deleted |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns positive response code 200 OK when the collection task is added to the internal queue and not when the task is executed.
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: application/json; charset=utf-8 |
Example 
The following request deletes a Veeam Agent for Microsoft Windows job with UID 304c08c2-0d13-4e9d-b26b-0bd5add83b3b and deletes all restore points.
Request: DELETE https://localhost:1280/api/v3/infrastructure/backupAgents/windows/77bbbb8b-d251-4ee6-a23e-3044cae2d7f3/jobs/f6e6dbc4-2be8-4dfc-b45b-5011e302d136?removeRestorePoints=true
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK |