API Reference

Authorization

📘

Note

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

Prerequisites

Before you begin, ensure that you have the following prerequisites:

  • You have a Standard Enterprise SqlDBM account.
  • API access has been enabled for your account by opening a support ticket.

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.
1780

Access the account options

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

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

1780

Create a new token

1780

Create a label

  1. Copy the newly-created token and store it in a safe place.

🚧

Attention

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

1782

Token created

📘

Note

Once created, a token will be valid for a period of six months.

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.

Follow the instructions for generating a new token to access the App tokens page.

Revoke the token using the options on the screen.

1780

Revoke a token

Next, follow the rest of the instructions for generating an API token to create a new one.