Veeam Backup & Replication 13
REST API Reference
Related documents

Configuration Backup

The Configuration Backup section defines paths and operations for managing backup of the configuration database that Veeam Backup & Replication uses.

Get Configuration Backup

The HTTP GET request to the /api/v1/configBackup path allows you to get configuration backup of the backup server.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-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/configBackup
Request samples 
Response samples 
application/json
{
  • "isEnabled": true,
  • "backupRepositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07",
  • "restorePointsToKeep": 10,
  • "notifications": {
    },
  • "schedule": {
    },
  • "lastSuccessfulBackup": {
    },
  • "encryption": {
    }
}
Edit Configuration Backup
The HTTP PUT request to the /api/v1/configBackup path allows you to edit configuration backup of the backup server.
Available to: Veeam Backup Administrator.


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


 
Request Body schema: application/json
required
isEnabled
required
boolean
If true, configuration backup is enabled.


 
backupRepositoryId
required
string <uuid> 
ID of the backup repository on which the configuration backup is stored.


 
restorePointsToKeep
required
integer <int32> 
Number of restore points to keep in the backup repository.


 
required
object (ConfigBackupNotificationsModel) 
Notification settings.


 
required
object (ConfigBackupScheduleModel) 
Scheduling settings.


 
required
object (ConfigBackupLastSuccessfulModel) 
Last successful backup.


 
required
object (ConfigBackupEncryptionModel) 
Encryption settings.


 
Responses 
200
Configuration backup settings have 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/configBackup
Request samples 
application/json
{
  • "isEnabled": true,
  • "backupRepositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07",
  • "restorePointsToKeep": 10,
  • "notifications": {
    },
  • "schedule": {
    },
  • "lastSuccessfulBackup": {
    },
  • "encryption": {
    }
}
Response samples 
application/json
{
  • "isEnabled": true,
  • "backupRepositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07",
  • "restorePointsToKeep": 10,
  • "notifications": {
    },
  • "schedule": {
    },
  • "lastSuccessfulBackup": {
    },
  • "encryption": {
    }
}
Start Configuration Backup
The HTTP POST request to the /api/v1/configBackup/backup path allows you to start a configuration backup.
Available to: Veeam Backup Administrator, Veeam Backup Operator.


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


 
Responses 
200
Configuration backup has been started.


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/configBackup/backup
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Starting",
  • "id": "d20f79d1-962d-4cb1-809b-0364c5b90696",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2024-01-26T17:13:29.097+01:00",
  • "endTime": null,
  • "progressPercent": 0,
  • "result": null,
  • "resourceId": null,
  • "resourceReference": null,
  • "parentSessionId": null,
  • "usn": 0
}