Evaluation with Swagger UI

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

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

All methods are grouped into tags. You can filter methods by tag name using the Filter by tag field. Note, that the field is case-sensitive.

All tags 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 Swagger UI for Veeam ONE REST API, in the web browser, navigate to the following URL:



  • <hostname> is the DNS name or IP address of the machine on which the Veeam ONE Web Services component is installed.
  • <port> is the REST API port number you specified during Veeam ONE Web Services installation.

The default port number is 1239.

Alternatively, you can access Swagger UI using the REST API section of Veeam ONE Web Client.

From the the Select a definition drop-down list, select the version of the Veeam ONE REST API.

In This Section