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.


What is a cluster?

Clusters are collections of servers on a cloud platform which are configured to play host to Deployments.

Clusters are made available to customers directly through Compose Enterprise. Each cluster has an id number. The Compose API allows enterprise customers to deploy to their own enterprise clusters by specifying the id of the Enterprise cluster at deployment time. Compose Enterprise Clusters can also have user-defined tags associated with them for identification and provisioning selection purposes.

Updated 3 years ago

What's Next



Suggested Edits are limited on API Reference Pages

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