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.

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.

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

2. 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.

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.

3. 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.

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