Get Protected Azure VMs Data

In this article

    You can get details of a protected item with the specified ID.

    Request

    To retrieve information on a specific protected item, send the HTTP GET request to the /policies/{policyId} 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/{policyId}

    Query Parameters

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

    Query Parameter

    Value

    Description

    Sync

    boolean

    Defines whether Veeam Backup for Microsoft Azure database is synchronized with Azure resources.

    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 protected item with the specified ID. The ProtectedVirtualMachinev3 schema is used for the collection representation.

    Get Protected Items DataExample

    The following request returns information on a protected item with the ID oqedma7doo56krcqzp15xbdffenfpgcjzxpekgqnmw6dx65rnyxo.

    Request:

    GET https://51.11.247.127/api/v3/protectedItem/oqedma7doo56krcqzp15xbdffenfpgcjzxpekgqnmw6dx65rnyxo

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200

     

    Response Body:

    {

     "id": "oqedma7doo56krcqzp15xbdffenfpgcjzxpekgqnmw6dx65rnyxo",

     "azureId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/bogatov/providers/microsoft.compute/virtualmachines/bogatov",

     "name": "bogatov",

     "azureEnvironment": "Global",

     "osType": "Linux",

     "regionName": "UK West",

     "totalSizeInGB": 30,

     "vmSize": "Standard_B2s",

     "hasEphemeralOsDisk": false,

     "isController": false,

     "lastBackup": "2020-11-24T21:00:20.624511Z",

     "subscription": {

       "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

       "environment": "Global",

       "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

       "name": "Visual Studio Premium MSDN",

       "status": "Active"

     },

     "region": {

       "id": "ukwest",

       "name": "UK West"

     },

     "resourceGroup": {

       "id": "1yb941zuh6ze8bmfsnqcwot7i8wi8p5ufy34nc7mxiaq5z6mmc6y",

       "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/bogatov",

       "name": "bogatov",

       "azureEnvironment": "Global",

       "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

       "regionId": "ukwest"

     },

     "_links": {

       "restorepoint": {

         "href": "https://51.11.247.127/api/v3/restorePoints/03b80d67-f7c6-4b49-9f94-c4d0c9be2b67"

       },

       "subscription": {

         "href": "https://51.11.247.127/api/v3/cloudInfrastructure/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803"

       },

       "resourcegroup": {

         "href": "https://51.11.247.127/api/v3/cloudInfrastructure/resourceGroups/1yb941zuh6ze8bmfsnqcwot7i8wi8p5ufy34nc7mxiaq5z6mmc6y"

       }

     }

    }