Generate API token

Note

This feature is available in Enterprise, AWS, Team editions only.

Overview

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

Note

Tokens are available only for administrators. Each administrator must create their own tokens.

How to generate API token

1. Navigate to your Profile page in the CloudBeaver.

2. Open the API Token tab.

1. Click + Add.

Note

Users can create up to 5 tokens.

1. Choose Name and Expiration period. You can choose from options like 1 day, 1 week, 1 moth, 1 year, or no expiration (not recommended for security reasons).

2. Copy the token after it’s generated.

Important

Tokens are displayed only once during creation.

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: