The ability to interface with your data model through a programmatic interface unlocks many interesting possibilities for data developers and engineers. From sharing content with users and tools in the BI stack to automating a CICD pipeline, APIs unlock a world of possibilities for engaging with SqlDBM models.

Our API provides you with the tools to securely extract metadata from SqlDBM and update existing projects with new objects.

Up-to-date details, interactive sandbox, and recipes are available on our developer reference page:

https://developers.sqldbm.com/reference/

Authorization

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.

releasing the GET API, with POST support coming soon

To enable API access for your account, please open a support ticket.

Once enabled, follow the steps below to generate an API token.

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.

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

3. Set token type to GET, POST, and GET and POST to perform corresponding API actions.

Give your token a meaningful label and set the expiry option accordingly. Tokens have a default lifetime of 180 days unless the "Never expires" checkbox is selected.

IMPORTANT! All previously created tokens are set to GET by default. To add POST functionality you need to create new token with corresponding type.

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

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

Note

Once created, a token will be valid for a period of six months unless the "Never expires" option is selected.

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.

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

Request types

The following requests are available: