Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Configuration Backup

The /configurationBackup resource collection allows to back up the backup appliance.

Get Backup Appliance Statistics

The HTTP GET request to the /configurationBackup/stats endpoint retrieves statistics on Veeam Backup for Microsoft Azure entities currently present in the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/configurationBackup/stats
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/configurationBackup/stats \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "productInformation": {
    },
  • "standardRepositoryCount": 0,
  • "archiveRepositoryCount": 0,
  • "vmPolicyCount": 0,
  • "sqlPolicyCount": 0,
  • "fileSharePolicyCount": 0,
  • "cosmosDbPolicyCount": 0,
  • "protectionPolicyVmCount": 0,
  • "serviceAccountCount": 0,
  • "sessionCount": 0,
  • "size": 0
}

Create Configuration Backup

The HTTP POST request to the configurationBackup/backup endpoint creates a manual backup of the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
Request Body schema: application/json
required
repositoryId
string <uuid>

Specifies the system ID assigned in the Veeam backup for Microsoft Azure REST API to a backup repository where configuration backup files are stored.

notificationEmail
string or null

Specifies an email where a notification on the configuration backup creation will be sent.

shouldSendCompletionNotification
boolean or null

Defines whether a notification on the configuration backup creation will be sent.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v8/configurationBackup/backup
Request samples
application/json
{
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "notificationEmail": "string",
  • "shouldSendCompletionNotification": true
}
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Get Configuration Backup Settings

The HTTP GET request to the /configurationBackup/settings endpoint retrieves settings configured to perform backup of the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/configurationBackup/settings
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/configurationBackup/settings \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "isEnabled": true,
  • "scheduleOptions": {
    },
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "repositoryName": "string",
  • "retention": {
    },
  • "modifiedBy": "string",
  • "modificationTimeUtc": "2019-08-24T14:15:22Z",
  • "lastBackupSessionStartTimeUtc": "2019-08-24T14:15:22Z",
  • "lastBackupRestorePointId": "aa78e734-e3a5-4029-958a-5886d82914df",
  • "lastBackupSessionStatus": "NeverExecuted",
  • "vbrServerName": "string",
  • "vbrRepositoryName": "string",
  • "vbrRestorePointCount": 0
}

Modify Configuration Backup Settings

The HTTP PUT request to the /configurationBackup/settings endpoint changes settings configured to perform backup of the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
Request Body schema: application/json
required
isEnabled
required
boolean

Defines whether the configuration backup is enabled.

required
object (ConfigurationBackupSchedule)

Schedule for the backup policy.

repositoryId
string or null <uuid>

Specifies the system ID assigned in the Veeam backup for Microsoft Azure REST API to a backup repository where configuration backup files are stored.

object (RepositoryRetentionSettings)

Specifies period of time to keep restore points in a backup chain.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

put/api/v8/configurationBackup/settings
Request samples
application/json
{
  • "isEnabled": true,
  • "scheduleOptions": {
    },
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "retention": {
    }
}
Response samples
application/json
{
  • "isEnabled": true,
  • "scheduleOptions": {
    },
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "repositoryName": "string",
  • "retention": {
    },
  • "modifiedBy": "string",
  • "modificationTimeUtc": "2019-08-24T14:15:22Z",
  • "lastBackupSessionStartTimeUtc": "2019-08-24T14:15:22Z",
  • "lastBackupRestorePointId": "aa78e734-e3a5-4029-958a-5886d82914df",
  • "lastBackupSessionStatus": "NeverExecuted",
  • "vbrServerName": "string",
  • "vbrRepositoryName": "string",
  • "vbrRestorePointCount": 0
}

Start Configuration Backup Export

The HTTP POST request to the configurationBackup/export/start endpoint launches an export operation for a specific configuration backup file.

SecurityBearer
Request
Request Body schema: application/json
required
restorePointId
required
string <uuid>

System ID assigned in the Veeam backup for Microsoft Azure REST API to a restore point where the configuration backup file will be exported.

password
required
string non-empty

Specifies a password that will be used for configuration backup export.

passwordHint
string

Specifies a hint to the password.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v8/configurationBackup/export/start
Request samples
application/json
{
  • "restorePointId": "8c843d10-6d0f-4abe-b898-e1ba18b94f68",
  • "password": "string",
  • "passwordHint": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Check Status of Configuration Backup Export

The HTTP GET request to the configurationBackup/export/status/{sessionId} endpoint allows you to check whether the exported configuration backup file is ready for download.

SecurityBearer
Request
path Parameters
sessionId
required
string <uuid>

Specifies the system ID assigned to an export session in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/configurationBackup/export/status/{sessionId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/configurationBackup/export/status/{sessionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "isReadyToDownload": true
}

Download Configuration Backup File

The HTTP POST request to the configurationBackup/export/download endpoint allows a user to download the exported configuration backup file.

x-veeam-custom-response: true
SecurityBearer
Request
Request Body schema: application/json
required
sessionId
required
string <uuid>

System ID assigned in the Veeam backup for Microsoft Azure REST API to the configuration backup export session.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v8/configurationBackup/export/download
Request samples
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Get Configuration Backup Restore Points

The HTTP GET request to the /configurationBackup/restorePoints endpoint retrieves a list of restore points created for the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
query Parameters
RepositoryId
string or null <uuid>

Specifies the system ID assigned in the Veeam backup for Microsoft Azure REST API to a backup repository in which configuration backup files are stored.

x-veeam-parameter-group: ConfigurationRestorePointSearchOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/configurationBackup/restorePoints
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/configurationBackup/restorePoints?RepositoryId=497f6eca-6276-4993-bfeb-53cbbbba6f08&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Configuration Backup Restore Point Data

The HTTP GET request to the /configurationBackup/restorePoints/{restorePointId} endpoint retrieves information on a specific restore point created for the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/configurationBackup/restorePoints/{restorePointId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/configurationBackup/restorePoints/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "repositoryName": "string",
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "type": "Manual",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "ImmutableTill": "2019-08-24T14:15:22Z"
}

Remove Configuration Backup Restore Point

The HTTP DELETE request to the /configurationBackup/restorePoints/{restorePointId} endpoint deletes a specific restore point created for the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

423

Locked

delete/api/v8/configurationBackup/restorePoints/{restorePointId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/configurationBackup/restorePoints/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}