Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

File Shares

The /fileShares resource collection represents Azure file shares that reside in Azure regions selected in backup policy settings and can be protected by Veeam Backup for Microsoft Azure.

Get File Share Data

The HTTP GET request to the /fileShares/{id} endpoint retrieves information on an Azure file share with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string

Specifies the internal ID assigned in the Veeam Backup for Microsoft Azure REST API to the file share.

query Parameters
sync
boolean or null

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

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/fileShares/{id}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/fileShares/{id}?sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "azureId": "string",
  • "name": "string",
  • "accessTier": "string",
  • "regionId": "string",
  • "regionName": "string",
  • "storageAccountName": "string",
  • "resourceGroupName": "string",
  • "size": 0,
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "tenantId": "string",
  • "_links": {}
}

Get Collection of File Shares

The HTTP GET request to the /fileShares collection retrieves a list of Azure file shares created in Microsoft Azure environment and available for 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
RegionIds
Array of strings or null

Returns only file shares that reside in Azure regions with the specified IDs.

x-veeam-parameter-group: FileShareOptions
SearchPattern
string or null

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

x-veeam-parameter-group: FileShareOptions
SubscriptionId
string or null <uuid>

Returns only file shares available in a subscription with the specified ID.

x-veeam-parameter-group: FileShareOptions
TenantId
string or null <uuid>

Returns only file shares available for a tenant with the specified ID.

x-veeam-parameter-group: FileShareOptions
ServiceAccountId
string

Returns only file shares to which a service account ith the specified ID has access.

x-veeam-parameter-group: FileShareOptions
FileShareFromProtectedRegions
boolean

Defines whether Veeam Backup for Microsoft Azure must return only file shares that reside in regions protected by backup policies.

x-veeam-parameter-group: FileShareOptions
ProtectionStatus
Array of strings or null (ProtectionStatus)

Returns only file shares with the specified protection status.

Enum: "Unprotected" "Protected" "Unknown"
x-veeam-parameter-group: FileShareOptions
BackupDestination
Array of strings or null (FileShareBackupDestinationFilterOptions)
Enum: "Snapshot" "ManualSnapshot" "ImportedSnapshot"
x-veeam-parameter-group: FileShareOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/fileShares
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/fileShares?Offset=0&Limit=-1&RegionIds=string&SearchPattern=string&SubscriptionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&TenantId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ServiceAccountId=string&FileShareFromProtectedRegions=true&ProtectionStatus=Unprotected&BackupDestination=Snapshot' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Export Collection of File Shares

The HTTP POST request to the /fileShares/export endpoint exports a list of Azure file shares 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 the system IDs assigned in the Veeam Backup for Microsoft Azure REST API to the Azure file shares whose data will be exported.

regionIds
Array of strings or null

Returns only file shares that reside in Azure regions with the specified IDs.

searchPattern
string or null

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

subscriptionId
string or null <uuid>

Returns only file shares available in a subscription with the specified ID.

tenantId
string or null <uuid>

Returns only file shares available for a tenant with the specified ID.

serviceAccountId
string or null

Returns only file shares to which a service account ith the specified ID has access.

fileShareFromProtectedRegions
boolean

Defines whether Veeam Backup for Microsoft Azure must return only file shares that reside in regions protected by backup policies.

protectionStatus
Array of strings or null (ProtectionStatus)

Returns only file shares with the specified protection status.

Enum: "Unprotected" "Protected" "Unknown"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/v8/fileShares/export
Request samples
application/json
{
  • "fileShareIds": [
    ],
  • "regionIds": [
    ],
  • "searchPattern": "string",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "serviceAccountId": "string",
  • "fileShareFromProtectedRegions": true,
  • "protectionStatus": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Azure Files Rescan

The HTTP POST request to the /fileShares/rescan endpoint launches a rescan operation for Azure file shares in the Microsoft Azure environment.

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
RegionIds
Array of strings or null

Returns only file shares that reside in Azure regions with the specified IDs.

x-veeam-parameter-group: FileShareOptions
SearchPattern
string or null

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

x-veeam-parameter-group: FileShareOptions
SubscriptionId
string or null <uuid>

Returns only file shares available in a subscription with the specified ID.

x-veeam-parameter-group: FileShareOptions
TenantId
string or null <uuid>

Returns only file shares available for a tenant with the specified ID.

x-veeam-parameter-group: FileShareOptions
ServiceAccountId
string

Returns only file shares to which a service account ith the specified ID has access.

x-veeam-parameter-group: FileShareOptions
FileShareFromProtectedRegions
boolean

Defines whether Veeam Backup for Microsoft Azure must return only file shares that reside in regions protected by backup policies.

x-veeam-parameter-group: FileShareOptions
ProtectionStatus
Array of strings or null (ProtectionStatus)

Returns only file shares with the specified protection status.

Enum: "Unprotected" "Protected" "Unknown"
x-veeam-parameter-group: FileShareOptions
BackupDestination
Array of strings or null (FileShareBackupDestinationFilterOptions)
Enum: "Snapshot" "ManualSnapshot" "ImportedSnapshot"
x-veeam-parameter-group: FileShareOptions
Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v8/fileShares/rescan
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/fileShares/rescan?Offset=0&Limit=-1&RegionIds=string&SearchPattern=string&SubscriptionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&TenantId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ServiceAccountId=string&FileShareFromProtectedRegions=true&ProtectionStatus=Unprotected&BackupDestination=Snapshot' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "Canceled",
  • "error": {
    },
  • "_links": {},
  • "result": {
    }
}

Create Snapshots of File Shares

The HTTP POST request to the /fileShares/takeSnapshot endpoint create snapshots of the specified Azure file shares.

SecurityBearer
Request
Request Body schema: application/json
required
fileShareIds
required
Array of strings non-empty

Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to the Azure file shares whose snapshots will be created.

tenantId
required
string <uuid>

Specifies a Microsoft Azure ID assigned to a tenant where snapshots will be created.

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 create snapshots of Azure file shares.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/fileShares/takeSnapshot
Request samples
application/json
{
  • "fileShareIds": [
    ],
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c"
}
Response samples
application/json
[
  • {
    }
]