Evaluation with Swagger UI

To start working with the Veeam Backup for AWS REST API, you can use any client application that supports the HTTPS protocol.

The Veeam Backup for AWS REST API is additionally available through the Swagger UI, a tool that you can use to evaluate and explore capabilities of the REST API. The Swagger UI visually presents API specification files and allows you to work with resources.

All resources and methods are expandable. When you expand a method, you get a full description of available parameters and an automatically generated example. You can also send requests and see response messages.

To access the Swagger UI for the Veeam Backup for AWS REST API, in a web browser, navigate to the following URL:

https://<hostname>:<port>/swagger/index.html

where:

  • <hostname> is a public IPv4 address or DNS hostname of the EC2 instance on which Veeam Backup for AWS is installed.
  • <port> is the REST API port number set during Veeam Backup for AWS installation.

The default port number is 11005.

In the Select a definition field, select the version and revision of the Veeam Backup for AWS REST API.

 

Welcome to the Veeam Backup for AWS REST API

 

 

 

In This Section

I want to report a typo

There is a misspelling right here:

 

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