Disable Plan
You can disable a plan with the specified ID.
Request
To disable a specific plan, send the HTTP POST request to the /Plans/{planId}/Disable endpoint.
Note |
If you disable a plan, you will not be able to run it. To run a plan, it must be ENABLED. For more information on states that a VAO plan can acquire, see the Veeam Availability Orchestrator User Guide, sections Running and Scheduling Replica Plans, Running and Scheduling Restore Plans, Running and Scheduling Storage Plans. |
HTTP Request
POST https://<hostname>:<port>/api/v3/Plans/{planId}/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. |
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 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 disables a plan with the ID cd47d232-44f6-4c1c-84e2-8033049a5cfa.
|
