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 deployment?

A Deployment is a cluster of hosts, assembled on a private VLAN and loaded with database and utility software to provide a high-availability, managed database. A deployment belongs to an account.

What information is a deployment configured with?

The database that a deployment is configured with is set by its type at creation time.

The location of the database, that is where it is run, is also set at creation time and may be a datacenter or cluster.

Updated 2 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.