Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Backup Repositories

The /repositories resource collection represents backup repositories added to the Veeam Backup for Microsoft Azure configuration database.

Get Collection of Backup Repositories

The HTTP GET request to the /repositories endpoint retrieves a list of backup repositories added to the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
query Parameters
Status
Array of strings or null (RepositoryStatus)

Returns only backup repositories with the specified status.

Enum: "Creating" "Importing" "Ready" "Failed" "Unknown" "ReadOnly"
x-veeam-parameter-group: RepositoryOptions
x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.REST.Latest.RepositoryStatus>
Tier
Array of strings or null (StorageTier)

Returns only backup repositories of the specified tier.

Enum: "Inferred" "Hot" "Cool" "Archive" "Unknown" "Cold"
x-veeam-parameter-group: RepositoryOptions
x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.REST.Latest.StorageTier>
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: RepositoryOptions
IsEncrypted
boolean or null

Returns only backup repositories with enabled encryption.

x-veeam-parameter-group: RepositoryOptions
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
TenantId
string or null <uuid>

Returns only backup repositories created in a tenant with the specified ID.

x-veeam-parameter-group: RepositoryKeyVaultExpansionOptions
ServiceAccountId
string

Returns only backup repositories to which a service account with the specified ID has permissions.

x-veeam-parameter-group: RepositoryKeyVaultExpansionOptions
ImmutabilityEnabled
boolean or null

Defines whether to return only repositories for which the immutability is enabled.

x-veeam-parameter-group: RepositoryOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

409

Conflict

get/api/v8/repositories
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/repositories?Status=Creating&Tier=Inferred&SearchPattern=string&IsEncrypted=true&Offset=0&Limit=-1&TenantId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ServiceAccountId=string&ImmutabilityEnabled=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Add Backup Repository

The HTTP POST request to the /repositories endpoint adds a new repository to the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
Request Body schema: application/json
required
azureAccountId
required
string non-empty

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a repository or service account whose permissions were used to create the repository.

azureStorageAccountId
required
string non-empty

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a storage account where a target blob container resides.

azureStorageContainer
required
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the blob container that will be used as a target location for backups of Azure resources.

azureStorageFolder
required
string

Specifies a name of the folder in the selected container that will be used to store backups.

keyVaultId
string or null

/[Applies if data stored in the repository must be encrypted using an Azure Key Vault cryptographic key/] Specifies the Microsoft Azure ID assigned to a Key Vault where a cryptographic key that will be used for repository encryption resides.

keyVaultKeyUri
string or null

/[Applies if data stored in the repository must be encrypted using an Azure Key Vault cryptographic key/] Specifies the URI of the cryptographic key.

storageTier
string or null (StorageTierNullable)

Specifies the access tier.

Enum: "Inferred" "Hot" "Cool" "Archive" "Unknown" "Cold"
x-external-type: Veeam.Azure.REST.Latest.StorageTier
concurrencyLimit
integer or null <int32> >= 1

Specifies the maximum number of concurrent connections from worker instances to the repository within a backup session.

importIfFolderHasBackup
boolean or null

Defines whether to import to the backup appliance backup files that are already stored in the specified folder.

autoCreateTiers
boolean or null

Defines whether to automatically create 3 separate repositories for Hot, Cool and Archive access tiers.

name
string or null

Specifies a name for the repository.

description
string or null

Specifies a description for the repository.

enableEncryption
boolean

Defines whether the encryption must be enabled for backup files stored in the repository.

password
string or null

/[Applies if data stored in the repository must be encrypted using a password/] Specifies a password that will be used for repository encryption.

hint
string or null

Specifies a hint to the password.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

415

Client Error

post/api/v8/repositories
Request samples
application/json
{
  • "keyVaultId": "string",
  • "keyVaultKeyUri": "string",
  • "azureStorageAccountId": "string",
  • "azureStorageFolder": "string",
  • "azureStorageContainer": "string",
  • "azureAccountId": "string",
  • "storageTier": "Inferred",
  • "concurrencyLimit": 1,
  • "importIfFolderHasBackup": true,
  • "autoCreateTiers": true,
  • "name": "string",
  • "description": "string",
  • "enableEncryption": true,
  • "password": "string",
  • "hint": "string"
}
Response samples
application/json
[
  • {
    }
]

Get Backup Repository Data

The HTTP GET request to the /repositories/{repositoryId} endpoint retrieves information on a backup repository with the specified ID.

SecurityBearer
Request
path Parameters
repositoryId
required
string

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

query Parameters
TenantId
string or null <uuid>

Specifies the Microsoft Azure ID assigned to a tenant for which the backup policy is created.

x-veeam-parameter-group: RepositoryKeyVaultExpansionOptions
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 access Microsoft Azure resources.

x-veeam-parameter-group: RepositoryKeyVaultExpansionOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

get/api/v8/repositories/{repositoryId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/repositories/{repositoryId}?TenantId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ServiceAccountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "azureStorageAccountId": "string",
  • "azureStorageAccountName": "string",
  • "azureStorageFolder": {
    },
  • "azureStorageContainer": {
    },
  • "enableEncryption": true,
  • "hint": "string",
  • "regionId": "string",
  • "regionName": "string",
  • "azureAccountId": "string",
  • "environment": "Global",
  • "status": "Creating",
  • "storageTier": "Inferred",
  • "isStorageTierInferred": true,
  • "immutabilityEnabled": true,
  • "repositoryOwnership": {
    },
  • "concurrencyLimit": 1,
  • "_links": {}
}

Modify Backup Repository Settings

The HTTP PUT request to the /repositories/{repositoryId} endpoint updates settings of a backup repository with the specified ID.

SecurityBearer
Request
path Parameters
repositoryId
required
string

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

Request Body schema: application/json
required
keyVaultId
string or null

[Applies if data stored in the repository must be encrypted using an Azure Key Vault cryptographic key] Specifies the Microsoft Azure ID assigned to a Key Vault where a cryptographic key that will be used for repository encryption resides.

keyVaultKeyUri
string or null

[Applies if data stored in the repository must be encrypted using an Azure Key Vault cryptographic key] Specifies the URI of the cryptographic key.

name
string or null

Specifies the repository name.

description
string or null

Specifies the repository description.

azureAccountId
string or null non-empty
concurrencyLimit
integer or null <int32> >= 1

Specifies the maximum number of concurrent connections from worker instances to the repository within a backup session.

enableEncryption
boolean

Defines whether to enable encryption for the repository.

password
string or null

[Applies if data stored in the repository must be encrypted using a password] Specifies a password to be used for repository encryption.

hint
string or null

Specifies a hint for the password.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

415

Client Error

429

Client Error

put/api/v8/repositories/{repositoryId}
Request samples
application/json
{
  • "keyVaultId": "string",
  • "keyVaultKeyUri": "string",
  • "name": "string",
  • "description": "string",
  • "azureAccountId": "string",
  • "concurrencyLimit": 1,
  • "enableEncryption": true,
  • "password": "string",
  • "hint": "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": {}
}

Remove Backup Repository

The HTTP DELETE request to the /repositories/{repositoryId} endpoint removes a backup repository with the specified ID from the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
path Parameters
repositoryId
required
string

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

Responses
202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

delete/api/v8/repositories/{repositoryId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/repositories/{repositoryId}' \
  -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": {}
}

Get Backup Repository Metadata

The HTTP POST request to the /repositories/settings/getMetadata endpoint retrieves metadata for a backup repository with the specified settings.

SecurityBearer
Request
Request Body schema: application/json
required
azureAccountId
required
string non-empty

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a repository or service account whose permissions were used to create the repository.

azureStorageAccountId
required
string non-empty

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a storage account where a target blob container resides.

azureStorageContainer
required
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the blob container that will be used as a target location for backups of Azure resources.

azureStorageFolder
required
string

Specifies a name of the folder in the selected container that will be used to store backups.

keyVaultId
string or null

/[Applies if data stored in the repository must be encrypted using an Azure Key Vault cryptographic key/] Specifies the Microsoft Azure ID assigned to a Key Vault where a cryptographic key that will be used for repository encryption resides.

keyVaultKeyUri
string or null

/[Applies if data stored in the repository must be encrypted using an Azure Key Vault cryptographic key/] Specifies the URI of the cryptographic key.

storageTier
string or null (StorageTierNullable)

Specifies the access tier.

Enum: "Inferred" "Hot" "Cool" "Archive" "Unknown" "Cold"
x-external-type: Veeam.Azure.REST.Latest.StorageTier
concurrencyLimit
integer or null <int32> >= 1

Specifies the maximum number of concurrent connections from worker instances to the repository within a backup session.

importIfFolderHasBackup
boolean or null

Defines whether to import to the backup appliance backup files that are already stored in the specified folder.

autoCreateTiers
boolean or null

Defines whether to automatically create 3 separate repositories for Hot, Cool and Archive access tiers.

name
string or null

Specifies a name for the repository.

description
string or null

Specifies a description for the repository.

enableEncryption
boolean

Defines whether the encryption must be enabled for backup files stored in the repository.

password
string or null

/[Applies if data stored in the repository must be encrypted using a password/] Specifies a password that will be used for repository encryption.

hint
string or null

Specifies a hint to the password.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

415

Client Error

post/api/v8/repositories/settings/getMetadata
Request samples
application/json
{
  • "keyVaultId": "string",
  • "keyVaultKeyUri": "string",
  • "azureStorageAccountId": "string",
  • "azureStorageFolder": "string",
  • "azureStorageContainer": "string",
  • "azureAccountId": "string",
  • "storageTier": "Inferred",
  • "concurrencyLimit": 1,
  • "importIfFolderHasBackup": true,
  • "autoCreateTiers": true,
  • "name": "string",
  • "description": "string",
  • "enableEncryption": true,
  • "password": "string",
  • "hint": "string"
}
Response samples
application/json
{
  • "repositoryExists": true,
  • "storageTier": "Inferred",
  • "isEncrypted": true,
  • "encryptionMethod": "Unknown",
  • "hint": "string",
  • "keyVaultId": "string",
  • "keyName": "string",
  • "keyUri": "string",
  • "keyVaultName": "string",
  • "keyVersion": "string",
  • "immutability": "Unknown"
}

Verify Backup Repository Password

The HTTP POST request to the /repositories/{repositoryId}/checkPassword endpoint verifies if a password used to encrypt a specific backup repository is valid.

SecurityBearer
Request
path Parameters
repositoryId
required
string or null

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

Request Body schema: application/json
string or null

Specifies a password used for repository encryption.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

415

Client Error

429

Client Error

post/api/v8/repositories/{repositoryId}/checkPassword
Request samples
application/json
"string"
Response samples
application/json
true

Export Collection of Backup Repositories

The HTTP POST request to the /repositories/export endpoint exports a list of backup repositories added to 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
status
Array of strings or null (RepositoryStatus)

Returns only backup repositories with the specified status.

Enum: "Creating" "Importing" "Ready" "Failed" "Unknown" "ReadOnly"
x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.REST.Latest.RepositoryStatus>
tier
Array of strings or null (StorageTier)

Returns only backup repositories of the specified tier.

Enum: "Inferred" "Hot" "Cool" "Archive" "Unknown" "Cold"
x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.REST.Latest.StorageTier>
searchPattern
string or null

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

isEncrypted
boolean or null

Returns only backup repositories with enabled encryption.

immutabilityEnabled
boolean or null

Defines whether to return only repositories for which the immutability is enabled.

repositoryIds
Array of strings or null <uuid>
Responses
200

OK

401

Unauthorized

post/api/v8/repositories/export
Request samples
application/json
{
  • "status": [
    ],
  • "tier": [
    ],
  • "searchPattern": "string",
  • "isEncrypted": true,
  • "immutabilityEnabled": true,
  • "repositoryIds": [
    ]
}
Response samples

Validate Repository Deletion

The HTTP GET request to the /repositories/validateDelete endpoint validates whether the specified backup repositories are not used by any backup policies or storage templates and can be deleted from Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
RepositoryId
Array of strings <uuid>

Returns only backup repositories with the specified IDs.

x-veeam-parameter-group: RepositoryValidateDeleteOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

get/api/v8/repositories/validateDelete
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/repositories/validateDelete?RepositoryId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}