Veeam Backup & Replication 13
REST API Reference
Related documents

Service

The Service section defines operations for retrieving information about the backup server where the REST API service is running.

Get Backup Server Time

The HTTP GET request to the /api/v1/serverTime endpoint gets the current date and time on the backup server.

Available to: Anyone.

Request
header Parameters
x-api-version
required
string
Default: 1.3-rev2

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

Responses
200

OK

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/serverTime
Request samples 
Response samples 
application/json
{
  • "serverTime": "2024-01-25T18:31:50.7300443+01:00",
  • "timeZone": "(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague",
  • "ianaTimeZoneId": "Europe/Prague"
}
Get Backup Server Certificate
The HTTP GET request to the /api/v1/serverCertificate endpoint gets a certificate of the backup server.
Available to: Anyone.


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


 
Responses 
200
OK


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/serverCertificate
Request samples 
Response samples 
application/json
{
  • "thumbprint": "86F1769B6E0544E16A6EA1E9E9BC0BB71A8DE900",
  • "serialNumber": "7EA755F585E9A717",
  • "keyAlgorithm": "RSA",
  • "keySize": "2048",
  • "subject": "CN=vbr13linupdate",
  • "issuedTo": "vbr13linupdate",
  • "issuedBy": "vbr13linupdate",
  • "validFrom": "2025-07-01T16:22:07+02:00",
  • "validBy": "2035-07-01T16:22:07+02:00",
  • "isTrusted": false
}
Get Backup Server Information
The HTTP GET request to the /api/v1/serverInfo endpoint returns the Veeam Backup & Replication installation ID, backup server name (or IP address), build number, and cumulative patches installed on the backup server.
Available to: Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-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/serverInfo
Request samples 
Response samples 
application/json
{
  • "platform": "Linux",
  • "vbrId": "f2ef2bfd-e8e6-418a-8725-472e2e2d1efc",
  • "name": "srv88.tech.local",
  • "buildVersion": "13.0.0.4883",
  • "patches": [ ],
  • "databaseVendor": "PostgreSQL",
  • "sqlServerEdition": "",
  • "sqlServerVersion": "PostgreSQL 17.5 on x86_64-pc-linux-gnu, compiled by gcc (GCC) 11.5.0 20240719 (Red Hat 11.5.0-5), 64-bit",
  • "databaseSchemaVersion": "9688",
  • "databaseContentVersion": "9688",
  • "veeamRegistration": {
    }
}
Register Backup Server on My Account Portal
The HTTP POST request to the /api/v1/registerVbr endpoint registers the backup server on the My Account portal. 
Available to: Backup Administrator.


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


 
Request Body schema: application/json
required
grant_type
required
string (ELoginGrantType) 
 Default:  "Password"
Authorization grant type.
Available values:
     
  • password — used to obtain an access token by providing a user name and password.
    •  
  • refresh_token — used to refresh an expired or lost access token by providing a refresh token.
    •  
  • authorization_code — used to obtain an access token by providing an authorization code.
    •  
  • vbr_token — used to obtain an access token by providing a Veeam Backup & Replication token. This grant type is only used in a restricted mode for integration with Veeam Backup & Replication.


 Enum: "Password" "Refresh_token" "Authorization_code" "Vbr_token"  
code
string
Authorization code. Required if the grant_type value is authorization_code.


 
codeVerifier
string
Verifier code. Required if the grant_type value is authorization_code.


 
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.


post/api/v1/registerVbr
Request samples 
application/json
{
  • "grant_type": "Password",
  • "code": "9f8b6c2a-1d3e-4f5a-8b7c-0a1b2c3d4e5f",
  • "codeVerifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
}
Response samples 
application/json
{
  • "platform": "Linux",
  • "vbrId": "f2ef2bfd-e8e6-418a-8725-472e2e2d1efc",
  • "name": "srv88.tech.local",
  • "buildVersion": "13.0.0.4883",
  • "patches": [ ],
  • "databaseVendor": "PostgreSQL",
  • "sqlServerEdition": "",
  • "sqlServerVersion": "PostgreSQL 17.5 on x86_64-pc-linux-gnu, compiled by gcc (GCC) 11.5.0 20240719 (Red Hat 11.5.0-5), 64-bit",
  • "databaseSchemaVersion": "9688",
  • "databaseContentVersion": "9688",
  • "veeamRegistration": {
    }
}