Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

SQL Restore Points

The /restorePoints/sql resource collection represents restore points of Azure SQL databases available for Veeam Backup for Microsoft Azure.

Get SQL Database Restore Points

The HTTP GET request to the /restorePoints/sql endpoint retrieves a list of restore points created for SQL databases by Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
DatabaseId
string or null

Returns only restore points of a SQL database with the specified ID.

x-veeam-parameter-group: SqlRestorePointSearchOptions
OnlyLatest
boolean

Defines whether to return only recently created restore points.

x-veeam-parameter-group: SqlRestorePointSearchOptions
DataRetrievalStatuses
Array of strings or null (DataRetrievalStatus)

Returns only restore points with the specified data retrieval status.

Enum: "None" "Retrieving" "Retrieved" "Unknown"
x-veeam-parameter-group: SqlRestorePointSearchOptions
PointInTime
string or null <date-time>

Returns only restore points created on the specified date and time.

x-veeam-parameter-group: SqlRestorePointSearchOptions
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
StorageAccessTier
Array of strings or null or null (StorageAccessTier)

Returns only restore points stored in repositories with the specified access tier.

Enum: "Hot" "Cool" "Archive" "Inferred" "Cold"
x-veeam-parameter-group: SqlRestorePointSearchOptions
ImmutabilityEnabled
boolean

Returns only restore points with the specified immutability.

x-veeam-parameter-group: SqlRestorePointSearchOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/restorePoints/sql
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/sql?DatabaseId=string&OnlyLatest=true&DataRetrievalStatuses=None&PointInTime=2019-08-24T14%3A15%3A22Z&Offset=0&Limit=-1&StorageAccessTier=Hot&ImmutabilityEnabled=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get SQL Database Restore Point Data

The HTTP GET request to the /restorePoints/sql/{restorePointId} endpoint retrieves information on a specific restore point of a SQL 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/restorePoints/sql/{restorePointId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/sql/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Full",
  • "databaseId": "string",
  • "databaseName": "string",
  • "sqlServerId": "string",
  • "sqlServerName": "string",
  • "vbrId": "string",
  • "pointInTime": "2019-08-24T14:15:22Z",
  • "backupSizeBytes": 0,
  • "isCorrupted": true,
  • "gfsFlags": "string",
  • "jobSessionId": "string",
  • "backupDestination": "AzureBlob",
  • "dataRetrievalStatus": "None",
  • "retrievedDataExpirationDate": "2019-08-24T14:15:22Z",
  • "notifyBeforeRetrievedDataExpirationHours": 0,
  • "immutableTill": "2019-08-24T14:15:22Z",
  • "accessTier": "Hot",
  • "latestChainSizeBytes": 0,
  • "_links": {}
}

Remove SQL Database Restore Point

The HTTP DELETE request to the /restorePoints/sql/{restorePointId} endpoint removes a specific restore point of a SQL database from 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/restorePoints/sql/{restorePointId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/restorePoints/sql/{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": {}
}

Perform SQL Database Restore

The HTTP POST request to the /restorePoints/sql/{restorePointId}/restoreDb endpoint launches a SQL database restore operation using a specific restore point.

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.

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

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions will be used to perform the restore operation.

sqlAccountId
required
string non-empty

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

object or null (DatabaseNewLocationOptions)

Specifies information on a new restore target location.

reason
string or null

Specifies a reason for the restore operation.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

415

Client Error

post/api/v8/restorePoints/sql/{restorePointId}/restoreDb
Request samples
application/json
{
  • "newLocation": {
    },
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "reason": "string",
  • "sqlAccountId": "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": {}
}

Retrieve Data from Archive

The HTTP POST request to the /restorePoints/sql/{restorePointId}/retrieveData endpoint retrieves data of an archived restore point with the specified ID.

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.

Request Body schema: application/json
required
dataRetrievalPriority
required
string (DataRetrievalPriority)

Specifies the priority type for the data retrieval operation.

Enum: "Normal" "High" "Unknown"
daysToKeep
integer <int32> [ 1 .. 30 ]

Specifies the number of days for which the retrieved data will be kept.

notifyBeforeExpirationHours
integer or null <int32>

Specifies the time when a notification will be sent (in hours remaining until the expiration).

notifyAfterComplete
boolean or null

Defines whether a notification must be sent after the operation is complete.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

415

Client Error

post/api/v8/restorePoints/sql/{restorePointId}/retrieveData
Request samples
application/json
{
  • "dataRetrievalPriority": "Normal",
  • "daysToKeep": 1,
  • "notifyBeforeExpirationHours": 0,
  • "notifyAfterComplete": 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": {}
}

Extend Data Availability Period

The HTTP POST request to the /restorePoints/virtualMachines/{restorePointId}/extendRetrievedDataAvailability endpoint extends the data availability period of a retrieved restore point with the specified ID.

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.

Request Body schema: application/json
required
numberOfDays
integer <int32> [ 1 .. 30 ]

Specifies the number of days for which the data availability period will be extended.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/restorePoints/sql/{restorePointId}/extendRetrievedDataAvailability
Request samples
application/json
{
  • "numberOfDays": 1
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}