Create Deployment
editCreate Deployment
editCreates a Deployment.
Request
editPOST /api/v1/deployments
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
An optional idempotency token - if two create requests share the same request_id token (min size 32 characters, max 128) then only one deployment will be created, the second request will return the info of that deployment (in the same format described below, but with blanks for auth-related fields) |
|
|
N |
An optional template id - if present, the referenced template will be used to fill in the resources field of the deployment creation request. If any resources are present in the request together with the template, the ones coming in the request will prevail and no merging with the template will be performed. |
|
|
N |
If true, will just validate the Deployment definition but will not perform the creation |
Request body
edit(DeploymentCreateRequest
) (required) The deployment definition
Responses
edit-
200
-
The request was valid (used when validate_only is true).
-
201
-
The request was valid and a new deployment was created
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
-
-
202
-
The request was valid and deployment creation had already been started.
-
400
-
The deployment request had errors.
-
401
-
You are not authorized to perform this action.
Request example
editcurl -XPOST https://{{hostname}}/api/v1/deployments \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "alias" : "string", "metadata" : { "system_owned" : true, "tags" : [ { "key" : "string", "value" : "string" } ] }, "name" : "string", "region" : "string", "resources" : { "apm" : [ { "display_name" : "string", "elasticsearch_cluster_ref_id" : "string", "plan" : { "apm" : { "docker_image" : "string", "system_settings" : { "debug_enabled" : true, "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "kibana_url" : "string", "secret_token" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "cluster_topology" : [ { "apm" : { "docker_image" : "string", "system_settings" : { "debug_enabled" : true, "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "kibana_url" : "string", "secret_token" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "instance_configuration_id" : "string", "instance_configuration_version" : 0, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "override_failsafe" : true, "preferred_allocator_tags" : { "some_property" : "string" }, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } } }, "ref_id" : "string", "region" : "string", "settings" : { "metadata" : { "contact_email" : "string", "hidden" : true, "name" : "string", "organization_id" : "string", "owner_id" : "string", "resources" : { "cpu" : { "boost" : true, "hard_limit" : true } }, "subscription_level" : "string", "system_owned" : true } } } ], "appsearch" : [ { "display_name" : "string", "elasticsearch_cluster_ref_id" : "string", "plan" : { "appsearch" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "cluster_topology" : [ { "appsearch" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "instance_configuration_id" : "string", "instance_configuration_version" : 0, "node_type" : { "appserver" : true, "worker" : true }, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "override_failsafe" : true, "preferred_allocator_tags" : { "some_property" : "string" }, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } } }, "ref_id" : "string", "region" : "string", "settings" : { "metadata" : { "contact_email" : "string", "hidden" : true, "name" : "string", "organization_id" : "string", "owner_id" : "string", "resources" : { "cpu" : { "boost" : true, "hard_limit" : true } }, "subscription_level" : "string", "system_owned" : true } } } ], "elasticsearch" : [ { "display_name" : "string", "plan" : { "autoscaling_enabled" : true, "cluster_topology" : [ { "autoscaling_max" : { "resource" : "string", "value" : 0 }, "autoscaling_min" : { "resource" : "string", "value" : 0 }, "autoscaling_policy_override_json" : {}, "autoscaling_tier_override" : true, "elasticsearch" : { "curation" : { "from_instance_configuration_id" : "string", "to_instance_configuration_id" : "string" }, "docker_image" : "string", "enabled_built_in_plugins" : [ "string" ], "node_attributes" : { "some_property" : "string" }, "system_settings" : { "auto_create_index" : true, "default_shards_per_index" : 0, "destructive_requires_name" : true, "enable_close_index" : true, "monitoring_collection_interval" : 0, "monitoring_history_duration" : "string", "reindex_whitelist" : [ "string" ], "scripting" : { "expressions_enabled" : true, "file" : { "enabled" : true, "sandbox_mode" : true }, "inline" : { "enabled" : true, "sandbox_mode" : true }, "mustache_enabled" : true, "painless_enabled" : true, "stored" : { "enabled" : true, "sandbox_mode" : true } }, "watcher_trigger_engine" : "string" }, "user_bundles" : [ { "elasticsearch_version" : "string", "name" : "string", "url" : "string" } ], "user_plugins" : [ { "elasticsearch_version" : "string", "name" : "string", "url" : "string" } ], "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "id" : "string", "instance_configuration_id" : "string", "instance_configuration_version" : 0, "memory_per_node" : 0, "node_count_per_zone" : 0, "node_roles" : [ "string" ], "node_type" : { "data" : true, "ingest" : true, "master" : true, "ml" : true }, "size" : { "resource" : "string", "value" : 0 }, "topology_element_control" : { "min" : { "resource" : "string", "value" : 0 } }, "zone_count" : 0 } ], "deployment_template" : { "id" : "string", "version" : "string" }, "elasticsearch" : { "curation" : { "from_instance_configuration_id" : "string", "to_instance_configuration_id" : "string" }, "docker_image" : "string", "enabled_built_in_plugins" : [ "string" ], "node_attributes" : { "some_property" : "string" }, "system_settings" : { "auto_create_index" : true, "default_shards_per_index" : 0, "destructive_requires_name" : true, "enable_close_index" : true, "monitoring_collection_interval" : 0, "monitoring_history_duration" : "string", "reindex_whitelist" : [ "string" ], "scripting" : { "expressions_enabled" : true, "file" : { "enabled" : true, "sandbox_mode" : true }, "inline" : { "enabled" : true, "sandbox_mode" : true }, "mustache_enabled" : true, "painless_enabled" : true, "stored" : { "enabled" : true, "sandbox_mode" : true } }, "watcher_trigger_engine" : "string" }, "user_bundles" : [ { "elasticsearch_version" : "string", "name" : "string", "url" : "string" } ], "user_plugins" : [ { "elasticsearch_version" : "string", "name" : "string", "url" : "string" } ], "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "transient" : { "cluster_settings_json" : {}, "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "max_snapshot_age" : 0, "max_snapshot_attempts" : 0, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "move_only" : true, "override_failsafe" : true, "preferred_allocator_tags" : { "some_property" : "string" }, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "skip_data_migration" : true, "skip_post_upgrade_steps" : true, "skip_snapshot" : true, "skip_snapshot_post_major_upgrade" : true, "skip_upgrade_checker" : true, "timeout" : 0 }, "remote_clusters" : { "resources" : [ { "alias" : "string", "deployment_id" : "string", "elasticsearch_ref_id" : "string", "info" : { "compatible" : true, "connected" : true, "healthy" : true, "trusted" : true, "trusted_back" : true }, "skip_unavailable" : true } ] }, "restore_snapshot" : { "repository_config" : { "raw_settings" : {} }, "repository_name" : "string", "restore_payload" : { "indices" : [ "string" ], "raw_settings" : {} }, "snapshot_name" : "string", "source_cluster_id" : "string", "strategy" : "string" }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } } }, "ref_id" : "string", "region" : "string", "settings" : { "curation" : { "specs" : [ { "index_pattern" : "string", "trigger_interval_seconds" : 0 } ] }, "dedicated_masters_threshold" : 0, "keystore_contents" : { "secrets" : { "some_property" : { "as_file" : true, "value" : {} } } }, "metadata" : { "contact_email" : "string", "hidden" : true, "name" : "string", "organization_id" : "string", "owner_id" : "string", "resources" : { "cpu" : { "boost" : true, "hard_limit" : true } }, "subscription_level" : "string", "system_owned" : true }, "monitoring" : { "target_cluster_id" : "string" }, "snapshot" : { "cron_expression" : "string", "enabled" : true, "interval" : "string", "pending_interval" : "string", "repository" : { "default" : {}, "reference" : { "repository_name" : "string" }, "static" : { "repository_type" : "string", "settings" : {} } }, "retention" : { "max_age" : "string", "snapshots" : 0 }, "slm" : true, "suspended" : [ "string" ], "wait_time_after_snapshotting" : "string" }, "traffic_filter" : { "rulesets" : [ "string" ] }, "trust" : { "accounts" : [ { "account_id" : "string", "name" : "string", "trust_all" : true, "trust_allowlist" : [ "string" ] } ], "direct" : [ { "additional_node_names" : [ "string" ], "certificates" : [ { "metadata" : { "also_trusted_by" : [ "string" ], "fingerprint" : "string", "valid_from" : "2019-01-01T00:00:00Z", "valid_to" : "2019-01-01T00:00:00Z" }, "pem" : "string" } ], "name" : "string", "scope_id" : "string", "trust_all" : true, "trust_allowlist" : [ "string" ], "type" : "string", "uid" : "string" } ], "external" : [ { "name" : "string", "trust_all" : true, "trust_allowlist" : [ "string" ], "trust_relationship_id" : "string" } ] } } } ], "enterprise_search" : [ { "display_name" : "string", "elasticsearch_cluster_ref_id" : "string", "plan" : { "cluster_topology" : [ { "allocator_filter" : {}, "enterprise_search" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "instance_configuration_id" : "string", "instance_configuration_version" : 0, "memory_per_node" : {}, "node_configuration" : "string", "node_count_per_zone" : {}, "node_type" : { "appserver" : true, "connector" : true, "worker" : true }, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "enterprise_search" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "override_failsafe" : true, "preferred_allocator_tags" : { "some_property" : "string" }, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } } }, "ref_id" : "string", "region" : "string", "settings" : { "metadata" : { "contact_email" : "string", "hidden" : true, "name" : "string", "organization_id" : "string", "owner_id" : "string", "resources" : { "cpu" : { "boost" : true, "hard_limit" : true } }, "subscription_level" : "string", "system_owned" : true } } } ], "integrations_server" : [ { "display_name" : "string", "elasticsearch_cluster_ref_id" : "string", "plan" : { "cluster_topology" : [ { "instance_configuration_id" : "string", "instance_configuration_version" : 0, "integrations_server" : { "docker_image" : "string", "mode" : "string", "system_settings" : { "debug_enabled" : true, "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "kibana_url" : "string", "secret_token" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "integrations_server" : { "docker_image" : "string", "mode" : "string", "system_settings" : { "debug_enabled" : true, "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "kibana_url" : "string", "secret_token" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "override_failsafe" : true, "preferred_allocator_tags" : { "some_property" : "string" }, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } } }, "ref_id" : "string", "region" : "string", "settings" : { "metadata" : { "contact_email" : "string", "hidden" : true, "name" : "string", "organization_id" : "string", "owner_id" : "string", "resources" : { "cpu" : { "boost" : true, "hard_limit" : true } }, "subscription_level" : "string", "system_owned" : true } } } ], "kibana" : [ { "display_name" : "string", "elasticsearch_cluster_ref_id" : "string", "plan" : { "cluster_topology" : [ { "instance_configuration_id" : "string", "instance_configuration_version" : 0, "kibana" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "memory_per_node" : 0, "node_count_per_zone" : 0, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "kibana" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "override_failsafe" : true, "preferred_allocator_tags" : { "some_property" : "string" }, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } } }, "ref_id" : "string", "region" : "string", "settings" : { "metadata" : { "contact_email" : "string", "hidden" : true, "name" : "string", "organization_id" : "string", "owner_id" : "string", "resources" : { "cpu" : { "boost" : true, "hard_limit" : true } }, "subscription_level" : "string", "system_owned" : true } } } ] }, "settings" : { "autoscaling_enabled" : true, "observability" : { "logging" : { "destination" : { "deployment_id" : "string", "ref_id" : "string" } }, "metrics" : { "destination" : { "deployment_id" : "string", "ref_id" : "string" }, "force_legacy_monitoring" : true } }, "traffic_filter_settings" : { "rulesets" : [ "string" ] } }, "version" : "string" } '