Compose Database-as-a-Service Help and Documentation

Everything you need to know about Compose, Hosted or Enterprise, is here in our help system. Whether you run one database for your businesses' sole application or six different databases to support an entire corporation, we've got the information you need.

Introduction

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.

Getting Started

To start using the Compose REST API, you will need to do the following:

  1. Sign up for an account at Compose.io.
  2. Create a Personal Access Token for access to the API.

The base API end point is https://api.compose.io. The following headers must be included in every request:

Required Headers:

Header
Description

Authorization

Bearer PERSONAL_ACCESS_TOKEN

Content-Type

application/json

Accept-Version

2014-06

API Documentation

The sections of the REST API documentation are listed here:


Still Need Help?

If this article didn't solve things, summon a human and get some help!

Introduction