Help Center
Choose product document...
Veeam Availability Orchestrator 1.0
RESTful API Reference

Getting Authorization Tokens

VAO RESTful API authorization with Swagger UI involves the following procedures:

  1. Obtain a pair of tokens:
  1. On the Veeam Availability Orchestrator RESTAPI page, expand the Accounts resource and click POST /v1/Accounts/Token.
  2. From the grant_type drop-down list, select password (default).
  3. In the username and password fields, specify the credentials of a user with the Site Administrator or Failover Plan Author privileges.
  4. Click Try it out.

Getting an Authorization Token

Wait for the response from the server. A successfully completed operation returns the 200 Success response code, and an access and refresh tokens in the response body.

  1. Save the refresh token locally for further use.
  2. At the top of the page, in the api_key field, click Explore.

Using the Authorization Token

  1. When the access token expires, use the refresh token:
  1. On the Veeam Availability Orchestrator RESTAPI page, expand the Accounts resource and click POST /v1/Accounts/Token.
  2. From the grant_type drop-down list, select refresh_token.
  3. In the refresh_token field, insert the refresh token saved locally.
  4. Click Try it out.

Using the Refresh Token

Wait for the response from the server. A successfully completed operation returns the 200 Success response code and a new pair of tokens in the response body.

  1. When you finish working with VAO RESTful API:
  1. On the Veeam Availability Orchestrator RESTAPI page, expand the Accounts resource and click GET /v1/Accounts/Logout.
  2. Click Try it out.

Logging Out

Wait for the response from the server. A successfully completed operation returns the 200 Success response code and the "Logout successful" message in the response body.

Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference