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. In addition, the REST API is available through Swagger UI, a tool that you can use to evaluate and explore capabilities of the REST API. Swagger UI visually represents the API specification file and allows you to work with the API endpoints.
The source document is JSON file swagger.json . You can find the file in the installation folder of Veeam Backup & Replication. The default path is %Program Files%\Veeam\Backup and Replication\Backup\RestApiService\specs\latest.
You can access the REST API Swagger UI using a web browser.
- 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.
- From the Select a definition list, select the REST API version you need. The latest version is 1.2-rev1.
In This Section
