Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

File Share Restore Points

The /restorePoints/fileShares resource collection represents restore points of Azure file shares available in Veeam Backup for Microsoft Azure.

Get File Share Restore Points

The HTTP GET request to the /restorePoints/fileShares endpoint retrieves a list of restore points created for Azure file shares and available for Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
FileShareId
string or null

Returns only restore points of an Azure file share with the specified ID.

x-veeam-parameter-group: FileShareRestorePointSearchOptions
OnlyLatest
boolean

Defines whether to return only recently created restore points.

x-veeam-parameter-group: FileShareRestorePointSearchOptions
PointInTime
string or null <date-time>

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

x-veeam-parameter-group: FileShareRestorePointSearchOptions
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/restorePoints/fileShares
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/fileShares?FileShareId=string&OnlyLatest=true&PointInTime=2019-08-24T14%3A15%3A22Z&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get File Share Restore Point Data

The HTTP GET request to the /restorePoints/fileShares/{restorePointId} endpoint retrieves information on a specific restore point of an Azure file share.

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/fileShares/{restorePointId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/restorePoints/fileShares/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Full",
  • "indexed": true,
  • "fileShareId": "string",
  • "fileShareName": "string",
  • "regionId": "string",
  • "regionName": "string",
  • "pointInTime": "2019-08-24T14:15:22Z",
  • "gfsFlags": "string",
  • "jobSessionId": "string",
  • "backupDestination": "Snapshot",
  • "sizeInBytes": 0,
  • "isCorrupted": true,
  • "_links": {}
}

Remove File Share Restore Point

The HTTP DELETE request to the /restorePoints/fileShares/{restorePointId} endpoint removes a specific restore point of an Azure file share 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

delete/api/v8/restorePoints/fileShares/{restorePointId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/restorePoints/fileShares/{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 File Share File-Level Restore

The HTTP POST request to the /restorePoints/fileShares/{restorePointId}/restoreFile endpoint launches a file-level restore operation using a specific restore point of an Azure file share.

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
reason
string or null

Specifies a reason for performing the restore operation.

targetFileShareId
string or null

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to an Azure file share to which files and folders must be restored.

serviceAccountId
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure to a service account whose permissions will be used to access the target file share.

sourceServiceAccountId
string or null

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

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/restorePoints/fileShares/{restorePointId}/restoreFile
Request samples
application/json
{
  • "reason": "string",
  • "targetFileShareId": "string",
  • "serviceAccountId": "string",
  • "sourceServiceAccountId": "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": {}
}

Perform File Share Restore Point Indexing

The HTTP POST request to the /restorePoints/fileShares/startIndexing endpoint allows you to instruct Veeam Backup for Microsoft Azure to perform indexing for the restore points with the specified IDs.

SecurityBearer
Request
Request Body schema: application/json
required
restorePointIds
required
Array of strings [ 1 .. 1000 ] items

Specifies a comma-separated list of system IDs assigned in the Veeam Backup for Microsoft Azure REST API to restore points for which indexing will be performed.

serviceAccountId
string

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 indexing.

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/restorePoints/fileShares/startIndexing
Request samples
application/json
{
  • "restorePointIds": [
    ],
  • "serviceAccountId": "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": {}
}