Get Deployment

Server: https://api.elastic-cloud.com/api/v1

GET /deployments/{deployment_id}

Retrieves information about a Deployment.

Path Parameters

deployment_id string required: Identifier for the Deployment

Query Parameters

show_security boolean · default: false: Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials
show_metadata boolean · default: false: Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials
show_plans boolean · default: true: Whether to include the full current and pending plan information in the response - can be large per cluster
show_plan_logs boolean · default: false: Whether to include with the current and pending plan information the attempt log - can be very large per cluster
show_plan_history boolean · default: false: Whether to include the plan history with the current and pending plan information. The results can be very large per cluster. By default, if a given resource kind (e.g. Elasticsearch, Kibana, etc.) has more than 100 plans (which should be very rare, most likely caused by a bug) only 100 plans are returned for the given resource type: The first 10 plans, and the last 90 plans for that resource type. If ALL of the plans are desired, pass the force_all_plan_history parameter with a value of true.
show_plan_defaults boolean · default: false: If showing plans, whether to show values that are left at their default value (less readable but more informative)
convert_legacy_plans boolean · default: false: 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')
show_system_alerts integer · default: 0: 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.
show_settings boolean · default: false: Whether to show cluster settings in the response.
show_instance_metrics boolean · default: true: Whether to show resources instance metrics in the response.
show_instance_configurations boolean · default: true: If true, will return details for each instance configuration referenced by the deployment.
enrich_with_template boolean · default: true: If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on
force_all_plan_history boolean · default: false: Force show the entire plan history no matter how long. As noted in the show_plan_history parameter description, by default, a maximum of 100 plans are shown per resource. If true, this parameter overrides the default, and ALL plans are returned. Use with care as the plan history can be VERY large. Consider pairing with show_plan_logs=false.
clear_transient boolean · default: false: If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update

Responses

The Deployment info response

application/json

You are not authorized to perform this action.

application/json

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

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /deployments/{deployment_id}

curl Shell

curl -X GET "https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}"

Response

No example

Get Deployment

Path Parameters

Query Parameters

Responses

Response Headers

Response Headers