Get Protected Items Data

In this article

    You can get details of items protected by a backup policy with the specified ID.

    Request

    To retrieve information on a items protected by specific backup policy, send the HTTP GET request to the /policies/sql/{policyId}/protectedItems endpoint. {policyId} is a system ID assigned to the backup policy in the Veeam Backup for Microsoft Azure REST API.

    HTTP Request

    GET https://<hostname>/api/v3/policies/sql/{policyId}/protectedItems

    Query Parameters

    To control the amount and order of data in the response, you can use Offset, Limit query parameters.

    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 backup policy with the specified ID. The PolicySqlBackupItemV3 schema is used for the resource representation.

    Get Protected Items DataExample

    The following request returns information on a backup policy with the ID a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55.

    Request:

    GET https://51.11.247.127/api/v3/policies/sql/a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55/protectedItems

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200

     

    Response Body:

    {

     "offset": 0,

     "limit": 200,

     "totalCount": 4,

     "results": [

       {

         "resourceId": "b45yr8nr5zj684pdjoejkmadcrezdjp8esz63tc6iqd9eq6rfcby",

         "policyId": "a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55"

       },

       {

         "resourceId": "t9n4b5ky6gnhpurroj3srckqywxj34rmrby6zthnypg9an76shty",

         "policyId": "a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55"

       },

       {

         "resourceId": "oqedma7doo56krcqzp15xbdffenfpgcjzxpekgqnmw6dx65rnyxo",

         "policyId": "a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55"

       },

       {

         "resourceId": "fdydnccas19nbuehqbiaxo6j5bku33i58xahpwcye6xc7g9n8nyy",

         "policyId": "a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55"

       }

     ],

     "_links": {

       "self": {

         "href": "https://51.11.247.127/api/v3/policies/a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55/protectedItems?offset=0&limit=200"

       }

     }

    }