Remove Worker Instances

You can remove worker instances launched on the Azure VM with the specified name from the Veeam Backup for Microsoft Azure configuration database.

Request

To remove worker instances, send the HTTP DELETE request to the /workers/{vmName} endpoint.

HTTP Request

DELETE https://<hostname>/api/v2/workers/{vmName}

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 204 (No Content).

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 InstancesExample

The following request removes worker instances launched on the Azure VM with the name cpm_Vm  from the Veeam Backup for Microsoft Azure database.

Request:

DELETE https://51.11.247.127/api/v2/workers/cpm_Vm

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

204

I want to report a typo

There is a misspelling right here:

 

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