Get Collection of Azure SQL Backup Policies
You can get all Azure SQL backup policies created in Veeam Backup for Microsoft Azure.
Request
To retrieve a representation of a collection of backup policies, send the HTTP GET request to the /policies/sql endpoint.
HTTP Request
GET https://<hostname>/api/v3/policies/sql |
Query Parameters
To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:
Query Parameter | Value | Description |
|---|---|---|
PolicyName | string | Returns only the specified backup policies. |
DatabaseId | string($uuid) | Returns only backup policies that protect an Azure SQL database with the specified ID. For more information, see Filter Parameters. |
LastJobStatus |
| Returns only backup policies with the specified most recent backup session status. For more information, see Filter Parameters. |
PolicyStatus |
| Returns only enabled or disabled backup policies. For more information, see Filter Parameters. |
RepositoryId | string($uuid) | Returns only backup policies with a backup repository the specified ID. For more information, see Filter Parameters. |
Request Headers
The request contains the following headers.
Header | Required | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-length | integer | Identifies the length of the response body message, in bytes. |
Content-type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns a representation of the /policies/sql collection. The PolicySQLV3 schema is used for the collection representation.
Example
The following request returns a full list of Azure SQL backup policies created in Veeam Backup for Microsoft Azure.
|