Evaluation with Swagger UI

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

The Veeam Backup & Replication 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.

You can access the Swagger UI for the Veeam Backup & Replication REST API using a web browser.

1. Navigate to the following URL:

where:

• <hostname> is a public IPv4 address or DNS hostname of the machine where Veeam Backup & Replication is installed.
• <port> is the REST API port number set during Veeam Backup & Replication installation.

The default port number is 9419.

2. From the Select a definition list, select the REST API version you need. The latest version is 1.2-rev0.

In This Section

• Authorization with Swagger UI
• Sending Requests