Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

SQL Servers

The /cloudInfrastructure/sqlServers resource collection represents SQL Servers available to Veeam Backup for Microsoft Azure.

Get Collection of SQL Servers

The HTTP GET request to the /cloudInfrastructure/sqlServers endpoint retrieves a list of SQL Servers deployed in the Microsoft Azure environment.

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
TenantId
string or null <uuid>

Returns only SQL Servers available for a tenant with the specified ID.

x-veeam-parameter-group: SqlServerOptions
ServiceAccountId
string

Returns only SQL Servers available in a subscription with the specified ID.

x-veeam-parameter-group: SqlServerOptions
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: SqlServerOptions
CredentialsState
string or null (CredentialsStateFilterOptions)

Returns only SQL Servers that have the specified credentials state.

Enum: "OnlyWithCredentials" "OnlyWithoutCredentials" "All"
x-veeam-parameter-group: SqlServerOptions
AssignableBySqlAccountId
integer or null <int64>

Returns only SQL Servers that are associated with an Azure SQL account with the specified ID.

x-veeam-parameter-group: SqlServerOptions
RegionIds
Array of strings or null

Returns only SQL Servers that reside in Azure regions with the specified IDs.

x-veeam-parameter-group: SqlServerOptions
Sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

x-veeam-parameter-group: SqlServerOptions
ServerTypes
string (SqlServerTypeFilterOptions)

Returns only SQL Servers of the specified type.

Enum: "Managed" "Unmanaged" "All"
x-veeam-parameter-group: SqlServerOptions
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/sqlServers
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/sqlServers?Offset=0&Limit=-1&TenantId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ServiceAccountId=string&SearchPattern=string&CredentialsState=OnlyWithCredentials&AssignableBySqlAccountId=0&RegionIds=string&Sync=true&ServerTypes=Managed' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get SQL Server Data

HTTP GET request to the /cloudInfrastructure/sqlServers/{sqlServerId} endpoint retrieves information on a SQL Server with the specified ID.

SecurityBearer
Request
path Parameters
sqlServerId
required
string or null

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

query Parameters
sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/sqlServers/{sqlServerId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/sqlServers/{sqlServerId}?sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "resourceId": "string",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "regionId": "string",
  • "serverType": "Managed",
  • "_links": {}
}

Test Connection to SQL Server

The HTTP POST request to the /cloudInfrastructure/sqlServers/testConnectivity/{sqlServerId} endpoint verifies connection to a SQL Server with the specified ID.

SecurityBearer
Request
path Parameters
sqlServerId
required
string or null

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

query Parameters
sqlAccountId
string or null

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

azureAccountId
string or null

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.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/cloudInfrastructure/sqlServers/testConnectivity/{sqlServerId}
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/cloudInfrastructure/sqlServers/testConnectivity/{sqlServerId}?sqlAccountId=string&azureAccountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]