Creating an Access Token

To execute REST APIs, you can create an access token in the Command Center. While creating an access token, you must provide a display name, expiration date, and scope.

Important

  • An access token functions like a password. You must save it for your records and not share it with others.

  • If you lose an access token, it cannot be retrieved.

After creating an access token, you can use it in your API requests as a Bearer Token.

Procedure

  1. From the navigation pane, go to Manage > Security.

    The Security page appears.

  2. Click the Users tile.

    The Users page appears.

  3. In the User name column, click your user name.

    The user page appears.

  4. On the Access tokens tab, click Add token.

    The Add token dialog box appears.

  5. Enter the token's name, expiry date, and scope.

    An access token expires after 2 minutes by default, and the scope includes all api.commvault.com endpoints.

    • To set a different scope, in the Scope list, select Custom and enter specific endpoints (for example, /Subclient).

      Note

      To list multiple endpoints, enter each endpoint on a new line.

  6. Click SUBMIT.

    A token appears.

  7. Copy and save the token.

Loading...