Create deployment template

Creates a deployment template.

Request

POST /api/v1/deployments/templates

Query parameters

Name Type Required Description

region

string

Y

Region of the deployment template

Request body

(DeploymentTemplateRequestBody) (required) The deployment template definition.

Responses

201

(IdResponse) The deployment definition was valid and the template has been created.

400

(BasicFailedReply) The requested region is not supported. (code: templates.region_not_found)

Headers

x-cloud-error-codes (string; allowed values: [templates.region_not_found])
The error codes associated with the response
401

(BasicFailedReply) The user is not authorized to access requested region. (code: templates.region_not_allowed)

Headers

x-cloud-error-codes (string; allowed values: [templates.region_not_allowed])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST https://{{hostname}}/api/v1/deployments/templates \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "deployment_template" : {
      "metadata" : {
         "system_owned" : true
      },
      "name" : "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" : null,
                        "instance_configuration_id" : "string",
                        "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"
                              ]
                           }
                        ],
                        "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",
                     "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" : null,
                        "instance_configuration_id" : "string",
                        "node_type" : {
                           "appserver" : true,
                           "worker" : true
                        },
                        "size" : null,
                        "zone_count" : 0
                     }
                  ],
                  "transient" : {
                     "plan_configuration" : {
                        "calm_wait_time" : 0,
                        "cluster_reboot" : "string",
                        "extended_maintenance" : true,
                        "move_allocators" : [
                           null
                        ],
                        "move_instances" : [
                           null
                        ],
                        "preferred_allocators" : [
                           "string"
                        ],
                        "reallocate_instances" : true,
                        "timeout" : 0
                     },
                     "strategy" : null
                  }
               },
               "ref_id" : "string",
               "region" : "string",
               "settings" : {
                  "metadata" : null
               }
            }
         ],
         "elasticsearch" : [
            {
               "display_name" : "string",
               "plan" : {
                  "cluster_topology" : [
                     {
                        "allocator_filter" : {},
                        "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" : null,
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : null
                              },
                              "use_disk_threshold" : 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"
                        },
                        "instance_configuration_id" : "string",
                        "memory_per_node" : 0,
                        "node_configuration" : "string",
                        "node_count_per_zone" : 0,
                        "node_type" : {
                           "data" : true,
                           "ingest" : true,
                           "master" : true,
                           "ml" : true
                        },
                        "size" : null,
                        "zone_count" : 0
                     }
                  ],
                  "deployment_template" : {
                     "id" : "string",
                     "version" : "string"
                  },
                  "elasticsearch" : null,
                  "tiebreaker_override" : true,
                  "tiebreaker_topology" : {
                     "memory_per_node" : 0
                  },
                  "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" : [
                           null
                        ],
                        "move_instances" : [
                           null
                        ],
                        "move_only" : true,
                        "override_failsafe" : true,
                        "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
                     },
                     "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" : null
                  },
                  "zone_count" : 0
               },
               "ref_id" : "string",
               "region" : "string",
               "settings" : {
                  "ccs" : {
                     "remote_clusters" : {
                        "some_property" : {
                           "cluster_id" : "string",
                           "skip_unavailable" : true
                        }
                     }
                  },
                  "curation" : {
                     "specs" : [
                        {
                           "index_pattern" : "string",
                           "trigger_interval_seconds" : 0
                        }
                     ]
                  },
                  "dedicated_masters_threshold" : 0,
                  "ip_filtering" : {
                     "rulesets" : [
                        "string"
                     ]
                  },
                  "metadata" : null,
                  "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" : {}
                        }
                     },
                     "repository_name" : "string",
                     "retention" : {
                        "max_age" : "string",
                        "snapshots" : 0
                     },
                     "slm" : true,
                     "suspended" : [
                        "string"
                     ],
                     "wait_time_after_snapshotting" : "string"
                  },
                  "traffic_filter" : {
                     "rulesets" : [
                        "string"
                     ]
                  },
                  "trust" : {
                     "accounts" : [
                        {
                           "account_id" : "string",
                           "trust_all" : true,
                           "trust_whitelist" : [
                              "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",
                        "memory_per_node" : {},
                        "node_configuration" : "string",
                        "node_count_per_zone" : {},
                        "node_type" : {
                           "appserver" : true,
                           "connector" : true,
                           "worker" : true
                        },
                        "size" : null,
                        "zone_count" : 0
                     }
                  ],
                  "enterprise_search" : null,
                  "transient" : {
                     "plan_configuration" : {
                        "calm_wait_time" : 0,
                        "cluster_reboot" : "string",
                        "extended_maintenance" : true,
                        "move_allocators" : [
                           null
                        ],
                        "move_instances" : [
                           null
                        ],
                        "preferred_allocators" : [
                           "string"
                        ],
                        "reallocate_instances" : true,
                        "timeout" : 0
                     },
                     "strategy" : null
                  }
               },
               "ref_id" : "string",
               "region" : "string",
               "settings" : {
                  "metadata" : null
               }
            }
         ],
         "kibana" : [
            {
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "plan" : {
                  "cluster_topology" : [
                     {
                        "allocator_filter" : {},
                        "instance_configuration_id" : "string",
                        "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_configuration" : "string",
                        "node_count_per_zone" : 0,
                        "size" : null,
                        "zone_count" : 0
                     }
                  ],
                  "kibana" : null,
                  "transient" : {
                     "plan_configuration" : {
                        "calm_wait_time" : 0,
                        "cluster_reboot" : "string",
                        "extended_maintenance" : true,
                        "move_allocators" : [
                           null
                        ],
                        "move_instances" : [
                           null
                        ],
                        "preferred_allocators" : [
                           "string"
                        ],
                        "reallocate_instances" : true,
                        "timeout" : 0
                     },
                     "strategy" : null
                  },
                  "zone_count" : 0
               },
               "ref_id" : "string",
               "region" : "string",
               "settings" : {
                  "metadata" : null
               }
            }
         ]
      },
      "settings" : {
         "ip_filtering_settings" : null,
         "traffic_filter_settings" : null
      }
   },
   "description" : "string",
   "hidden" : true,
   "metadata" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ],
   "min_version" : "string",
   "name" : "string",
   "order" : 0,
   "system_owned" : true
}
'