Appliance Connection Test

The /test resource collection helps you check whether the access token you use to send REST API requests is valid and the server is responding.

Test Connection

The HTTP POST request to the /test endpoint checks the Veeam Backup for AWS REST API availability.

SecurityBearer

Request

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

400

Bad Request. The request body is malformed, incomplete or invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have privileges to access one or more objects specified in the request.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/test

Request samples

curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/test \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{ }