List Deployments

  • GET /deployments
Auth

List Deployments.

Responses

The list of deployments that belong to the authenticated user.

application/json
deployments object[] required

The deployments

id string required

The id of this deployment

name string required

The name of this deployment

resources object[] required

List of resources in this deployment

ref_id string required

A locally-unique friendly alias for this Elasticsearch cluster

elasticsearch_cluster_ref_id string

The Elasticsearch cluster that this resource depends on.

id string required

A system-unique id for the created resource

kind string required

The kind of resource

region string required

Identifier of the region in which this resource runs.

cloud_id string

An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana

credentials object

The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster create command.

username string required

The username of the newly created cluster

password string required

The password of the newly created cluster

secret_token string

Secret token for using a created resource. Only provided on initial create and absent otherwise.

warnings object[]

List of warnings generated from validating resource updates

code string required

A structured code representing the error type that occurred

message string

A human readable message describing the warning that occurred

You are not authorized to perform this action.

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields