Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

File Shares Protected by Veeam Backup for Microsoft Azure

The /protectedItem/fileShares resource collection represents Azure file shares protected by Veeam Backup for Microsoft Azure.

Get Collection of Protected File Shares

The HTTP GET request to the /protectedItem/fileShares endpoint retrieves a list of Azure file shares 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: ProtectedFileShareOptions
Sync
boolean or null

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

x-veeam-parameter-group: ProtectedFileShareOptions
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

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

Get Protected File Share Data

The HTTP GET request to the /protectedItem/fileShares/{fileShareId} endpoint retrieves information on a protected Azure file share with the specified ID.

SecurityBearer
Request
path Parameters
fileShareId
required
string or null

Specifies a system ID assigned to a file share 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/fileShares/{fileShareId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/protectedItem/fileShares/{fileShareId}?sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "azureId": "string",
  • "name": "string",
  • "storageAccount": {
    },
  • "azureEnvironment": "Global",
  • "regionName": "string",
  • "sizeInMb": 0,
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "subscription": {
    },
  • "region": {
    },
  • "resourceGroup": {
    },
  • "_links": {}
}

Export Collection of Protected File Shares

The HTTP POST request to the /protectedItem/fileShares/export endpoint exports a list of Azure file shares 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
fileShareIds
Array of strings or null

Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to the Azure file shares 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/fileShares/export
Request samples
application/json
{
  • "fileShareIds": [
    ],
  • "searchPattern": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Remove Snapshots of Protected File Shares

The HTTP POST request to the /protectedItem/fileShares/deleteSnapshots endpoint deletes snapshots created for Azure file shares with the specified IDs.

SecurityBearer
Request
Request Body schema: application/json
required
ids
required
Array of strings

Specifies a comma-separated list of internal IDs assigned in the Veeam Backup for Microsoft Azure REST API to Azure FileShares whose snapshots will be removed.

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/fileShares/deleteSnapshots
Request samples
application/json
{
  • "ids": [
    ]
}
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 Snapshots of Protected File Shares

The HTTP POST request to the /protectedItem/fileShares/deleteManualSnapshots endpoint deletes snapshots created manually for Azure file shares with the specified IDs.

SecurityBearer
Request
Request Body schema: application/json
required
ids
required
Array of strings

Specifies a comma-separated list of internal IDs assigned in the Veeam Backup for Microsoft Azure REST API to Azure FileShares whose snapshots will be removed.

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/fileShares/deleteManualSnapshots
Request samples
application/json
{
  • "ids": [
    ]
}
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": {}
}