Veeam Availability Orchestrator 3.0
REST API Reference
Related documents

Run Readiness Check

You can run a readiness check for a plan with the specified ID.

Request

To run a readiness check, send the HTTP POST request to the /FailoverPlans/{id}/RunReadinessCheck endpoint.

HTTP Request

POST https://<hostname>:<port>/api/v3/Plans/{planId}/ReadinessCheck

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

  • application/xml
  • text/json
  • application/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.

Request Body

To run the readiness check, you must send the following specific parameter:

Parameter

Type

Description

generateReport

boolean

Defines whether to generate the Readiness Check Report after a readiness check run.

In the request body, specify the parameter value:

{

  "generateReport": 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

  • application/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Run Readiness CheckExample

The following example runs a readiness check for a plan with the ID cd47d232-44f6-4c1c-84e2-8033049a5cfa with the Readiness Check Report generation.

Request:

POST https://uwin2012r2.n.local:9898/api/v3/Plans/cd47d232-44f6-4c1c-84e2-8033049a5cfa/ReadinessCheck

 

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: application/json

 

Request Body:

{

"generateReport": true

}

 

Response:

200

 

Response Body:

{

 "success": true,

 "data": {}

}

This Document Help Center
User GuideGroup Management GuideREST API ReferenceVeeam Backup & Replication DocumentationVeeam ONE Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.