Elasticsearch API Documentation
Update Deployment
PUT {{baseUrl}}/deployments/:deployment_id?hide_pruned_orphans=false&skip_snapshot=false&validate_only=false&version=minim voluptate
Updates a Deployment.
Body
PARAM
| Key | Datatype | Required | Description |
hide_pruned_orphans
|
boolean | Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true) | |
skip_snapshot
|
boolean | Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true) | |
validate_only
|
boolean | If true, will just validate the Deployment definition but will not perform the update | |
version
|
string | If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request) |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string |
RESPONSES
status OK
Curl
curl -X PUT 'https://api.elastic-cloud.com/api/v1//deployments/:deployment_id?hide_pruned_orphans=false&skip_snapshot=false&validate_only=false&version=minim voluptate?hide_pruned_orphans=false&skip_snapshot=false&validate_only=false&version=minim voluptate' -H 'Content-Type: application/json' -d '{"prune_orphans":true,"metadata":{"tags":[{"key":"Ut sint in non","value":"do in irure"},{"key":"ullamco veniam","value":"Duis nulla eiusmod"}]},"settings":{"observability":{"metrics":{"destination":{"deployment_id":"sit eu irure sint","ref_id":"aliqua Ut labore ut"}},"logging":{"destination":{"deployment_id":"consectetur laboris do ut","ref_id":"officia ea aliqua laborum dolor"}}}},"name":"dolore dolore","resources":{"appsearch":[{"elasticsearch_cluster_ref_id":"quis veniam","plan":{"appsearch":{"user_settings_override_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_settings":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_override_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"docker_image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"cluster_topology":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"transient":{"plan_configuration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"strategy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"ref_id":"ipsum sint","region":"adipisicing cillum ea","display_name":"irure","settings":{"metadata":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}},{"elasticsearch_cluster_ref_id":"culpa eu nisi esse Duis","plan":{"appsearch":{"user_settings_override_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_settings":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_override_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"docker_image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"cluster_topology":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"transient":{"plan_configuration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"strategy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"ref_id":"incididunt","region":"non Excepteur sit","display_name":"ea laboris ullamco","settings":{"metadata":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}],"elasticsearch":[{"plan":{"cluster_topology":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"elasticsearch":{"user_settings_override_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"enabled_built_in_plugins":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_plugins":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_bundles":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"curation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_settings":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_override_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"docker_image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"node_attributes":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"autoscaling_enabled":true,"transient":{"plan_configuration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cluster_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"remote_clusters":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"restore_snapshot":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"strategy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"deployment_template":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"ref_id":"deserunt nulla ad","region":"sed labore","settings":{"monitoring":{"target_cluster_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"curation":{"specs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"ccs":{"remote_clusters":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"ip_filtering":{"rulesets":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snapshot":{"cron_expression":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"retention":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"traffic_filter":{"rulesets":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"trust":{"accounts":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"external":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"dedicated_masters_threshold":-78361074,"metadata":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"display_name":"ullamco velit ut"},{"plan":{"cluster_topology":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"elasticsearch":{"user_settings_override_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"enabled_built_in_plugins":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_plugins":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_bundles":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"curation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_settings":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_override_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"docker_image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"node_attributes":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"autoscaling_enabled":true,"transient":{"plan_configuration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cluster_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"remote_clusters":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"restore_snapshot":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"strategy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"deployment_template":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"ref_id":"Ut veniam do occaecat nostrud","region":"qui irure voluptate","settings":{"monitoring":{"target_cluster_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"curation":{"specs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"ccs":{"remote_clusters":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"ip_filtering":{"rulesets":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snapshot":{"cron_expression":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"interval":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"retention":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"traffic_filter":{"rulesets":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"trust":{"accounts":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"external":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"dedicated_masters_threshold":-35140101,"metadata":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"display_name":"magna enim labore anim"}],"kibana":[{"elasticsearch_cluster_ref_id":"ut non","plan":{"kibana":{"user_settings_override_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_settings":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_override_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"docker_image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"cluster_topology":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"transient":{"plan_configuration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"strategy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"ref_id":"consequat qui id magna","region":"ex dolore adipisicing enim","display_name":"tempor Ut","settings":{"metadata":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}},{"elasticsearch_cluster_ref_id":"aute qui velit ad nisi","plan":{"kibana":{"user_settings_override_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_settings":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_override_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"docker_image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"cluster_topology":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"transient":{"plan_configuration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"strategy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"ref_id":"irure esse dolore","region":"pariatur nulla do commodo","display_name":"ad irure dolore","settings":{"metadata":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}],"apm":[{"elasticsearch_cluster_ref_id":"est dolore in ex","plan":{"apm":{"user_settings_override_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_settings":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_override_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"docker_image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"cluster_topology":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"transient":{"plan_configuration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"strategy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"ref_id":"tempor eu in sint","region":"est ut veniam","display_name":"officia veniam","settings":{"metadata":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}},{"elasticsearch_cluster_ref_id":"aute nis","plan":{"apm":{"user_settings_override_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_json":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_settings":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_settings_override_yaml":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"docker_image":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"cluster_topology":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"transient":{"plan_configuration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"strategy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"ref_id":"laborum culpa est ullamco","region":"non ad","display_name":"magna anim","settings":{"metadata":{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}]}}'
ENDPOINTS