Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

SQL Databases Protected by Veeam Backup for Microsoft Azure

The /protectedItem/sql resource collection represents SQL databases protected by Veeam Backup for Microsoft Azure.

Get Collection of Protected SQL Databases

The HTTP GET request to the /protectedItem/sql endpoint retrieves a list of SQL databases protected by Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
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
SearchPattern
string or null

Returns only those items of a resource collection that match the specified search pattern in the parameter value.

x-veeam-parameter-group: ProtectedDatabaseOptions
ServerId
string or null

Returns only databases hosted on a SQL Server with the specified ID.

x-veeam-parameter-group: ProtectedDatabaseOptions
DatabaseIds
Array of strings or null

Returns only databases with the specified IDs.

x-veeam-parameter-group: ProtectedDatabaseOptions
Sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

x-veeam-parameter-group: ProtectedDatabaseOptions
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/protectedItem/sql
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/protectedItem/sql?Offset=0&Limit=-1&SearchPattern=string&ServerId=string&DatabaseIds=string&Sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Protected SQL Database Data

The HTTP GET request to the /protectedItem/sql/{databaseId} endpoint retrieves information on a protected SQL database with the specified ID.

SecurityBearer
Request
path Parameters
databaseId
required
string or null

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

x-position: 1
query Parameters
sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

x-position: 2
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/protectedItem/sql/{databaseId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/protectedItem/sql/{databaseId}?sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "azureId": "string",
  • "name": "string",
  • "sqlServer": {
    },
  • "azureEnvironment": "Global",
  • "sizeInMb": 0,
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "sqlElasticPool": "string",
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "subscription": {
    },
  • "region": {
    },
  • "resourceGroup": {
    },
  • "_links": {}
}

Export Collection of Protected SQL Databases

The HTTP POST request to the /protectedItem/sql/export endpoint exports a list of SQL databases protected by Veeam Backup for Microsoft Azure to a .CSV or an .XML file.

x-veeam-custom-response: true
SecurityBearer
Request
header Parameters
Accept
string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json
databaseIds
Array of strings or null

Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to the Azure SQL databases whose data will be exported.

searchPattern
string or null

Exports only data on those items of a resource collection that match the specified search pattern in the parameter value.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/v8/protectedItem/sql/export
Request samples
application/json
{
  • "databaseIds": [
    ],
  • "searchPattern": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Remove Backups of Protected SQL Database

The HTTP POST request to the /protectedItem/sql/{databaseId}/deleteBackups endpoint deletes backups created for a SQL database with the specified ID.

SecurityBearer
Request
path Parameters
databaseId
required
string or null

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

query Parameters
BackupTier
string (ProtectedDataBackupTier)

Defines whether you want to delete Archive, Standard (NonArchive) or All backups created for the specified Azure resources. By default, Veeam Backup for Microsoft Azure deletes all backups.

Enum: "NonArchive" "Archive" "Unknown" "All"
x-veeam-parameter-group: ProtectedDataDeleteOptions
Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/sql/{databaseId}/deleteBackups
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/protectedItem/sql/{databaseId}/deleteBackups?BackupTier=NonArchive' \
  -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": {}
}

Remove Manual Backups of Protected SQL Database

The HTTP POST request to the /protectedItem/sql/{databaseId}/deleteManualBackups endpoint deletes backups created manually for a SQL database with the specified ID.

SecurityBearer
Request
path Parameters
databaseId
required
string or null

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

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/sql/{databaseId}/deleteManualBackups
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/protectedItem/sql/{databaseId}/deleteManualBackups' \
  -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": {}
}