Get Collection of SQL Servers
You can get a list of all SQL servers available to Veeam Backup for Microsoft Azure.
Request
To retrieve a full list of available SQL servers, send the HTTP GET request to the /cloudInfrastructure/sqlServers endpoint.
HTTP Request
GET https://<hostname>/api/v3/cloudInfrastructure/sqlServers |
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 |
|---|---|---|
TenantId | string | Returns only SQL servers available the specified tenant. For more information, see Filter Parameters. |
ServiceAccountId | string | Returns only SQL servers to which a specific Azure service account has access. For more information, see Filter Parameters. |
CredentialsState | array[string] | Defines whether Veeam Backup for Microsoft Azure must return only SQL servers that are associated with any Azure SQL account: OnlyWithCredentials, OnlyWithoutCredentials, All. |
AssignableBySqlAccountId | string | Returns only SQL servers that are associated with a specified Azure SQL account. |
RegionIds | string | Returns SQL servers that reside in the specified Azure regions. |
Sync | boolean | Defines whether Veeam Backup for Microsoft Azure database is synchronized with the Azure resources. |
ServerTypes |
| Returns only specific type of SQL servers |
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 /cloudInfrastructure/sqlServers collection. The SqlServerV3 schema is used for the collection representation.
Example
The following request returns a full list of SQL servers.
|