Authorization with Swagger UI
Veeam Backup & Replication REST API authorization with the Swagger UI involves the following procedures:
- Obtain an access token and a refresh token:
- On the Veeam Backup & Replication REST API page, expand the Login section and click POST api/oauth2/token.
- In the expanded method window, click Try it out.
- From the grant_type drop-down list, select password.
- In the username and password fields, specify the credentials of a user created in Veeam Backup & Replication.
- Click Execute.
Wait for the response from the server. A successfully completed operation returns the 200 response code. In the response body, Veeam Backup & Replication returns an access token, its expiration time and a refresh token.
- Save the access and refresh tokens 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. |
- Authorize your access in the Swagger UI:
- At the top right corner of the Veeam Backup & Replication REST API page, click Authorize.
- In the Available authorizations window, insert the access token saved locally in the Value field. Use the Bearer <access_token> format.
- Click Authorize.
- When the access token expires, use the refresh token:
- On the Veeam Backup & Replication REST API page, expand the Login resource and click POST api/oauth2/token.
- In the expanded method window, click Try it out.
- From the grant_type drop-down list, select refresh_token.
- In the refresh_token field, insert the saved refresh token and click Execute.
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.
- Save the access and refresh token locally for further use. To authorize your access in the Swagger UI, repeat step 2.
- When you finish working with the Swagger UI:
- At the top right corner of the Veeam Backup & Replication REST API page, click Authorize.
- In the Available authorizations window, click Logout.