Authorization with Swagger UI

Veeam Backup for Nutanix AHV REST API authorization with the Swagger UI involves the following procedures:

  1. Obtain an access token and a refresh token:
  1. On the Veeam Backup for Nutanix AHV public API page, expand the Token resource and click POST api/oauth2/token.
  2. In the expanded method window, click Try it out.

Getting Authorization Token

  1. From the grantType drop-down list, select Password.
  2. In the userName and password fields, specify the credentials of a user created in Veeam Backup for Nutanix AHV.
  3. Click Execute.

Getting Authorization Token - Enter Credentials

Wait for the response from the server. A successfully completed operation returns the 200 response code. In the response body, Veeam Backup for Nutanix AHV returns an access token, a refresh token and expiration time of each token.

Getting Authorization Token — Server Response

  1. Save the access and refresh token locally for further use.

Tip

You can download a server response in the .json format. To do that, in the expanded method window, click Download at the lower right corner of the Response body field.

  1. Authorize your access in the Swagger UI:
  1. At the top right corner of the Veeam Backup for Nutanix AHV public API page, click Authorize.

Getting Authorization

  1. In the Available authorizations window, insert the access token saved locally in the Value field. Use the Bearer <access_token> format.

Available Authorizations Window

  1. Click Authorize.
  1. When the access token expires, use the refresh token:
  1. On the Veeam Backup for Nutanix AHV public API page, expand the Token resource and click POST api/v6/token.
  2. In the expanded method window, click Try it out.
  3. From the grantType drop-down list, select RefreshToken.
  4. In the refreshToken field, insert the refresh token saved locally, and click Execute.

Refresh Token

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

Refresh Token — Server Response

  1. Save the access and refresh token locally for further use. To authorize your access in the Swagger UI, repeat step 2.
  1. When you finish working with the Swagger UI:
  1. At the top right corner of the Veeam Backup for Nutanix AHV public API page, click Authorize.
  2. In the Available authorizations window, click Logout.

Logging Out