Start Azure SQL Backup Policy

In this article

    You can start a backup policy manually.

    Request

    To start a backup policy with the specified ID, send the HTTP POST request to the /databases/start endpoint.

    HTTP Request

    POST https://<hostname>/api/v3/databases/start

    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.

    Request Body

    To start a backup policy manually, send the parameters of the SqlManualBackupSettingsV3 schema in the request body.

    {

     "databaseIds": [

       "string"

     ],

     "repositoryId": "string",

     "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

     "serviceAccountId": "string",

     "managedStagingServerId": "string",

     "stagingServerId": "string"

    }

    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 the session ID of the starting the backup policy operation. For the session log details, see Get Session Log Details.

    Start Azure SQL Backup PolicyExample

    The following request starts a backup policy with the ID 87f58621-bb08-4525-a1d7-927acbe2f067.

    Request:

    POST https://51.11.247.127:<%PORT%>/api/v3/databases/start

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    202

     

    Response Body:

    {

     "id": "87f58621-bb08-4525-a1d7-927acbe2f067",

     "type": "SqlPolicyBackup",

     "executionStartTime": "2021-09-08T14:39:39.3910477Z",

     "executionDuration": "00:00:00.0147439",

     "status": "Running",

     "usn": 0,

     "backupJobInfo": {

       "policyId": "8cd8d89f-e774-4a3d-a87a-f77f5d2d432b",

       "policyName": "SQL_policy",

       "protectedInstancesCount": 0,

       "policyRemoved": false

     },

     "_links": {

       "self": {

         "href": "https://51.11.247.127/api/v3/jobSessions/87f58621-bb08-4525-a1d7-927acbe2f067"

       },

       "log": {

         "href": "https://51.11.247.127/api/v3/jobSessions/6d650cf3-db23-47b6-8b05-22a7f5cb99b4/log"

       }

     },

     "_embeddedResources": {}

    }