Remove Worker Configuration

To remove a worker configuration, send the HTTP DELETE request to the /workerConfiguration/{id} endpoint. {id} is a system ID assigned to the worker configuration in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

DELETE https://<hostname>/api/v2/workerConfiguration/{id}

Request Headers

The request contains the following headers.

Header

Required

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.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a 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

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Remove Worker ConfigurationExample

The following request removes worker configuration with the ID 1 from the Veeam Backup for Microsoft Azure database.

Request:

DELETE https://51.11.247.127/api/v2/workerConfiguration/1

 

Request Header:

Authorization: Bearer <Access-Token>

 

 

Request Body:

{

 "id": "eb01c702-652e-4530-bcee-e604769b1cd6",

 "startTime": "2020-11-25T08:27:06.9324992Z",

 "status": "Running",

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/operations/eb01c702-652e-4530-bcee-e604769b1cd6"

   }

 }

}

 

Response:

202

 

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.