Using the SqlDBM API

Interacting with your data model through a programmatic interface unlocks exciting options for data developers and engineers. From sharing documentation with data catalogs 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 (coming soon) existing projects with new objects.

📣

Try the API today!

The API is an extention to SqlDBM, available on request. Please reach out to us if you're interested so we can enable it for your account.

Get in touch

Review the request types below and try them directly from this page or find a link to our Swagger index here: https://api.sqldbm.com/swagger/index.html

Request types

GET API is currently available for project and dbt properties.

POST API is coming soon.

📘

Note

GET - The ability to receive information about project objects and changes in JSON and DDL format.

POST - The ability to update DDL or metadata programatically in SqlDBM projects

Rate limiting

Your app's requests to the REST API are evaluated per method. Currently, the limit for API calls per minute is 100,000 credits. Each REST API method is assigned one of the rate limit weight levels.

If the number of requests exceeds the limit, a standard 429 Too many requests error is returned:

{
  "status": 429,
  "type": "Too many requests",
  "message": "Request rejected due to high inbound volume."
}

Account plans and roles

APIs are only available on the Standard Enterprise plan. You can only access the API with a Modeler or Admin role. The goal of providing these additional capabilities for Enterprise users is to enable a consistent and secure user experience while creating your custom solutions.

Commands

List of commands for getting project metadata, DDL, and alter scripts

List of commands for getting dbt Source and Model YAML

Errors

Here is an overview of error codes that you may encounter:

Example:

{
  "status": 400,
  "type": "Invalid Syntax",
  "message": "The API call was not formed correctly."
}