Test Connection to SQL Server

In this article

    You can check the SQL server availability.

    Request

    To check the SQL server availability, send the HTTP POST request to the /cloudInfrastructure/sqlServers/testConnectivity/{sqlServerId} endpoint. {sqlServerId} is a system ID assigned to the SQL server in the Veeam Backup for Microsoft Azure REST API.

    HTTP Request

    POST https://<hostname>/api/v3/cloudInfrastructure/sqlServers/testConnectivity/{sqlServerId}

    Query Parameters

    To control the amount and order of data in the response, you can use the following query parameters:

    Query Parameter

    Value

    Description

    sqlAccountId

    string

     

    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

    • application/json
    • application/problem+json

    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 SQL server with the specified ID. The SqlServerV3 schema is used for the resource representation.

    Test Connection to SQL ServerExample

    The following request returns information on an SQL server with the ID qhhre6nua6xdz815cwfquniemcx6zhxpd5addqndfzfpt9fztgjo.

    Request:

    GET https://51.11.247.127/api/v3/cloudInfrastructure/sqlServers/qhhre6nua6xdz815cwfquniemcx6zhxpd5addqndfzfpt9fztgjo

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200

     

    Response Body:

    {

     "id": "qhhre6nua6xdz815cwfquniemcx6zhxpd5addqndfzfpt9fztgjo",

     "name": "bp-server-eus",

     "resourceId": "/subscriptions/280921a2-220d-45c9-92dd-82b6d5a3a78f/resourcegroups/bp-sql/providers/microsoft.sql/servers/bp-server-eus",

     "subscriptionId": "280921a2-220d-45c9-92dd-82b6d5a3a78f",

     "regionId": "eastus",

     "serverType": "Unmanaged",

     "_embeddedResources": {},

     "_links": {

       "self": {

         "href": "https://51.11.247.127/api/v3/cloudInfrastructure/sqlServers/qhhre6nua6xdz815cwfquniemcx6zhxpd5addqndfzfpt9fztgjo"

       }

     }

    }