This is an archive version of the document. To get the most up-to-date information, see the current version.Start Backup Policy
You can start a backup policy manually.
Request
To start a backup policy with the specified ID, send the HTTP POST request to the /policies/{policyId}/start 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}/start |
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. |
Response Body
In the response body, Veeam Backup for AWS returns the session ID of the starting the backup policy operation. For the session log details, see Get Session Log Details.
Example
The following request starts a backup policy with the ID 6ac40b80-4bdb-46e9-9759-0fc0d1166ccf.
|