Veeam Plug-in for Nutanix AHV 8
REST API Reference
Related documents

Workers

The /workers resource collection represents workers added to Veeam Plug-in for Nutanix AHV.

Get Collection of Workers

The HTTP GET request to the /workers endpoint retrieves a list of all workers configured in Veeam Plug-in for Nutanix AHV.

SecurityBearer
Request
query Parameters
offset
integer <int32> >= 0
Default: 0

Excludes from a response the first N items of a resource collection.

limit
integer <int32> >= -1
Default: 100

Specifies the maximum number of items of a resource collection to return in a response.

write-only
Array of objects or null (FilterParameter)

Specifies the criteria for items to be returned in a response. For more information, see the Veeam Plug-in for Nutanix AHV REST API Reference Overview, section Filter Parameters.

write-only
Array of objects or null (SortParameter)

Specifies the order of items in the response. For more information, see the Veeam Plug-in for Nutanix AHV REST API Reference Overview, section Sort Parameters.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v8/workers
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "results": [
    ]
}
Add Worker Configuration
The HTTP POST request to the /workers endpoint creates a new worker configuration.


SecurityBearer 
Request 
query Parameters
startTestSession
boolean
 Default:  false
Defines whether the worker will be tested (that is a worker VM will be deployed) after its configuration is created.


 
Request Body schema: application/json
required
Worker Configuration


name
required
string
Name of the worker. The maximum length of the name is 40 characters. The  a-z, A-Z, 0-9, - characters are only supported.


 
required
object (WorkerNetworkSettings) 
Specifies worker network settings.


 
clusterId
required
string
Specifies the ID of a cluster where the worker will be deployed.


 
maxConcurrentTasks
required
integer <int32>   >= 0 
Specifies the maximum number or backup and restore operations the worker can handle in parallel.


 
cpuCount
required
integer <int32>   >= 1 
Specifies the number of vCPU allocated to the worker VM.


 
memoryGb
required
integer <int32>   >= 1 
Specifies the amount of memory allocated to the worker VM (in gigabytes).


 
description
string or null
Specifies a description of the worker.


 
storageContainerId
string or null
Specifies the ID of a storage container where worker VM disks will be stored.


 
object or null (WorkerAffinitySettings) 
Specifies worker affinity settings.


 
Responses 
201
Created


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v8/workers
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "clusterId": "string",
  • "storageContainerId": "string",
  • "maxConcurrentTasks": 0,
  • "cpuCount": 1,
  • "memoryGb": 1,
  • "networkSettings": {
    },
  • "affinitySettings": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get Worker Configuration
The HTTP GET request to the /workers/{id} endpoint retrieves information on a worker with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to a worker in Veeam Plug-in for Nutanix AHV.


 
Responses 
200
OK


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


404
Worker not found


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v8/workers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "configuration": {
    },
  • "enabled": true,
  • "status": "Unknown",
  • "lastTestSession": {
    },
  • "vmId": "string"
}
Remove Worker
The HTTP DELETE request to the /workers/{id} endpoint removes a worker with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to a worker in Veeam Plug-in for Nutanix AHV.


 
Responses 
202
Accepted


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


404
Not Found. The worker specified in the request could not be found in the resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


delete/api/v8/workers/{id}
Request samples 
Response samples 
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Get Worker
The HTTP GET request to the /worker/{id}/configuration endpoint retrieves the configuration of a worker with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to a worker in Veeam Plug-in for Nutanix AHV.


 
Responses 
200
OK


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


404
Not Found. The worker specified in the request could not be found in the resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v8/workers/{id}/configuration
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "clusterId": "string",
  • "storageContainerId": "string",
  • "maxConcurrentTasks": 0,
  • "cpuCount": 1,
  • "memoryGb": 1,
  • "networkSettings": {
    },
  • "affinitySettings": {
    }
}
Modify Worker Configuration
The HTTP PUT request to the /workers/{id}/configuration endpoint updates the configuration of a worker with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to a worker in Veeam Plug-in for Nutanix AHV.


 
query Parameters
failActiveWorkerSessions
boolean
 Default:  false
Defines whether active worker sessions will be terminated if the configuration update requires powering off or redeploying the worker VM.


 
startTestSession
boolean
 Default:  false
Defines whether the worker will be tested after it has been configured.


 
Request Body schema: application/json
required
Worker Update Configuration parameters


name
required
string
Name of the worker. The maximum length of the name is 40 characters. The  a-z, A-Z, 0-9, - characters are only supported.


 
required
object (WorkerNetworkSettings) 
Specifies worker network settings.


 
clusterId
required
string
Specifies the ID of a cluster where the worker will be deployed.


 
maxConcurrentTasks
required
integer <int32>   >= 0 
Specifies the maximum number or backup and restore operations the worker can handle in parallel.


 
cpuCount
required
integer <int32>   >= 1 
Specifies the number of vCPU allocated to the worker VM.


 
memoryGb
required
integer <int32>   >= 1 
Specifies the amount of memory allocated to the worker VM (in gigabytes).


 
description
string or null
Specifies a description of the worker.


 
storageContainerId
string or null
Specifies the ID of a storage container where worker VM disks will be stored.


 
object or null (WorkerAffinitySettings) 
Specifies worker affinity settings.


 
Responses 
202
Accepted


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


404
Not Found. The worker specified in the request could not be found in the resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


put/api/v8/workers/{id}/configuration
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "clusterId": "string",
  • "storageContainerId": "string",
  • "maxConcurrentTasks": 0,
  • "cpuCount": 1,
  • "memoryGb": 1,
  • "networkSettings": {
    },
  • "affinitySettings": {
    }
}
Response samples 
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Test Worker
The HTTP POST request to the /worker/{id}/test endpoint starts testing a worker with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to a worker in Veeam Plug-in for Nutanix AHV.


 
Responses 
202
Accepted


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


404
Not Found. The worker specified in the request could not be found in the resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v8/workers/{id}/test
Request samples 
Response samples 
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Enable Worker
The HTTP POST request to the /workers/{id}/enable endpoint enables a disabled worker with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to a worker in Veeam Plug-in for Nutanix AHV.


 
Responses 
204
No Content


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


404
Not Found. The worker specified in the request could not be found in the resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v8/workers/{id}/enable
Request samples 
Response samples 
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}
Disable Worker
The HTTP POST request to the /workers/{id}/disable endpoint disables a worker with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to a worker in Veeam Plug-in for Nutanix AHV.


 
Responses 
204
No Content


400
Bad Request. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


404
Not Found. The worker specified in the request could not be found in the resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v8/workers/{id}/disable
Request samples 
Response samples 
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}

    
    

                                

                                    
Document updated 9/03/2025
Page content applies to build 13.8.0.582