Veeam Backup & Replication 13
REST API Reference
Related documents

Encryption

The Encryption section defines paths and operations for managing passwords that are used for data encryption.

Get All Encryption Passwords

The HTTP GET request to the /api/v1/encryptionPasswords path allows you to get an array of all passwords that are used for data encryption.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of passwords to skip.

limit
integer <int32>

Maximum number of passwords to return.

orderColumn
string (EEncryptionPasswordsFiltersOrderColumn)

Sorts passwords by one of the password parameters.

Enum: "Hint" "ModificationTime"
orderAsc
boolean

Sorts passwords in the ascending order by the orderColumn parameter.

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

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/encryptionPasswords
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Encryption Password
The HTTP POST request to the /api/v1/encryptionPasswords path allows you to add an encryption password.


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


 
Request Body schema: application/json
required
hint
required
string
Hint for the encryption password. Provide a meaningful hint that will help you recall the password.


 
password
required
string
Password for data encryption. If you lose the password, you will not be able to restore it.


 
tag
string
Tag for the encryption password.


 
Responses 
201
Password has been added.


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/encryptionPasswords
Request samples 
application/json
{
  • "password": "string",
  • "hint": "string",
  • "tag": "string"
}
Response samples 
application/json
{
  • "password": "passsw3wrsdf2d44",
  • "hint": "Pet name",
  • "tag": "vcenter01"
}
Get Encryption Password
The HTTP GET request to the /api/v1/encryptionPasswords/{id} path allows you to get an encryption password that has the specified id.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the encryption password.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
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/encryptionPasswords/{id}
Request samples 
Response samples 
application/json
{
  • "id": "6ebbe3cc-8147-47b6-b77a-01eeb7965522",
  • "hint": "Standard Password",
  • "modificationTime": "2022-10-19T12:37:58.27+03:00",
  • "tag": "internal"
}
Edit Encryption Password
The HTTP PUT request to the /api/v1/encryptionPasswords/{id} path allows you to edit an encryption password that has the specified id.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the encryption password.


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


 
Request Body schema: application/json
required
hint
required
string
Hint for the encryption password.


 
id
required
string <uuid> 
ID of the encryption password.


 
modificationTime
string <date-time> 
Date and time when the password was last modified.


 
tag
string
Tag for the encryption password.


 
Responses 
200
Password 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/encryptionPasswords/{id}
Request samples 
application/json
{
  • "id": "6ebbe3cc-8147-47b6-b77a-01eeb7965522",
  • "hint": "Poem",
  • "modificationTime": "2022-10-19T12:37:58.27+03:00",
  • "tag": "internal"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hint": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "tag": "string"
}
Remove Encryption Password
The HTTP DELETE request to the /api/v1/encryptionPasswords/{id} path allows you to remove an encryption password that has the specified id.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the encryption password.


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


 
Responses 
204
Password has been removed.


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/encryptionPasswords/{id}
Request samples 
Response samples 
application/json
{ }