This is an archive version of the document. To get the most up-to-date information, see the current version.Get Backup Policy
You can get a resource representation of a backup policy with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of a backup policy, send the GET HTTP request to the URL of the /configuration/backupPolicies/{policyUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/configuration/backupPolicies/{policyUid} |
Request Headers
The request contains the following headers.
Header | Required/Optional | 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. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
policyUid | Path | String (uuid) | Yes | — | Backup policy UID |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns 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 | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a resource representation based on the BackupPolicy schema.
Example 
The following request returns a representation of a backup policy with UID 7d953664-677a-4a8f-88ed-9b61131b8151.
Request: GET https://localhost:1280/api/v3/configuration/backupPolicies/7d953664-677a-4a8f-88ed-9b61131b8151
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "7d953664-677a-4a8f-88ed-9b61131b8151", "organizationUid": "11483cd8-24f0-4745-8248-e423c8f5c7c1", "name": "Workstation: File level backup. Personal files. Local drive. Daily schedule.", "description": "This policy processes user profile folder including all user settings and data.", "configId": "4610eb17-b41c-4cc5-81d1-9b6ee6d89b7a", "mode": "workstation", "type": "predefined" } } |