Personal Access Token

You can use Personal Access Tokens (PAT) to establish connections to the databases when connecting with other tools using JDBC, ODBC, ADO.NET, or WebSockets connection or as passwords to perform actions using the REST API. You can easily create personal access tokens for different types of access to the database or web console and revoke them when they aren't needed anymore.

Scope of personal access tokens

Personal access tokens are related to some pre-defined scopes that control access to the database and the Rest API. The following table describes the available options that you can use when you create a personal access token.

Category Scope Description
Database Use

Allows to view and connect to databases that you have access to.
Use & Operate

Allows full access to the database including:

  • Creating a database
  • Starting or stopping the database
  • Creating new clusters
  • Deleting a cluster
  • Connecting to clusters

Selecting Use & Operate scope automatically applies Use scope for the token.
Users Read Allows to see the list of users in the organization.
Read & Write

Allows to invite or remove users in your organization.

Selecting Read & Write scope automatically applies Read scope for the token.
Security Read Allows to read the IP addresses in the allowed list.
Read & Write

Allows to add or remove IP addresses from the allowed list.

Selecting Read & Write scope automatically applies Read scope for the token.
Billing Read Allows to view the current billing information, including credit card details.
Read & Write

Allows to update billing details, such as adding new or updating credit card details.

Selecting Read & Write scope automatically applies Read scope for the token.
Monitoring Read Allows to view the usage details for the organization, including compute, storage, and network usage.

Create a personal access token

Do the following to create a personal token:

  1. In the web console, click your name displayed on the top right corner of the page to open your profile menu. Select Personal access token from the menu, as shown below: 

  2. Click the Create token button.
  3. In the Create personal access token page, enter the following details:
    • Token name: Enter a name or description for the token.
    • Token scope: Select scopes for the token you are generating. See Scope of personal access tokens for more details.

      • Generate Token

  4. Click the Generate button.
  5. If your profile is not complete, you may need to complete your profile, including adding your credit card details.
  6. Copy the generated token and close the UI message.

    The token is only shown once. If you do not copy the token, you cannot retrieve it later.

Revoke a token

Do the following to revoke a token:

  1. In the web console, click your username and select Personal access tokens from the drop-down menu.

  2. Click More on the token you want to revoke, then click Revoke.

  3. In the confirmation window, click Revoke.