This is an archive version of the document. To get the most up-to-date information, see the current version.Run Backup Policy Check
You can run the backup policy check to verify whether IAM roles used in the backup policy have all the required permissions, networks settings used to launch worker instances and backup schedule settings are properly configured.
Request
To run the backup policy check, send the HTTP POST request to the /policies/validate endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/policies/validate |
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. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| 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 Body
To run the backup policy check, send the parameters of the PolicySpec schema in the request body.
Set the parameter values in the following format:
{ "snapshotSettings": { "additionalTags": [ { "key": "string", "value": "string" } ], "copyTagsFromVolumeEnabled": true/false, "tryCreateVSSSnapshot": true/false }, "replicaSettings": { "mapping": [ { "sourceRegionId": "string($uuid)", "targetRegionId": "string($uuid)", "targetAmazonAccountId": "string($uuid)", "encryptionKey": "string" } ], "additionalTags": [ { "key": "string", "value": "string" } ], "copyTagsFromVolumeEnabled": true/false }, "backupSettings": { "targetRepositoryId": "string($uuid)" }, "regionIds": [ "string($uuid)" ], "selectedItems": { "virtualMachineIds": [ "string($uuid)" ], "tagIds": [ "string($uuid)" ] }, "excludedItems": { "virtualMachineIds": [ "string($uuid)" ], "tagIds": [ "string($uuid)" ] }, "scheduleSettings": { "dailyScheduleEnabled": true/false, "dailySchedule": { "kind": "Everyday", "runsPerHour": integer($int32), "days": [ "Sunday" ], "snapshotOptions": { "retention": { "count": integer($int32) }, "schedule": { "hours": [ true ] } }, "backupOptions": { "retention": { "type": "Days", "count": integer($int32) }, "schedule": { "hours": [ true ] } }, "replicaOptions": { "retention": { "count": integer($int32) }, "schedule": { "hours": [ true ] } } }, "weeklyScheduleEnabled": true/false, "weeklySchedule": { "timeLocal": "string($date-time)", "snapshotOptions": { "retention": { "count": integer($int32) }, "schedule": { "days": [ "Sunday" ] } }, "backupOptions": { "retention": { "type": "Days", "count": integer($int32) }, "schedule": { "days": [ "Sunday" ] } }, "replicaOptions": { "retention": { "count": integer($int32) }, "schedule": { "days": [ "Sunday" ] } } }, "monthlyScheduleEnabled": true/false, "monthlySchedule": { "timeLocal": "string($date-time)", "dayNumberInMonth": "First", "dayOfWeek": "Sunday", "dayOfMonth": integer($int32), "snapshotOptions": { "retention": { "count": integer($int32) }, "schedule": { "months": [ "January" ] } }, "backupOptions": { "retention": { "type": "Days", "count": integer($int32) }, "schedule": { "months": [ "January" ] } }, "replicaOptions": { "retention": { "count": integer($int32) }, "schedule": { "months": [ "January" ] } } }, "yearlyScheduleEnabled": true/false, "yearlySchedule": { "timeLocal": "string($date-time)", "dayNumberInMonth": "First", "dayOfWeek": "Sunday", "dayOfMonth": integer($int32), "month": "January", "retention": { "count": integer($int32), "type": "Years" } } }, "name": "string", "description": "string", "amazonAccountId": "string($uuid)", "retrySettings": { "retryTimes": integer($int32) }, "policyNotificationSettings": { "recipient": "string", "notifyOnSuccess": true/false, "notifyOnWarning": true/false, "notifyOnFailure": true/false }, "backupType": "AllItems" } |
Response
The server returns the following response to the client.
Response Code
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
If backup policy settings are valid, Veeam Backup for AWS does not return a response body, in other cases Veeam Backup for AWS returns the severity level and the error message.
Example
The following request checks backup policy settings.
|