Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
REST API Reference

Evaluation with Swagger UI

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

VAO REST API is additionally available through Swagger UI, a tool that you can use to evaluate and explore capabilities of VAO REST API. 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 Swagger UI for VAO REST API:

  1. In a web browser, navigate to the VAO REST API URL.

The URL consists of a FQDN or IP address of the VAO server and the VAO REST API port number specified during installation (by default, 9899).

https://<hostname>:<port>

  1. On the landing page, click Swagger.

Welcome to VAO REST API

In This Section

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference