This is an archive version of the document. To get the most up-to-date information, see the current version.

Removing Worker Configuration by Configuration ID

This section explains how to remove a worker configuration from the Veeam Backup for Microsoft Azure environment.

Request

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

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be posted as URL.

Parameter	Description
id	The identification number of the user. Can be obtained as described in Getting Users.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property	Type	Description
busyWorkersExists	boolean	Shows if there are any workers that perform operations while the worker configuration is being removed.
deletionSuccessfull	boolean	Shows if the specified worker configuration has been removed successfully.
virtualNetworkName	string	Shows the virtual network name.

Response Example

Request:

DELETE https://abc.ukwest.cloudapp.azure.com/api/v1/workerConfiguration/9

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"busyWorkersExists": false,

"deletionSuccessfull": true,

"virtualNetworkName": "abc-network"

}