/2016-07/deployments/:id

Fetch information about a specific deployment accessible to your user.

This endpoint returns a single deployment associated with the deployment id used in the path parameters. It returns the same information as the /2016-07/deployments endpoint along with the deployment's connection strings. The key/values of deployment objects are detailed below.

Returned JSON

Key

Description

id

The deployment id. Same id as the one used in the path parameters.

account_id

The account id associated with the deployment.

name

The name that was given to the deployment.

created_at

The date that the deployment was created.

notes

The notes associated with the deployment.

customer_billing_code

The editable billing code associated with the deployment.

cluster_id

The id of the cluster that this deployment is deployed on.

version

The current version number of the database within the deployment.

ca_certificate_base64

A base64 CA Certificate to be used by clients connecting to the database when it is deployed to verify SSL connections.

connection_strings.direct

An array of connection strings. The array elements are URLs to be used by applications to connect to the database.

connection_strings.cli

An array of connection strings. The array elements are command line/shell commands for connecting from the console to the database.

connection_strings.maps

Address translation map for Scylla deployments.

connection_strings.ssh

Connection string for SSH tunnels.

connection_strings.health

The connection string querying the health of the deployment.

connection_strings.admin

The connection string (usually as URL) for connecting to the deployment's web based administration front-end.

connection_strings.misc

Miscellaneous, database-specific connections strings for particular tools or configurations.

Returned Links

One or more of the following links will be present in the JSON _links object. All links are in templated format, meaning that an {?embed} string within the link is the template's marker to add further parameters

Link

Description

compose_web_ui

A URL which serves as a link to the Compose console where this deployment can be administered from a browser.

scalings

A URI for an endpoint which offers scaling information about this deployment.

backups

A URI for an endpoint which offers backups and information about backups for this deployment.

alerts

A URI for an endpoint which offers information on the health of this deployment.

cluster

A URI which returns information on the cluster where this deployment resides.

Language
Authentication
Header
Click Try It! to start a request and see the response here!