Skip to main content
The SabaothCloud API lets you automate what you do in the dashboard from scripts, CI pipelines and other tools. Requests are authenticated with an API key.

​
Base URL

All requests use HTTPS. Request and response bodies are JSON.

​
Authentication

  1. Create an API key in the dashboard under API Keys. See API keys.
  2. Send it in the Authorization header of every request:
API keys start with mpg_. A key belongs to one organization and can do only what both of these allow:
  • Your role in that organization
  • The scopes chosen when the key was created

​
Your first request

List the PostgreSQL services in an organization. You need the clusters:read scope.
Your organization ID is in the dashboard URL after /org/, for example https://sabaothcloud.com/dashboard/org/YOUR_ORG_ID/overview.

​
Errors

Errors return a non-2xx status code and a JSON body:
Some errors include a details object with more information.

​
Rate limits

When you send too many requests, the API responds with 429 and these headers:

​
Keep keys safe

  • Store keys in a secrets manager or your CI provider’s secret store, never in source code.
  • Give each key only the scopes it needs.
  • Revoke keys you no longer use, and immediately if one may have leaked.

​
API key endpoints

These endpoints create and manage API keys. They take a signed-in session token, not an API key, in the Authorization header. For most people, the simplest way to manage keys is the API Keys page in the dashboard.

Create an API key

POST /api-keys

List API keys

GET /api-keys

Get an API key

GET /api-keys/{id}

Revoke an API key

POST /api-keys/{id}/revoke

Delete an API key

DELETE /api-keys/{id}