Get Deployment

Retrieves information about a Deployment.

Request

GET /api/v1/deployments/{deployment_id}

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

Query parameters

Name Type Required Description

convert_legacy_plans

boolean; default: false

N

If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')

enrich_with_template

boolean; default: true

N

If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on

show_metadata

boolean; default: false

N

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

show_plan_defaults

boolean; default: false

N

If showing plans, whether to show values that are left at their default value (less readable but more informative)

show_plan_history

boolean; default: false

N

Whether to include with the current and pending plan information the plan history- can be very large per cluster

show_plan_logs

boolean; default: false

N

Whether to include with the current and pending plan information the attempt log - can be very large per cluster

show_plans

boolean; default: true

N

Whether to include the full current and pending plan information in the response - can be large per cluster

show_security

boolean; default: false

N

Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials

show_settings

boolean; default: false

N

Whether to show cluster settings in the response.

show_system_alerts

integer; default: 0

N

Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.

Responses

200

(DeploymentGetResponse) The Deployment info response

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
401

(BasicFailedReply) You are not authorized to perform this action.

404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found])
The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id} \
-H "Authorization: ApiKey $ECE_API_KEY"