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.

Documentation

About the Compose API

A quick introduction to the API and its capabilities

The Compose API currently comprises of a set of REST endpoints which allow developers to

  • Query account information
  • Query deployments available to an account
  • Create new database deployments
  • Track the progress of creation of new deployments and other jobs

Consult the The Compose API reference section for details of those REST endpoints, or continue here for an introduction to the API, concepts, terms and general information needed to understand how you can programmatically control Compose.


About the Compose API

A quick introduction to the API and its capabilities