Authorizations
Path Parameters
(Required) Identifier for the Deployment
"<string>"
Query Parameters
Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials
"false"
Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials
"false"
Whether to include the full current and pending plan information in the response - can be large per cluster
"true"
Whether to include with the current and pending plan information the attempt log - can be very large per cluster
"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.
"false"
If showing plans, whether to show values that are left at their default value (less readable but more informative)
"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')
"false"
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.
"0"
Whether to show cluster settings in the response.
"false"
If true, will return details for each instance configuration referenced by the deployment.
"true"
If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on
"true"
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.
"false"
If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
"false"
Response
The Deployment info response
"<string>"
"<boolean>"
"<string>"
[
{
"config_version": "<integer>",
"cpu_multiplier": "<double>",
"description": "<string>",
"discrete_sizes": {
"default_size": "<integer>",
"resource": "storage",
"sizes": ["<integer>"]
},
"id": "<string>",
"instance_type": "apm",
"max_zones": "<integer>",
"metadata": {},
"name": "<string>",
"node_types": ["<string>"],
"storage_multiplier": "<double>"
}
]"<string>"