This is the older REST API and is now deprecated.
Go to the dedicated apidocs.compose.com for details of the current API which works with all Compose databases with the exception of the MongoDB Classic deployments.
The REST API allows you to interact with Compose account and hosted databases with an easy to use JSON API over HTTPS. You will be able to do things such as create, view, and destroy Elastic Deployments and databases, as well as trigger and download backups. If you are looking to interact with the data in your database, it is best to use your language's default MongoDB driver.
To start using the Compose REST API, you will need to do the following:
The base API end point is
https://api.compose.io. The following headers must be included in every request:
The sections of the REST API documentation are listed here:
- Historical Logs
- MongoDB Databases
- MongoDB Collections
- MongoDB Indexes
- MongoDB Documents
- MongoDB Users
If this article didn't solve things, summon a human and get some help!
Updated about a year ago