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.

Guides

What is a deployment type?

Database deployments are created according to a template and that template is selected by the deployment's type.

What kind of deployment types are there?

These are the major type names. Each has various versions associated with it which reflect the release version scheme of the underlying database technology.

typeDatabase/Service
mongodbMongoDB
redisRedis
postgresqlPostgreSQL
elastic_searchElasticsearch
rethinkRethinkDB
rabbitmqRabbitMQ
etcdetcd
scyllaScyllaDB
mysqlMySQL
disqueDisque

❗️

mongodb-shard type

If MongoDB is deployed under an account, for every mongodb deployment, there will be a mongodb-shard deployment which shares its deployment name. This is a child deployment of the mongodb deployment and API calls directed to the mongodb-shard will fail. Direct any API calls for the MongoDB database to the mongodb parent deployment.

🚧

No MongoDB Classic

MongoDB Classic is not available, and will never be available for deployment through the API.

Updated 4 years ago


What's Next

Recipes

Types


Suggested Edits are limited on API Reference Pages

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