This is an archive version of the document. To get the most up-to-date information, see the current version.Stop Backup Policy
You can stop backup policy execution.
Request
To stop a backup policy with the specified ID, send the HTTP POST request to the /policies/{policyId}/stop endpoint. {policyId} is a system ID assigned to the backup policy in the Veeam Backup for AWS REST API.
HTTP Request
POST https://<hostname>:<port>/api/v1/policies/{policyId}/stop |
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. |
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. |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a response code 202 (Accepted).
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 stops a backup policy with the ID 6ac40b80-4bdb-46e9-9759-0fc0d1166ccf.
|