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

Removing Instance by Instance ID

This section explains how to remove an instance used as a worker from the Veeam Backup for Microsoft Azure environment.

Request

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

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

vmName

The name of the worker. Can be obtained as described in Getting Workers.

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

None.

Response Example

Request:

DELETE https://abc.ukwest.cloudapp.azure.com/api/v1/workers/VBA-65c35d74-eab2-4256-9025-9ea8bea6b6ef

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 

}

I want to report a typo

There is a misspelling right here:

 

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