Veeam Backup & Replication 13
REST API Reference
Related documents

Agents

The Agents section defines paths and operations for obtaining protected computers and managing recovery tokens used for bare metal recovery.

Get All Recovery Tokens

The HTTP GET request to the /api/v1/agents/recoveryTokens path allows you to get an array of all recovery tokens.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of recovery tokens to skip.

limit
integer <int32>

Maximum number of recovery tokens to return.

orderColumn
string (EComputerRecoveryTokenFiltersOrderColumn)

Sorts recovery tokens by one of the parameters.

Enum: "Name" "ExpirationDate"
orderAsc
boolean

Sorts recovery tokens in the ascending order by the orderColumn parameter.

nameFilter
string

Filters recovery tokens by the nameFilter pattern. The pattern can match any repository parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

header Parameters
x-api-version
required
string
Default: 1.1-rev2

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

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

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

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/v1/agents/recoveryTokens
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Create Recovery Token
The HTTP POST request to the /api/v1/agents/recoveryTokens path allows you to create a new recovery token.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.1-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
backupIds
required
Array of strings <uuid> 
Array of backup IDs whose data you want to restore with the recovery token.


 
expirationDate
required
string <date-time> 
Date and time when the access token expires.


 
Responses 
200
Recovery token has been created.


400
Bad request. This error is related to POST/PUT requests. 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).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


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/v1/agents/recoveryTokens
Request samples 
application/json
{
  • "backupIds": [
    ],
  • "expirationDate": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recoveryToken": "string",
  • "expirationDate": "2019-08-24T14:15:22Z"
}
Get Recovery Token
The HTTP GET request to the /api/v1/agents/recoveryTokens/{id} path allows you to get a recovery token that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the recovery token.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


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/v1/agents/recoveryTokens/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recoveryToken": "string",
  • "expirationDate": "2019-08-24T14:15:22Z"
}
Edit Recovery Token
The HTTP PUT request to the /api/v1/agents/recoveryTokens/{id} path allows you to edit settings of a recovery token that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the recovery token.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
id
required
string <uuid> 
ID of the recovery token.


 
name
required
string
Friendly name of the recovery token.


 
expirationDate
required
string <date-time> 
Date and time when the recovery token expires.


 
recoveryToken
string
Recovery token.


 
Responses 
200
Recovery token has been updated.


400
Bad request. This error is related to POST/PUT requests. 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).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


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/v1/agents/recoveryTokens/{id}
Request samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recoveryToken": "string",
  • "expirationDate": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recoveryToken": "string",
  • "expirationDate": "2019-08-24T14:15:22Z"
}
Delete Recovery Token
The HTTP DELETE request to the /api/v1/agents/recoveryTokens/{id} path allows you to delete a recovery token that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the recovery token.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
204
Token has been deleted.


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


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/v1/agents/recoveryTokens/{id}
Request samples 
Response samples 
application/json
{ }
Get All Protected Computers
The HTTP GET request to the /api/v1/agents/protectedComputers path allows you to get an array of all protected computers. 
Available to: Veeam Backup Administrator, Veeam Restore Operator.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of protected computers to skip.


 
limit
integer <int32> 
Maximum number of protected computers to return.


 
orderColumn
string (EProtectedComputerFiltersOrderColumn) 
Sorts protected computers by one of the protected computer parameters.


 Enum: "Name" "Type"  
orderAsc
boolean
Sorts protected computers in the ascending order by the orderColumn parameter.


 
nameFilter
string
Filters protected computers by the nameFilter pattern. The pattern can match any protected computer parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.


 
typeFilter
string (EProtectedComputerType) 
Filters protected computers by protected computer type.


 Value: "Linux"  
header Parameters
x-api-version
required
string
 Default:  1.1-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


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/v1/agents/protectedComputers
Request samples 
Response samples 
application/json
{
  • "property": "value"
}
Get Protected Computer
The HTTP GET request to the /api/v1/agents/protectedComputers/{id} path allows you to get a protected computer that has the specified id.
Available to: Veeam Backup Administrator, Veeam Restore Operator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the protected computer.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


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/v1/agents/protectedComputers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "Linux",
  • "protectionGroups": [
    ]
}