REST API Tokens

REST API tokens are a useful tool for accessing TileDB Cloud assets programmatically.

You can allow external applications to interact with your TileDB Cloud objects by creating REST API tokens. Each REST API token can be given a scope based on the application.

You do not need to create a REST API token when working directly inside of a TileDB Cloud notebook environment. TileDB Cloud automatically creates a temporary REST API token and stores it inside of the $TILEDB_REST_TOKEN environment variable during server launch.

To view your REST API tokens:

1. Log in to TileDB Cloud and go to your individual profile’s Settings.
2. Select the API tokens tab.

If this is your first time creating a REST API token, the API tokens tab will look like this:

To add a REST API token to your TileDB Cloud account, perform the following:

1. Select Create API Token.
2. Specify a Token name for the token. If no Token name is set, TileDB Cloud SaaS will generate a name automatically.
3. Specify an Expiration for the token. If no Expiration is set, the token will expire in 30 minutes.
4. Specify a Scope for the token.
5. Select Create.

You will see a list of your REST API tokens and the following details:

• The Name of the token.
• The Scope of the token.
• The last 7 characters of the Token, truncated for privacy.
• When the token was Issued.
• When the token Expires.
• The token’s Status.

You can revoke a REST API token by selecting the red trash can icon to the right of the token, checking the I acknowledge the consequences checkbox in the Revoke token modal, and selecting the red Revoke button.