Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

SQL Backup Policies

The /policies/sql resource collection represents SQL backup policies configured in Veeam Backup for Microsoft Azure.

Get Collection of SQL Backup Policies

The HTTP GET request to the /policies/sql endpoint retrieves a list of SQL backup policies configured in Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
PolicyName
string or null

Returns a backup policy with the specified name.

x-veeam-parameter-group: SqlPolicyQueryOptions
DatabaseId
string or null

Returns only backup policies that protect an SQL database with the specified ID.

x-veeam-parameter-group: SqlPolicyQueryOptions
LastJobStatus
Array of strings or null (JobStatus)

Returns only backup policies with the specified status of the latest session.

Enum: "Canceled" "Canceling" "Error" "NeverExecuted" "Running" "RunningWithError" "RunningWithWarning" "Success" "Warning" "Pending" "Unknown"
x-veeam-parameter-group: SqlPolicyQueryOptions
x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.REST.Latest.JobStatus>
PolicyStatus
Array of strings or null (PolicyStatus)

Returns only backup policies with the specified status.

Enum: "Enabled" "Disabled" "Unknown"
x-veeam-parameter-group: SqlPolicyQueryOptions
x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.REST.Latest.PolicyStatus>
RepositoryId
string or null

Returns only backup policies that store backup files in a repository with the specified ID.

x-veeam-parameter-group: SqlPolicyQueryOptions
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/policies/sql
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policies/sql?PolicyName=string&DatabaseId=string&LastJobStatus=Canceled&PolicyStatus=Enabled&RepositoryId=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Create Backup Policy

The HTTP POST request to the /policies/sql endpoint creates a new SQL backup policy.

SecurityBearer
Request
Request Body schema: application/json
required
backupType
required
string or null (BackupTypeNullable)

Defines whether you want to include to the backup scope all resources residing in the specified Azure regions and to which the specified service account has access.

Enum: "AllSubscriptions" "SelectedItems" "Unknown"
x-external-type: Veeam.Azure.REST.Latest.BackupType
isEnabled
required
boolean or null

Defines whether to enable the policy.

name
required
string [ 1 .. 255 ] characters

Specifies a name for the backup policy.

required
Array of objects (PolicyRegionFromClient) non-empty

Azure regions where the resources that will be backed up reside.

tenantId
required
string

Specifies a Microsoft Azure ID assigned to a tenant with which the service account used to protect Azure resources is associated.

serviceAccountId
required
string <uuid>

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the service account whose permissions will be used to perform backups of Azure SQL databases.

object or null (SqlPolicyBackupItemsFromClient)

[Applies if the SelectedItems value is specified for the backupType parameter] Specifies information on Azure resources to protect by the backup policy.

object or null (SqlPolicyExcludedItemsFromClient)

Specifies Azure resources to exclude from the backup scope.

stagingServerId
string or null

Specifies the Microsoft Azure ID assigned to a staging server configured for the unmanaged instances.

managedStagingServerId
string or null

Specifies the Microsoft Azure ID assigned to a staging server configured for the managed instances.

description
string or null

Specifies a description for the backup policy.

object or null (RetrySettings)

Specifies the retry settings for the backup policy.

object or null (PolicyNotificationSettings)

Specifies the notification settings for the backup policy.

object or null (DailySqlSchedule)

Specifies daily schedule settings for the backup policy.

object or null (WeeklySqlSchedule)

Specifies weekly schedule settings for the backup policy.

object or null (MonthlySqlSchedule)

Specifies monthly schedule settings for the backup policy.

object or null (YearlySchedule)

Specifies the yearly schedule settings for the backup policy.

object or null (HealthCheckSchedule)

[Applies if backup creation is enabled for the backup policy] Specifies the health check schedule settings.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policies/sql
Request samples
application/json
{
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "regions": [
    ],
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "stagingServerId": "string",
  • "managedStagingServerId": "string",
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "dailySchedule": {
    },
  • "weeklySchedule": {
    },
  • "monthlySchedule": {
    },
  • "yearlySchedule": {
    },
  • "healthCheckSchedule": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "priority": 0,
  • "excludedItemsCount": 0,
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "backupStatus": "Canceled",
  • "archiveStatus": "Canceled",
  • "healthCheckStatus": "Canceled",
  • "nextExecutionTime": "2019-08-24T14:15:22Z",
  • "isArchiveBackupConfigured": true,
  • "_links": {},
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "dailySchedule": {
    },
  • "weeklySchedule": {
    },
  • "monthlySchedule": {
    },
  • "yearlySchedule": {
    },
  • "healthCheckSchedule": {
    }
}

Get Backup Policy Data

The HTTP GET request to the /policies/sql/{policyId} endpoint retrieves information on a SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to a backup policy 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/policies/sql/{policyId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policies/sql/{policyId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "priority": 0,
  • "excludedItemsCount": 0,
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "backupStatus": "Canceled",
  • "archiveStatus": "Canceled",
  • "healthCheckStatus": "Canceled",
  • "nextExecutionTime": "2019-08-24T14:15:22Z",
  • "isArchiveBackupConfigured": true,
  • "_links": {},
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "dailySchedule": {
    },
  • "weeklySchedule": {
    },
  • "monthlySchedule": {
    },
  • "yearlySchedule": {
    },
  • "healthCheckSchedule": {
    }
}

Modify Backup Policy

The HTTP PUT request to the /policies/sql/{policyId} endpoint updates settings of a SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

Request Body schema: application/json
required
backupType
required
string or null (BackupTypeNullable)

Defines whether you want to include to the backup scope all resources residing in the specified Azure regions and to which the specified service account has access.

Enum: "AllSubscriptions" "SelectedItems" "Unknown"
x-external-type: Veeam.Azure.REST.Latest.BackupType
isEnabled
required
boolean or null

Defines whether to enable the policy.

name
required
string [ 1 .. 255 ] characters

Specifies a name for the backup policy.

required
Array of objects (PolicyRegionFromClient) non-empty

Specifies Azure regions where the backed up resources will reside.

tenantId
string or null

Specifies a Microsoft Azure ID assigned to a tenant with which the service account used to protect Azure resources is associated.

serviceAccountId
string or null <uuid>

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the service account whose permissions will be used to perform backups of Azure SQL databases.

object or null (SqlPolicyBackupItemsFromClient)

[Applies if the SelectedItems value is specified for the backupType parameter] Specifies information on Azure resources to protect by the backup policy.

object or null (SqlPolicyExcludedItemsFromClient)

Specifies Azure resources to exclude from the backup scope.

stagingServerId
string or null

Specifies the Microsoft Azure ID assigned to a staging server configured for the unmanaged instances.

managedStagingServerId
string or null

Specifies the Microsoft Azure ID assigned to a staging server configured for the managed instances.

description
string or null

Specifies a description for the backup policy.

object or null (RetrySettings)

Specifies the retry settings for the backup policy.

object or null (PolicyNotificationSettings)

Specifies the notification settings for the backup policy.

object or null (DailySqlSchedule)

Specifies daily schedule settings for the backup policy.

object or null (WeeklySqlSchedule)

Specifies weekly schedule settings for the backup policy.

object or null (MonthlySqlSchedule)

Specifies monthly schedule settings for the backup policy.

object or null (YearlySchedule)

Specifies the yearly schedule settings for the backup policy.

object or null (HealthCheckSchedule)

[Applies if backup creation is enabled for the backup policy] Specifies the health check schedule settings.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

put/api/v8/policies/sql/{policyId}
Request samples
application/json
{
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "regions": [
    ],
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "stagingServerId": "string",
  • "managedStagingServerId": "string",
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "dailySchedule": {
    },
  • "weeklySchedule": {
    },
  • "monthlySchedule": {
    },
  • "yearlySchedule": {
    },
  • "healthCheckSchedule": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "priority": 0,
  • "excludedItemsCount": 0,
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "backupStatus": "Canceled",
  • "archiveStatus": "Canceled",
  • "healthCheckStatus": "Canceled",
  • "nextExecutionTime": "2019-08-24T14:15:22Z",
  • "isArchiveBackupConfigured": true,
  • "_links": {},
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "dailySchedule": {
    },
  • "weeklySchedule": {
    },
  • "monthlySchedule": {
    },
  • "yearlySchedule": {
    },
  • "healthCheckSchedule": {
    }
}

Remove Backup Policy

The HTTP DELETE request to the /policies/sql/{policyId} endpoint deletes a specific SQL backup policy from the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

delete/api/v8/policies/sql/{policyId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/policies/sql/{policyId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Get Resources Selected for Backup Policy

The HTTP GET request to the /policies/sql/{policyId}/selectedItems endpoint retrieves information on resources protected by a SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

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

Get Azure Regions Specified in Policy Settings

The HTTP GET request to the /policies/sql/{policyId}/regions retrieves a list of Azure regions added to a SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

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

Get Resources Excluded from Backup Policy

The HTTP GET request to the /policies/sql/{policyId}/excludedItems endpoint retrieves a list of SQL databases excluded from a SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

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
NameSearchPattern
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: PolicyExcludedItemOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

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

Set Backup Policy Priority

The HTTP POST request to the /policies/sql/orderPriorities endpoint sets the priority order for SQL backup policies.

SecurityBearer
Request
Request Body schema: application/json
Array
string <uuid>

Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to backup policies in the specified order.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policies/sql/orderPriorities
Request samples
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Check Configuration of Backup Policy

The HTTP POST request to the /policies/sql/testConfiguration endpoint verifies whether the SQL policy settings are configured properly.

SecurityBearer
Request
Request Body schema: application/json
required
backupType
required
string or null (BackupTypeNullable)

Defines whether you want to include to the backup scope all resources residing in the specified Azure regions and to which the specified service account has access.

Enum: "AllSubscriptions" "SelectedItems" "Unknown"
x-external-type: Veeam.Azure.REST.Latest.BackupType
isEnabled
required
boolean or null

Defines whether to enable the policy.

name
required
string [ 1 .. 255 ] characters

Specifies a name for the backup policy.

required
Array of objects (PolicyRegionFromClient) non-empty

Azure regions where the resources that will be backed up reside.

tenantId
required
string

Specifies a Microsoft Azure ID assigned to a tenant with which the service account used to protect Azure resources is associated.

serviceAccountId
required
string <uuid>

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to the service account whose permissions will be used to perform backups of Azure SQL databases.

object or null (SqlPolicyBackupItemsFromClient)

[Applies if the SelectedItems value is specified for the backupType parameter] Specifies information on Azure resources to protect by the backup policy.

object or null (SqlPolicyExcludedItemsFromClient)

Specifies Azure resources to exclude from the backup scope.

stagingServerId
string or null

Specifies the Microsoft Azure ID assigned to a staging server configured for the unmanaged instances.

managedStagingServerId
string or null

Specifies the Microsoft Azure ID assigned to a staging server configured for the managed instances.

description
string or null

Specifies a description for the backup policy.

object or null (RetrySettings)

Specifies the retry settings for the backup policy.

object or null (PolicyNotificationSettings)

Specifies the notification settings for the backup policy.

object or null (DailySqlSchedule)

Specifies daily schedule settings for the backup policy.

object or null (WeeklySqlSchedule)

Specifies weekly schedule settings for the backup policy.

object or null (MonthlySqlSchedule)

Specifies monthly schedule settings for the backup policy.

object or null (YearlySchedule)

Specifies the yearly schedule settings for the backup policy.

object or null (HealthCheckSchedule)

[Applies if backup creation is enabled for the backup policy] Specifies the health check schedule settings.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policies/sql/testConfiguration
Request samples
application/json
{
  • "tenantId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "regions": [
    ],
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "stagingServerId": "string",
  • "managedStagingServerId": "string",
  • "name": "string",
  • "description": "string",
  • "retrySettings": {
    },
  • "policyNotificationSettings": {
    },
  • "isEnabled": true,
  • "backupType": "AllSubscriptions",
  • "dailySchedule": {
    },
  • "weeklySchedule": {
    },
  • "monthlySchedule": {
    },
  • "yearlySchedule": {
    },
  • "healthCheckSchedule": {
    }
}
Response samples
application/json
[
  • {
    }
]

Enable Backup Policy

The HTTP POST request to the /policies/sql/{policyId}/enable endpoint enables a disabled SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/policies/sql/{policyId}/enable
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/policies/sql/{policyId}/enable' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Disable Backup Policy

The HTTP POST request to the /policies/sql/{policyId}/disable endpoint disables an enabled SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/policies/sql/{policyId}/disable
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/policies/sql/{policyId}/disable' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Start Backup Policy

The HTTP POST request to the /policies/sql/{policyId}/start endpoint launches a SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

post/api/v8/policies/sql/{policyId}/start
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/policies/sql/{policyId}/start' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Stop Backup Policy

The HTTP POST request to the /policies/sql/{policyId}/stop endpoint stops execution of a SQL backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/policies/sql/{policyId}/stop
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/policies/sql/{policyId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Export Backup Policies

The HTTP POST request to the /policies/sql/export endpoint exports a list of SQL backup policies created in 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
policyIds
Array of strings or null <uuid>

Specifies the system IDs assigned in the Veeam Backup for Microsoft Azure REST API to the SQL backup policies whose data will be exported.

policyName
string or null

Exports only data on the backup policy with the specified name.

lastJobStatus
Array of strings or null (JobStatus)

Exports only data on the backup policies with the specified status of the latest session.

Enum: "Canceled" "Canceling" "Error" "NeverExecuted" "Running" "RunningWithError" "RunningWithWarning" "Success" "Warning" "Pending" "Unknown"
x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.REST.Latest.JobStatus>
policyStatus
Array of strings or null (PolicyStatus)

Exports only data on the backup policies with the specified statuses.

Enum: "Enabled" "Disabled" "Unknown"
x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.REST.Latest.PolicyStatus>
Responses
200

OK

401

Unauthorized

403

Forbidden

post/api/v8/policies/sql/export
Request samples
application/json
{
  • "policyIds": [
    ],
  • "policyName": "string",
  • "lastJobStatus": [
    ],
  • "policyStatus": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Get Collection of Protected Items

The HTTP GET request to the /policies/sql/protectedItems endpoint retrieves a list of SQL databases that are protected by backup policies configured in 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
Responses
200

OK

401

Unauthorized

403

Forbidden

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

Get Resources Protected by Backup Policy

The HTTP GET request to the /policies/sql/{policyId}/protectedItems endpoint retrieves a list of SQL databases protected by a backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

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

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 system ID assigned to a backup policy in the Veeam Backup for Microsoft Azure REST API.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

401

Unauthorized

403

Forbidden

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