Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Getting Authorization Tokens

Veeam Availability Console RESTful API authorization with Swagger UI involves the following procedures:

  1. Obtain a pair of tokens:
  1. On the Veeam.Portal.WebAPI page, expand the Accounts resource and click POST /token.
  2. In the grant_type drop-down list, make sure that password (default) is selected.
  3. In the username and password fields, specify the credentials of a user with the Veeam Availability Console Portal Administrator privileges.
  4. Click Try it out.

Authorization Request

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

  1. Save the refresh token locally for further use.
  2. Make sure that the access key is automatically inserted in the api_key field at the top of the page.
  3. To validate the access token, click Explore.

Obtaining the Tokens

  1. When the access token expires, use the refresh token:
  1. On the Veeam.Portal.WebAPI page, expand the Accounts resource and click POST /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 Veeam Availability Console RESTful API:
  1. On the Veeam.Portal.WebAPI page, expand the Accounts resource and click POST /accounts/logout.
  2. Click Try it out.

Logout Request

Wait for the response from the server. A successfully completed operation returns the 200 Success response code and the “You have been logged out.” message in the response body.

Related Topics

Authorization and Security

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference