This is an archive version of the document. To get the most up-to-date information, see the current version.Set Backup Policy Priority
You can set the priority order for backup policies.
Request
To set the priority order, send the HTTP POST request to the /policies/orderPriorities endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/policies/orderPriorities |
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 set priorities, send the following parameters in the request body.
Parameter | Type | Description |
|---|---|---|
policyId | string($uuid) | Specifies a system ID assigned to a backup policy in the Veeam Backup for AWS REST API. |
priority | integer($int32) | Specifies the priority order number of the backup policy. |
Set the parameter values in the following format:
{ "priorities": [ { "policyId": "string($uuid)", "priority": integer($int32) } ] } |
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. |
Example
The following request sets the backup policy priority order.
|