Modify Worker Tags

You can modify settings of worker tags.

Request

To edit worker tags, send the HTTP PUT request to the /configuration/workertags endpoint.

HTTP Request

PUT https://<hostname>/api/v2/configuration/workertags

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.

Request Body

Set the parameter values in the following format:

{

 "tags": [

   {

     "key": "string",

     "value": "string"

   }

 ]

}

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 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.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns an updated representation of the worker tags.

Modify Worker TagsExample

The following request modifies the workertags.

Request:

PUT https://51.11.247.127/api/v2/configuration/workertags

 

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: application/json

 

Request Body:

{

 "tags": [

   {

     "key": "worker_tag",

     "value": "dept_1"

   }

 ]

}

 

Response:

200

I want to report a typo

There is a misspelling right here:

 

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