Clear Change Log History for Plan
You can clear the change log history in the Plan Definition Report for a plan with the specified ID. For more information on the Plan Definition Report, see the Veeam Availability Orchestrator User Guide, section Generating Plan Definition Report.
Request
To clear the change log history, send the HTTP POST request to the /Plans/{planId}/ResetChangeLog endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v3/Plans/{planId}/ResetChangeLog |
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. |
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 clear the change log history for a plan, you must send the following specific parameter:
Parameter | Type | Description |
|---|---|---|
generateDrReport | boolean | Defines whether to generate the Plan Definition Report after the change log history is cleared. |
In the request body, specify the parameter value.
{ "generateDrReport": true/false } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns 200 response code.
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 example clears the change log history for a plan with the ID b8517d70-028d-4740-a130-787e164a3d83 and generates the Plan Definition Report.
|
