Generate API access token

Note: This feature is available in Enterprise and AWS editions only.

Table of contents

• How to generate API token
• Set the maximum token lifetime
• How to delete API token
• Using the API token with GraphQL

The CloudBeaver allows you to generate API tokens for automating tasks and interacting with the GraphQL API.

Note: Each user must create their own tokens.

How to generate API token

1. Enable the API token switch in Settings -> Administration -> Server configuration -> Authentication settings.

2. Navigate to your Profile page in the CloudBeaver.

3. Open the API Token tab.

   

4. Click + Add.

   Note: Users can create up to 5 tokens.

5. Enter a Name and select an Expiration date.

   Note: The expiration date is required. You can't create a token without one. The maximum token lifetime set by your administrator.

6. Copy the token after it’s generated.

   Important: Tokens are displayed only once during creation.

Set the maximum token lifetime

Administrators can limit how long API tokens stay valid.

1. Go to Settings -> Administration -> Server configuration.
2. In the Server Information section, set the Maximum API token lifetime, days value.

The default is 30 days. Users can't set an expiration date beyond this limit.

How to delete API token

1. On the API Token tab.
2. Find the token you want to delete and click the Delete icon.
3. Confirm the deletion in the confirmation dialog.

Note: Deleting a token doesn’t immediately end an active session. Users must log in again for the deletion to take effect.

Using the API token with GraphQL

Authenticate with the GraphQL API console using your token by including it in the query.

• Example query:

query authLogin($credentials: Object) {
  authLogin(
    provider: "token"
    credentials: $credentials
  ) {
    authId
    userTokens {
      userId
    }
    authStatus
  }
}

• Variables:

{
  "credentials": {
    "token": "your_api_token_here"
  }
}

• Example response: