This is an archive version of the document. To get the most up-to-date information, see the current version.

Disable Backup Policy

You can temporarily disable backup policies created in Veeam Backup for AWS. When you disable a backup policy, Veeam Backup for AWS does not start the backup policy by the specified schedule. You can start a disabled backup policy manually at any time you need.

Request

To disable a backup policy with the specified ID, send the HTTP POST request to the /policies/{policyId}/disable 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}/disable

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

  • application/json
  • application/problem+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.

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

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Disable Backup PolicyExample

The following request disables a backup policy with the ID 6ac40b80-4bdb-46e9-9759-0fc0d1166ccf.

Request:

POST https://135.169.170.192:11005/api/v1/policies/6ac40b80-4bdb-46e9-9759-0fc0d1166ccf/disable

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200