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.

Documentation

Deployment update now available

The Compose API team has added a new endpoint to that allows API users to set the deployment's notes and customer_billing_code fields. These fields were added to allow users to attach a short note and a sortable code to the deployments. See Compose Notes on Compose Notes.

PATCH https://api.compose.com/2016-07/deployments/:id

Here is an example of updating an existing deployment

curl -X PATCH 'https://api.compose.com/2016-07/deployments/593a6d32ea0d2c00146e703e' \
 -H "Authorization: Bearer $COMPOSEAPITOKEN" \
 -H "Content-Type: application/json; charset=utf-8" \
 -d '{"deployment": {"notes":"Updated notes","customer_billing_code":"Update customer code"}}'

The following is a sample response:

{
  "id":"5939135f8aab53000",
  "account_id":"5858fe0fb20b3c0000000",
  "name":"affable-rabbitmq-22",
  "type":"rabbitmq",
  "created_at":"2017-06-08T09:05:35.240Z",
  "notes":"Updated Notes",
  "customer_billing_code":"Updated Billing Code",
  "_links":{
    "compose_web_ui":{
      "href":"https://app.compose.io/compose-io-8/deployments/affable-rabbitmq-22{?embed}",
      "templated":true
    },
    "scalings":{
      "href":"https://api.compose.io/2016-07/deployments/5939135f8aab53000/scalings{?embed}",
      "templated":true
    },
    "backups":{
      "href":"https://api.compose.io/2016-07/deployments/5939135f8aab53000/backups{?embed}",
      "templated":true
    },
    "alerts":{
      "href":"https://api.compose.io/2016-07/deployments/5939135f8aab53000/alerts{?embed}",
      "templated":true
    },
    "cluster":{
      "href":"https://api.compose.io/2016-07/clusters/5939135f8aab53000{?embed}",
      "templated":true
    }
  }
}

Changelog

added
PATCH https://api.compose.com/2016-07/deployments/:id