This is an archive version of the document. To get the most up-to-date information, see the current version.Get Collection of Protected Items
You can get a list of all protected Azure SQL databases.
Request
To retrieve a representation of a collection of protected databases, send the HTTP GET request to the /protectedItem/sql endpoint.
HTTP Request
GET https://<hostname>/api/v3/protectedItem/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 |
|---|---|---|
ServerId | string | Returns only databases located on an SQL Server with the specified ID. |
DatabaseIds | array[string] | Returns only specific databases. |
Sync | boolean | Defines whether Veeam Backup for Microsoft Azure database is synchronized with Azure resources. |
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 /protectedItem/sql collection. The ProtectedDatabaseV3 schema is used for the collection representation.
Example
The following request returns a full list of protected databases.
|