Get Protected Items Data
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/v2/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 |
| 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 ProtectedVirtualMachineV2 schema is used for the collection representation.
Example
The following request returns information on a protected item with the ID oqedma7doo56krcqzp15xbdffenfpgcjzxpekgqnmw6dx65rnyxo.
|