Authorization with Swagger UI

In this article

    Veeam Backup & Replication 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 & Replication REST API 1.0 page, expand the Login section and click POST api/oauth2/token.
    2. In the expanded method window, click Try it out.

    Getting Access Token

    1. From the grant_type drop-down list, select password.
    2. In the username and password fields, specify the credentials of a user created in Veeam Backup & Replication.
    3. Click Execute.

    Getting Access 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 & Replication returns an access token, its expiration time and a refresh token.

    Getting Access Token — Server Response

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

    1. Authorize your access in the Swagger UI:
    1. At the top right corner of the Veeam Backup & Replication public API 1.0 page, click Authorize.
    1. In the Available authorizations window, insert the access token saved locally in the Value field. Use the Bearer <access_token> format.
    2. Click Authorize.

    Available Authorizations

    1. When the access token expires, use the refresh token:
    1. On the Veeam Backup & Replication REST API 1.0 page, expand the Login resource and click POST api/oauth2/token.
    2. In the expanded method window, click Try it out.
    3. From the grant_type drop-down list, select refresh_token.
    4. In the refresh_token field, insert the saved refresh token 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 & Replication public API 1.0 page, click Authorize.
    2. In the Available authorizations window, click Logout.

    Logout