Compose API Documentation

Compose's API gives developers and users programmatic control over the database deployment capabilities of the database-as-a-service platform. Here you'll find the information you need to take the controls.


Authorization and how to get it

Authorization to access the API is granted upon presenting an appropriate Personal API Token. These can be obtained from the Compose console, under Account and API Tokens. You will be prompted for your user password.

You will arrive at the Personal API Tokens view.

This view shows:

  • The current API version (the arrow next to the API version will be a link to the documentation, this site).
  • Existing API tokens, each with a descriptive name and date created and the option to revoke that token,
  • A Create a new API token text field. Enter a name for your new token and click Create. The display will now show the new token like so:

Ensure that you do copy this API token as there is no way for it to be displayed again. You will only ever be able to revoke it and create a new API token.

Updated 2 years ago

Authorization and how to get it

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.