Path parameters
-
Identifier for the Deployment
Query parameters
-
hide_pruned_orphans boolean
Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true)
Default value is
false
. -
skip_snapshot boolean
Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true)
Default value is
false
. -
validate_only boolean
If true, will just validate the Deployment definition but will not perform the update
Default value is
false
. -
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)
Body Required
The deployment definition
-
name string
A new name for the deployment, otherwise stays the same.
-
Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well.
-
resources object
New information about the Resources that will have this Deployment, otherwise they stay the same
Additional properties are allowed.
-
settings object
Any new configuration for the current deployment object. If there is no new configuration the value is unchanged.
Additional properties are allowed.
-
metadata object
Any new information about the current deployment object. If there is no new information the value is unchanged.
Additional properties are allowed.
-
alias string
A user-defined alias to use in place of Cluster IDs for user-friendly URLs
curl \
-X PUT https://api.elastic-cloud.com/api/v1/deployments/{deployment_id} \
-d '{"name":"string","prune_orphans":true,"resources":{"elasticsearch":[{"ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"id":"string","node_type":{"master":true,"data":true,"ingest":true,"ml":true},"node_roles":["master"],"zone_count":42,"elasticsearch":{"version":"string","docker_image":"string","system_settings":{"scripting":{"painless_enabled":true,"mustache_enabled":true,"expressions_enabled":true,"stored":{"enabled":true,"sandbox_mode":true},"file":{"enabled":true,"sandbox_mode":true},"inline":{"enabled":true,"sandbox_mode":true}},"reindex_whitelist":["string"],"auto_create_index":true,"enable_close_index":true,"destructive_requires_name":true,"watcher_trigger_engine":"string","default_shards_per_index":42,"monitoring_collection_interval":42,"monitoring_history_duration":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","enabled_built_in_plugins":["string"],"user_plugins":[{"name":"string","url":"string","elasticsearch_version":"string"}],"user_bundles":[{"name":"string","url":"string","elasticsearch_version":"string"}],"curation":{"from_instance_configuration_id":"string","to_instance_configuration_id":"string"},"node_attributes":{"additionalProperty1":"string","additionalProperty2":"string"}},"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"autoscaling_min":{"value":42,"resource":"memory"},"autoscaling_max":{"value":42,"resource":"memory"},"autoscaling_policy_override_json":{},"topology_element_control":{"min":{"value":42,"resource":"memory"}},"autoscaling_tier_override":true}],"elasticsearch":{"version":"string","docker_image":"string","system_settings":{"scripting":{"painless_enabled":true,"mustache_enabled":true,"expressions_enabled":true,"stored":{"enabled":true,"sandbox_mode":true},"file":{"enabled":true,"sandbox_mode":true},"inline":{"enabled":true,"sandbox_mode":true}},"reindex_whitelist":["string"],"auto_create_index":true,"enable_close_index":true,"destructive_requires_name":true,"watcher_trigger_engine":"string","default_shards_per_index":42,"monitoring_collection_interval":42,"monitoring_history_duration":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","enabled_built_in_plugins":["string"],"user_plugins":[{"name":"string","url":"string","elasticsearch_version":"string"}],"user_bundles":[{"name":"string","url":"string","elasticsearch_version":"string"}],"curation":{"from_instance_configuration_id":"string","to_instance_configuration_id":"string"},"node_attributes":{"additionalProperty1":"string","additionalProperty2":"string"}},"deployment_template":{"id":"string","version":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"skip_snapshot":true,"max_snapshot_attempts":42,"max_snapshot_age":42,"extended_maintenance":true,"cluster_reboot":"forced"},"restore_snapshot":{"repository_name":"string","snapshot_name":"string","repository_config":{"raw_settings":{}},"restore_payload":{"indices":["string"],"raw_settings":{}},"strategy":"partial","source_cluster_id":"string"},"remote_clusters":{"resources":[{"deployment_id":"string","elasticsearch_ref_id":"string","alias":"string","skip_unavailable":true}]},"cluster_settings_json":{}},"autoscaling_enabled":true},"settings":{"snapshot":{"interval":"string","retention":{"snapshots":42,"max_age":"string"},"cron_expression":"string"},"monitoring":{"target_cluster_id":"string"},"metadata":{"name":"string"},"curation":{"specs":[{"index_pattern":"string","trigger_interval_seconds":42}]},"dedicated_masters_threshold":42,"traffic_filter":{"rulesets":["string"]},"trust":{"accounts":[{"account_id":"string","name":"string","trust_all":true,"trust_allowlist":["string"]}],"external":[{"trust_relationship_id":"string","name":"string","trust_all":true,"trust_allowlist":["string"]}],"direct":[{"uid":"string","name":"string","type":"ECE","trust_all":true,"trust_allowlist":["string"],"scope_id":"abc123","additional_node_names":["string"],"certificates":[{"pem":"string"}]}]},"keystore_contents":{"secrets":{"additionalProperty1":{"value":{},"as_file":true},"additionalProperty2":{"value":{},"as_file":true}}}}}],"kibana":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"zone_count":42,"kibana":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","elasticsearch_username":"string","elasticsearch_password":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"}}],"kibana":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","elasticsearch_username":"string","elasticsearch_password":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}],"apm":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"zone_count":42,"apm":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"}}],"apm":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}],"appsearch":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"node_type":{"appserver":true,"worker":true},"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"zone_count":42,"appsearch":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"}}],"appsearch":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}],"enterprise_search":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"node_type":{"appserver":true,"worker":true,"connector":true},"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"zone_count":42,"enterprise_search":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"allocator_filter":{},"node_configuration":"string","memory_per_node":{},"node_count_per_zone":{}}],"enterprise_search":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}],"integrations_server":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"zone_count":42,"integrations_server":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","mode":"standalone"}}],"integrations_server":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","mode":"standalone"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}]},"settings":{"observability":{"logging":{"destination":{"deployment_id":"string","ref_id":"string"}},"metrics":{"destination":{"deployment_id":"string","ref_id":"string"}}},"autoscaling_enabled":true,"auto_ops":{"status":"connected"}},"metadata":{"tags":[{"key":"string","value":"string"}]},"alias":"string"}'
{
"name": "string",
"prune_orphans": true,
"resources": {
"elasticsearch": [
{
"ref_id": "string",
"display_name": "string",
"region": "string",
"plan": {
"cluster_topology": [
{
"id": "string",
"node_type": {
"master": true,
"data": true,
"ingest": true,
"ml": true
},
"node_roles": [
"master"
],
"zone_count": 42,
"elasticsearch": {
"version": "string",
"docker_image": "string",
"system_settings": {
"scripting": {
"painless_enabled": true,
"mustache_enabled": true,
"expressions_enabled": true,
"stored": {
"enabled": true,
"sandbox_mode": true
},
"file": {
"enabled": true,
"sandbox_mode": true
},
"inline": {
"enabled": true,
"sandbox_mode": true
}
},
"reindex_whitelist": [
"string"
],
"auto_create_index": true,
"enable_close_index": true,
"destructive_requires_name": true,
"watcher_trigger_engine": "string",
"default_shards_per_index": 42,
"monitoring_collection_interval": 42,
"monitoring_history_duration": "string"
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"enabled_built_in_plugins": [
"string"
],
"user_plugins": [
{
"name": "string",
"url": "string",
"elasticsearch_version": "string"
}
],
"user_bundles": [
{
"name": "string",
"url": "string",
"elasticsearch_version": "string"
}
],
"curation": {
"from_instance_configuration_id": "string",
"to_instance_configuration_id": "string"
},
"node_attributes": {
"additionalProperty1": "string",
"additionalProperty2": "string"
}
},
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"autoscaling_min": {
"value": 42,
"resource": "memory"
},
"autoscaling_max": {
"value": 42,
"resource": "memory"
},
"autoscaling_policy_override_json": {},
"topology_element_control": {
"min": {
"value": 42,
"resource": "memory"
}
},
"autoscaling_tier_override": true
}
],
"elasticsearch": {
"version": "string",
"docker_image": "string",
"system_settings": {
"scripting": {
"painless_enabled": true,
"mustache_enabled": true,
"expressions_enabled": true,
"stored": {
"enabled": true,
"sandbox_mode": true
},
"file": {
"enabled": true,
"sandbox_mode": true
},
"inline": {
"enabled": true,
"sandbox_mode": true
}
},
"reindex_whitelist": [
"string"
],
"auto_create_index": true,
"enable_close_index": true,
"destructive_requires_name": true,
"watcher_trigger_engine": "string",
"default_shards_per_index": 42,
"monitoring_collection_interval": 42,
"monitoring_history_duration": "string"
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"enabled_built_in_plugins": [
"string"
],
"user_plugins": [
{
"name": "string",
"url": "string",
"elasticsearch_version": "string"
}
],
"user_bundles": [
{
"name": "string",
"url": "string",
"elasticsearch_version": "string"
}
],
"curation": {
"from_instance_configuration_id": "string",
"to_instance_configuration_id": "string"
},
"node_attributes": {
"additionalProperty1": "string",
"additionalProperty2": "string"
}
},
"deployment_template": {
"id": "string",
"version": "string"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"skip_snapshot": true,
"max_snapshot_attempts": 42,
"max_snapshot_age": 42,
"extended_maintenance": true,
"cluster_reboot": "forced"
},
"restore_snapshot": {
"repository_name": "string",
"snapshot_name": "string",
"repository_config": {
"raw_settings": {}
},
"restore_payload": {
"indices": [
"string"
],
"raw_settings": {}
},
"strategy": "partial",
"source_cluster_id": "string"
},
"remote_clusters": {
"resources": [
{
"deployment_id": "string",
"elasticsearch_ref_id": "string",
"alias": "string",
"skip_unavailable": true
}
]
},
"cluster_settings_json": {}
},
"autoscaling_enabled": true
},
"settings": {
"snapshot": {
"interval": "string",
"retention": {
"snapshots": 42,
"max_age": "string"
},
"cron_expression": "string"
},
"monitoring": {
"target_cluster_id": "string"
},
"metadata": {
"name": "string"
},
"curation": {
"specs": [
{
"index_pattern": "string",
"trigger_interval_seconds": 42
}
]
},
"dedicated_masters_threshold": 42,
"traffic_filter": {
"rulesets": [
"string"
]
},
"trust": {
"accounts": [
{
"account_id": "string",
"name": "string",
"trust_all": true,
"trust_allowlist": [
"string"
]
}
],
"external": [
{
"trust_relationship_id": "string",
"name": "string",
"trust_all": true,
"trust_allowlist": [
"string"
]
}
],
"direct": [
{
"uid": "string",
"name": "string",
"type": "ECE",
"trust_all": true,
"trust_allowlist": [
"string"
],
"scope_id": "abc123",
"additional_node_names": [
"string"
],
"certificates": [
{
"pem": "string"
}
]
}
]
},
"keystore_contents": {
"secrets": {
"additionalProperty1": {
"value": {},
"as_file": true
},
"additionalProperty2": {
"value": {},
"as_file": true
}
}
}
}
}
],
"kibana": [
{
"ref_id": "string",
"elasticsearch_cluster_ref_id": "string",
"display_name": "string",
"region": "string",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"zone_count": 42,
"kibana": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string"
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string"
}
}
],
"kibana": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string"
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"extended_maintenance": true,
"cluster_reboot": "forced"
}
}
},
"settings": {
"metadata": {
"name": "string"
}
}
}
],
"apm": [
{
"ref_id": "string",
"elasticsearch_cluster_ref_id": "string",
"display_name": "string",
"region": "string",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"zone_count": 42,
"apm": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string"
}
}
],
"apm": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"extended_maintenance": true,
"cluster_reboot": "forced"
}
}
},
"settings": {
"metadata": {
"name": "string"
}
}
}
],
"appsearch": [
{
"ref_id": "string",
"elasticsearch_cluster_ref_id": "string",
"display_name": "string",
"region": "string",
"plan": {
"cluster_topology": [
{
"node_type": {
"appserver": true,
"worker": true
},
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"zone_count": 42,
"appsearch": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_session_key": "string"
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string"
}
}
],
"appsearch": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_session_key": "string"
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"move_instances": [
{
"from": "string",
"to": [
"string"
],
"instance_down": true
}
],
"move_allocators": [
{
"from": "string",
"to": [
"string"
],
"allocator_down": true
}
],
"reallocate_instances": true,
"preferred_allocators": [
"string"
],
"extended_maintenance": true,
"cluster_reboot": "forced"
}
}
},
"settings": {
"metadata": {
"name": "string"
}
}
}
],
"enterprise_search": [
{
"ref_id": "string",
"elasticsearch_cluster_ref_id": "string",
"display_name": "string",
"region": "string",
"plan": {
"cluster_topology": [
{
"node_type": {
"appserver": true,
"worker": true,
"connector": true
},
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"zone_count": 42,
"enterprise_search": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_session_key": "string"
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string"
},
"allocator_filter": {},
"node_configuration": "string",
"memory_per_node": {},
"node_count_per_zone": {}
}
],
"enterprise_search": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_session_key": "string"
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"move_instances": [
{
"from": "string",
"to": [
"string"
],
"instance_down": true
}
],
"move_allocators": [
{
"from": "string",
"to": [
"string"
],
"allocator_down": true
}
],
"reallocate_instances": true,
"preferred_allocators": [
"string"
],
"extended_maintenance": true,
"cluster_reboot": "forced"
}
}
},
"settings": {
"metadata": {
"name": "string"
}
}
}
],
"integrations_server": [
{
"ref_id": "string",
"elasticsearch_cluster_ref_id": "string",
"display_name": "string",
"region": "string",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"zone_count": 42,
"integrations_server": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"mode": "standalone"
}
}
],
"integrations_server": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"mode": "standalone"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"extended_maintenance": true,
"cluster_reboot": "forced"
}
}
},
"settings": {
"metadata": {
"name": "string"
}
}
}
]
},
"settings": {
"observability": {
"logging": {
"destination": {
"deployment_id": "string",
"ref_id": "string"
}
},
"metrics": {
"destination": {
"deployment_id": "string",
"ref_id": "string"
}
}
},
"autoscaling_enabled": true,
"auto_ops": {
"status": "connected"
}
},
"metadata": {
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"alias": "string"
}
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string
# Payload
{
"id": "string",
"name": "string",
"alias": "string",
"resources": [
{
"ref_id": "string",
"elasticsearch_cluster_ref_id": "string",
"id": "string",
"kind": "string",
"region": "string",
"cloud_id": "string",
"credentials": {
"username": "string",
"password": "string"
},
"secret_token": "string",
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
],
"shutdown_resources": {
"elasticsearch": [
{
"id": "string",
"dependents": [
{
"id": "string",
"kind": "string"
}
]
}
],
"kibana": [
"string"
],
"apm": [
"string"
],
"appsearch": [
"string"
],
"enterprise_search": [
"string"
],
"integrations_server": [
"string"
]
},
"diagnostics": {
"creates": {
"elasticsearch": [
{
"ref_id": "string",
"display_name": "string",
"backend_plan": {}
}
],
"kibana": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
],
"apm": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
],
"integrations_server": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
],
"appsearch": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
],
"enterprise_search": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
]
},
"updates": {
"elasticsearch": [
{
"ref_id": "string",
"display_name": "string",
"backend_plan": {}
}
],
"kibana": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
],
"apm": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
],
"integrations_server": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
],
"appsearch": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
],
"enterprise_search": [
{
"ref_id": "string",
"display_name": "string",
"elasticsearch_cluster_ref_id": "string",
"backend_plan": {}
}
]
}
},
"settings": {
"traffic_filter_settings": {
"rulesets": [
"string"
]
},
"observability": {
"logging": {
"destination": {
"deployment_id": "string",
"ref_id": "string"
}
},
"metrics": {
"destination": {
"deployment_id": "string",
"ref_id": "string"
}
}
},
"autoscaling_enabled": true,
"auto_ops": {
"status": "connected"
},
"solution_type": "string"
}
}
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}