API Reference

Authorization

The SqlDBM API is available for relational and Tx projects and uses authentication tokens to secure access to authorized users and processes. As scope and visibility differ slightly depending on the project type, please refer to the sections below for more information on creating and maintaining API authorization tokens.

API for relational projects

📘

Note

API tokens are set at the user level and enable individual access to the projects and project details that the token bearer can access in SqlDBM.

Before you begin, ensure that API access has been enabled for your account or contact us.

Generate a new API token

  1. To create a personal API token, log in to SqlDBM and, from the Dashboard, go to the Account options.


  1. Go to the "App Tokens" page to create and administer personal tokens.
  2. Tokens for relational projects can be seen under the "General" tab, which is selected by default.
  3. Create a new token by clicking on the "Create token" button.
  4. Provide a label and set the token properties.

  1. Copy the newly created token and store it securely.

🚧

Attention

The token value will not be accessible after the confirmation window is dismissed.

1782

Token created

📘

Note

Unless "Never expires" is selected, a token will only be valid for six months.


API for Tx projects

📘

Note

Unlike tokens for relational projects created at the user level, API tokens are set per project and environment. They are visible to all users that have been added to that project.

Before you begin, ensure that Tx is enabled for your account or contact us.

Generate a new API token

  1. To create a Tx project API token, log in to SqlDBM and, from the Dashboard, go to the Account options.


  1. Go to the "App Tokens" page to create and administer Tx tokens.

  2. Tokens for Tx projects are available under the "Tx environments" tab.

  3. Create a new token by clicking on the "Create token" button.


  1. Set the token properties.

    1. Select the project to which the token belongs.
    2. Select the project environment that the token has access to.

  2. Copy the newly created token and store it securely.

🚧

Attention

The token value will not be accessible after the confirmation window is dismissed.


📘

Note

A Tx token is only valid for six months.


Revoke or rotate an API token

If one of your API tokens has been compromised, you should revoke it and generate a new one to keep your information secure.

Revoke the token using the options on the screen.

1780

Revoke a token

Create a new one using the instructions on this page.