Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Workers

The /workers resource collection represents worker configurations and profiles added to Veeam Backup for Microsoft Azure.

Get Collection of Worker Instances

The HTTP GET request to the /workers endpoint retrieves a list of worker instances currently launched by Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
SearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: WorkerOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/workers
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/workers?SearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Remove Worker Instance

The HTTP DELETE request to the /workers/{vmName} endpoint removes a worker instance with the specified name from the Microsoft Azure environment.

SecurityBearer
Request
path Parameters
vmName
required
string

Specifies the name of an Azure VM that is launched as a worker instance.

Responses
204

No Content

401

Unauthorized

403

Forbidden

delete/api/v8/workers/{vmName}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/workers/{vmName}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Export Collection of Worker Instances

The HTTP POST request to the /workers/export endpoint exports a list of worker instances to a .CSV or an .XML file.

x-veeam-custom-response: true
SecurityBearer
Request
header Parameters
Accept
string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json
vmNames
Array of strings or null

Specifies the Azure VM names of worker instances whose details will be exported.

Responses
200

OK

401

Unauthorized

403

Forbidden

post/api/v8/workers/export
Request samples
application/json
{
  • "vmNames": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Get Worker Instance Statistics

The HTTP GET request to the /workers/statistics endpoint retrieves the Veeam Backup for Microsoft Azure statistics on worker instances.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/workers/statistics
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/workers/statistics \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "countOfWorkers": 0,
  • "runningWorkers": 0,
  • "totalCycleTime": "string",
  • "usedWorkers": 0,
  • "deployedWorkers": 0
}

Get Collection of Worker Configurations

The HTTP GET request to the /workers/networkConfiguration endpoint retrieves a list of worker configurations added to Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
RegionId
string or null

Returns only worker configurations added for an Azure region with the specified ID.

x-veeam-parameter-group: WorkerNetworkConfigurationOptions
SearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: WorkerNetworkConfigurationOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/workers/networkConfiguration
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/workers/networkConfiguration?RegionId=string&SearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Add Worker Configuration

The HTTP POST request to the /workers/networkConfiguration endpoint creates a new worker configuration used to launch worker instances in a specific Azure region.

SecurityBearer
Request
Request Body schema: application/json
required
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region where the worker configuration will reside.

subnet
required
string

Specifies the name of the subnet to which worker instances will be connected.

virtualNetworkResourceId
required
string

Specifies the complete resource ID containing all information on the virtual network where the worker resides.

networkSecurityGroupId
string or null

Specifies the Microsoft Azure ID assigned to a network security group.

forbidPublicIp
boolean or null

Defines whether to assign only private IP addresses to worker instances used for file-level recovery operations.

tenantId
string or null <uuid>

Specifies the Microsoft Azure ID assigned to a tenant in which worker instances will be launched. If no value is specified for the property, Veeam Backup for Microsoft Azure will use the tenant where the backup appliance is deployed. Consider that if private network deployment is enabled on the backup appliance, you can only specify a tenant where the backup appliance is deployed.

subscriptionId
string or null <uuid>

Specifies the Microsoft Azure ID assigned to a subscription in which worker instances will be launched. Note that the subscription must belong to the tenant specified in the value of the tenantId property. If no value is specified for the subscriptionId property, Veeam Backup for Microsoft Azure will use the subscription where the backup appliance is deployed. Consider that if private network deployment is enabled on the backup appliance, you can only specify a subscription belonging to the tenant where the backup appliance is deployed.

resourceGroup
string or null

Specifies the name of the resource group in which the worker instances will be launched. Note that the resource group must belong to the subscription specified in the subscriptionId property. If no value is specified for the resourceGroup property, Veeam Backup for Microsoft Azure will automatically generate the value and create a resource group in the subscription specified in the subscriptionId property, or in the subscription where the backup appliance is deployed.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

415

Client Error

post/api/v8/workers/networkConfiguration
Request samples
application/json
{
  • "subnet": "string",
  • "virtualNetworkResourceId": "string",
  • "regionId": "string",
  • "networkSecurityGroupId": "string",
  • "forbidPublicIp": true,
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "resourceGroup": "string"
}
Response samples
application/json
{
  • "virtualNetwork": {
    },
  • "region": {
    },
  • "networkSecurityGroup": {
    },
  • "forbidPublicIp": true,
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "tenantName": "string",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "subscriptionName": "string",
  • "resourceGroup": "string",
  • "configurationType": "Automatic",
  • "_links": {}
}

Get Worker Configuration Data

The HTTP GET request to the /workers/networkConfiguration/{regionId} endpoint retrieves information on worker configurations added for a specific Azure region.

SecurityBearer
Request
path Parameters
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region for which worker configurations will be returned.

query Parameters
subscriptionId
string <uuid>

Specifies a Microsoft Azure ID assigned to a subscription for which the worker configuration will be returned.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/workers/networkConfiguration/{regionId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/workers/networkConfiguration/{regionId}?subscriptionId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "virtualNetwork": {
    },
  • "region": {
    },
  • "networkSecurityGroup": {
    },
  • "forbidPublicIp": true,
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "tenantName": "string",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "subscriptionName": "string",
  • "resourceGroup": "string",
  • "configurationType": "Automatic",
  • "_links": {}
}

Modify Worker Configuration

The HTTP PUT request to the /workers/networkConfiguration/{regionId} endpoint updates worker configuration settings added for a specific Azure region.

SecurityBearer
Request
path Parameters
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region for which a worker configuration is added.

Request Body schema: application/json
required
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region where the worker configuration will reside.

subnet
required
string

Specifies the name of the subnet to which worker instances will be connected.

virtualNetworkResourceId
required
string

Specifies the complete resource ID containing all information on the virtual network where the worker resides.

networkSecurityGroupId
string or null

Specifies the Microsoft Azure ID assigned to a network security group.

forbidPublicIp
boolean or null

Defines whether to assign only private IP addresses to worker instances used for file-level recovery operations.

tenantId
string or null <uuid>

Specifies the Microsoft Azure ID assigned to a tenant in which worker instances will be launched. If no value is specified for the property, Veeam Backup for Microsoft Azure will use the tenant where the backup appliance is deployed. Consider that if private network deployment is enabled on the backup appliance, you can only specify a tenant where the backup appliance is deployed.

subscriptionId
string or null <uuid>

Specifies the Microsoft Azure ID assigned to a subscription in which worker instances will be launched. Note that the subscription must belong to the tenant specified in the value of the tenantId property. If no value is specified for the subscriptionId property, Veeam Backup for Microsoft Azure will use the subscription where the backup appliance is deployed. Consider that if private network deployment is enabled on the backup appliance, you can only specify a subscription belonging to the tenant where the backup appliance is deployed.

resourceGroup
string or null

Specifies the name of the resource group in which the worker instances will be launched. Note that the resource group must belong to the subscription specified in the subscriptionId property. If no value is specified for the resourceGroup property, Veeam Backup for Microsoft Azure will automatically generate the value and create a resource group in the subscription specified in the subscriptionId property, or in the subscription where the backup appliance is deployed.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

put/api/v8/workers/networkConfiguration/{regionId}
Request samples
application/json
{
  • "subnet": "string",
  • "virtualNetworkResourceId": "string",
  • "regionId": "string",
  • "networkSecurityGroupId": "string",
  • "forbidPublicIp": true,
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "resourceGroup": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Remove Worker Configuration

The HTTP DELETE request to the /workers/networkConfiguration/{regionId} removes a worker configuration for a specific Azure region.

SecurityBearer
Request
path Parameters
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region for which a worker configuration is deleted.

query Parameters
subscriptionId
string

Specifies a Microsoft Azure ID assigned to a subscription for which a worker configuration is deleted.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

delete/api/v8/workers/networkConfiguration/{regionId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/workers/networkConfiguration/{regionId}?subscriptionId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "Canceled",
  • "error": {
    },
  • "_links": {},
  • "result": {
    }
}

Export Worker Configurations

The HTTP POST request to the /workers/networkConfiguration/export/ endpoint exports a list of worker configurations to a .CSV or an .XML file.

x-veeam-custom-response: true
SecurityBearer
Request
header Parameters
Accept
string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json
regionIds
Array of strings or null

Specifies Azure IDs assigned to regions for which the worker configurations will be exported.

Responses
200

OK

401

Unauthorized

403

Forbidden

post/api/v8/workers/networkConfiguration/export
Request samples
application/json
{
  • "regionIds": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Specify Worker Location and Service Account

The HTTP POST request to the /workers/networkConfiguration/setWorkerDeploymentOptions endpoint allows you to specify a service account that will be used to launch worker instances, and also a subscription and a resource group in which the worker instances will be launched.

SecurityBearer
Request
query Parameters
azureAccountId
string or null <uuid>

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account that will be used to launch worker instances.

x-veeam-parameter-group: WorkerDeploymentOptions
subscriptionId
string or null <uuid>

Specifies a Microsoft Azure ID assigned to the subscription in which the worker instances will be launched. Note that the service account specified in the azureAccountId parameter must have the worker management permissions assigned in this subscription. For more information, see the Veeam Backup for Microsoft Azure User Guide.

x-veeam-parameter-group: WorkerDeploymentOptions
resourceGroupName
string or null

Specifies the name of the resource group in which the worker instances will be launched. Note that the resource group must belong to the subscription specified in the subscriptionId parameter.

x-veeam-parameter-group: WorkerDeploymentOptions
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/workers/networkConfiguration/setWorkerDeploymentOptions
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/workers/networkConfiguration/setWorkerDeploymentOptions?azureAccountId=497f6eca-6276-4993-bfeb-53cbbbba6f08&subscriptionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&resourceGroupName=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Get Collection of Worker Profiles

The HTTP GET request to the /workers/profiles endpoint retrieves a list of worker profiles added to Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
RegionId
string or null

Returns only worker profiles configured for an Azure region with the specified ID.

x-veeam-parameter-group: WorkerProfileOptions
SearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: WorkerProfileOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/workers/profiles
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/workers/profiles?RegionId=string&SearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Add Worker Profiles

The HTTP POST request to the/workers/profiles endpoint creates a new set of worker profiles.

SecurityBearer
Request
Request Body schema: application/json
required
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region for which a set of worker profiles will be added.

minInstances
integer <int32> >= 0

Specifies number of worker instances that are deployed in the specified region and kept in the Azure environment even when no operations are performed by Veeam Backup for Microsoft Azure.

maxInstances
integer <int32> [ 1 .. 1000 ]

Specifies a maximum number of worker instances that can be deployed in the specified region and used simultaneously to process Azure resources during backup and restore operations.
Note: After a backup or restore operation completes, Veeam Backup for Microsoft Azure keeps the minimum number of worker instances running for 10 minutes and then deallocates them; the other instances are automatically removed from the backup infrastructure.

virtualMachineSimpleType
string or null

[Applies only if one single VM size will be used to launch all worker instances in the specified region] Specifies a profile used for backup, restore and archive operations.

virtualMachineSmallType
string or null

Specifies a profile used to create image-level backups and restore data if the total disk size of the processed Azure VM or the total size of the processed Azure SQL database is less than 100 GB.

virtualMachineMediumType
string or null

Specifies a profile used to create image-level backups and restore data if the total disk size of the processed Azure VM or the total size of the processed Azure SQL database is 100 GB - 1 TB.

virtualMachineLargeType
string or null

Specifies a profile used to create image-level backups and restore data if the total disk size of the processed Azure VM or the total size of the processed Azure SQL database is more than 1 TB.

virtualMachineArchiveType
string

Specifies a profile used to create archived backups.

Responses
201

Create

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

415

Client Error

post/api/v8/workers/profiles
Request samples
application/json
{
  • "minInstances": 0,
  • "maxInstances": 1,
  • "regionId": "string",
  • "virtualMachineSimpleType": "string",
  • "virtualMachineSmallType": "string",
  • "virtualMachineMediumType": "string",
  • "virtualMachineLargeType": "string",
  • "virtualMachineArchiveType": "string"
}
Response samples
application/json
{
  • "minInstances": 0,
  • "maxInstances": 0,
  • "region": {
    },
  • "virtualMachineSimpleType": "string",
  • "virtualMachineSmallType": "string",
  • "virtualMachineMediumType": "string",
  • "virtualMachineLargeType": "string",
  • "virtualMachineArchiveType": "string",
  • "_links": {}
}

Get Worker Profiles for Region

The HTTP GET request to the /workers/profiles/{regionId} endpoint retrieves information on a set of worker profiles added for a specific Azure region.

SecurityBearer
Request
path Parameters
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region for which a set of profiles is added.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/workers/profiles/{regionId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/workers/profiles/{regionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "minInstances": 0,
  • "maxInstances": 0,
  • "region": {
    },
  • "virtualMachineSimpleType": "string",
  • "virtualMachineSmallType": "string",
  • "virtualMachineMediumType": "string",
  • "virtualMachineLargeType": "string",
  • "virtualMachineArchiveType": "string",
  • "_links": {}
}

Modify Worker Profiles

The HTTP PUT request to the /workers/profiles/{regionId} endpoint updates a set of worker profiles for a specific Azure region.

SecurityBearer
Request
path Parameters
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region for which a set of profiles is added.

Request Body schema: application/json
required
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region for which a set of worker profiles will be added.

minInstances
integer <int32> >= 0

Specifies number of worker instances that are deployed in the specified region and kept in the Azure environment even when no operations are performed by Veeam Backup for Microsoft Azure.

maxInstances
integer <int32> [ 1 .. 1000 ]

Specifies a maximum number of worker instances that can be deployed in the specified region and used simultaneously to process Azure resources during backup and restore operations.
Note: After a backup or restore operation completes, Veeam Backup for Microsoft Azure keeps the minimum number of worker instances running for 10 minutes and then deallocates them; the other instances are automatically removed from the backup infrastructure.

virtualMachineSimpleType
string or null

[Applies only if one single VM size will be used to launch all worker instances in the specified region] Specifies a profile used for backup, restore and archive operations.

virtualMachineSmallType
string or null

Specifies a profile used to create image-level backups and restore data if the total disk size of the processed Azure VM or the total size of the processed Azure SQL database is less than 100 GB.

virtualMachineMediumType
string or null

Specifies a profile used to create image-level backups and restore data if the total disk size of the processed Azure VM or the total size of the processed Azure SQL database is 100 GB - 1 TB.

virtualMachineLargeType
string or null

Specifies a profile used to create image-level backups and restore data if the total disk size of the processed Azure VM or the total size of the processed Azure SQL database is more than 1 TB.

virtualMachineArchiveType
string

Specifies a profile used to create archived backups.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

put/api/v8/workers/profiles/{regionId}
Request samples
application/json
{
  • "minInstances": 0,
  • "maxInstances": 1,
  • "regionId": "string",
  • "virtualMachineSimpleType": "string",
  • "virtualMachineSmallType": "string",
  • "virtualMachineMediumType": "string",
  • "virtualMachineLargeType": "string",
  • "virtualMachineArchiveType": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Remove Worker Profiles

The HTTP DELETE request to the /workers/profiles/{regionId} endpoint removes a set of worker profiles for a specific Azure region.

SecurityBearer
Request
path Parameters
regionId
required
string

Specifies a Microsoft Azure ID assigned to a region for which a set of profiles is added.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

delete/api/v8/workers/profiles/{regionId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/workers/profiles/{regionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "Canceled",
  • "error": {
    },
  • "_links": {},
  • "result": {
    }
}

Export Worker Profiles

The HTTP POST request to the /workers/profiles/export endpoint exports a list of worker profiles to an .XML or .CSV file.

x-veeam-custom-response: true
SecurityBearer
Request
header Parameters
Accept
string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json
regionIds
Array of strings or null

Specifies a list of Azure IDs assigned to regions whose worker profiles will be exported.

Responses
200

OK

401

Unauthorized

403

Forbidden

post/api/v8/workers/profiles/export
Request samples
application/json
{
  • "regionIds": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Get Worker Custom Tags

The HTTP GET request to the /workers/customTags endpoint retrieves a list of custom tags that are assigned to worker instances.

SecurityBearer
Responses
200

OK

400

Bad Request

401

Unauthorized

get/api/v8/workers/customTags
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/workers/customTags \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "tags": [
    ]
}

Modify Worker Custom Tags

The HTTP PUT request to the /workers/customTags endpoint updates a list of custom tags that must be assigned to worker instances.

SecurityBearer
Request
Request Body schema: application/json
required
Array of objects or null (WorkerTag)

Information on each Azure tag assigned to worker instances.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

put/api/v8/workers/customTags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}