get https://api.compose.io/2016-07/deployments
Fetch information about all the deployments accessible to your user.
This endpoint returns all deployments associated with the accounts returned by the /2016-07/accounts
endpoint. It returns an _embedded
object with a deployments
key who's value is an array of deployment objects. The key/values of deployment objects are detailed below.
Returned JSON
deployments object key | Description |
---|---|
id | The deployment id, used when addressing a specific deployment in the API. |
name | The name that was given to the deployment. |
type | The type of database that this deployment contains. |
created_at | The time and date of when the deployment was created. Encoded as an ISO 8601 format timestamp. |
notes | The notes associated with the deployment. |
customer_billing_code | The editable billing code associated with the deployment. |
_links.compose_web_ui.href | A URL which serves as a link to the Compose console where this deployment can be administered from a browser. |
_links.compose_web_ui.templated | Is the above link in a templated format. Currently true. {?embed} is the template marker to add further parameters. |