Skip to main content
GET
/
deployments
/
templates
/
{template_id}
Get deployment template
curl --request GET \
  --url https://api.elastic-cloud.com/api/v1/deployments/templates/{template_id} \
  --header 'Authorization: <api-key>'
{
  "deployment_template": {
    "alias": "<string>",
    "metadata": {
      "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": "<boolean>",
                "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": "<boolean>",
                    "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": "<integer>",
                "size": {
                  "resource": "storage",
                  "value": "<integer>"
                },
                "zone_count": "<integer>"
              }
            ],
            "transient": {
              "plan_configuration": {
                "calm_wait_time": "<long>",
                "cluster_reboot": "forced",
                "extended_maintenance": "<boolean>",
                "timeout": "<long>"
              },
              "strategy": {
                "autodetect": {},
                "grow_and_shrink": {},
                "rolling": {
                  "allow_inline_resize": "<boolean>",
                  "group_by": "<string>",
                  "shard_init_wait_time": "<long>",
                  "skip_synced_flush": "<boolean>"
                },
                "rolling_grow_and_shrink": {}
              }
            }
          },
          "ref_id": "<string>",
          "region": "<string>",
          "settings": {
            "metadata": {
              "name": "<string>"
            }
          }
        }
      ],
      "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": "<integer>",
                "node_type": {
                  "appserver": "<boolean>",
                  "worker": "<boolean>"
                },
                "size": {
                  "resource": "storage",
                  "value": "<integer>"
                },
                "zone_count": "<integer>"
              }
            ],
            "transient": {
              "plan_configuration": {
                "calm_wait_time": "<long>",
                "cluster_reboot": "forced",
                "extended_maintenance": "<boolean>",
                "move_allocators": [
                  {
                    "allocator_down": "<boolean>",
                    "from": "<string>",
                    "to": [
                      "<string>"
                    ]
                  }
                ],
                "move_instances": [
                  {
                    "from": "<string>",
                    "instance_down": "<boolean>",
                    "to": [
                      "<string>"
                    ]
                  }
                ],
                "preferred_allocators": [
                  "<string>"
                ],
                "reallocate_instances": "<boolean>",
                "timeout": "<long>"
              },
              "strategy": {
                "autodetect": {},
                "grow_and_shrink": {},
                "rolling": {
                  "allow_inline_resize": "<boolean>",
                  "group_by": "<string>",
                  "shard_init_wait_time": "<long>",
                  "skip_synced_flush": "<boolean>"
                },
                "rolling_grow_and_shrink": {}
              }
            }
          },
          "ref_id": "<string>",
          "region": "<string>",
          "settings": {
            "metadata": {
              "name": "<string>"
            }
          }
        }
      ],
      "elasticsearch": [
        {
          "display_name": "<string>",
          "plan": {
            "autoscaling_enabled": "<boolean>",
            "cluster_topology": [
              {
                "autoscaling_max": {
                  "resource": "storage",
                  "value": "<integer>"
                },
                "autoscaling_min": {
                  "resource": "memory",
                  "value": "<integer>"
                },
                "autoscaling_policy_override_json": {},
                "autoscaling_tier_override": "<boolean>",
                "elasticsearch": {
                  "curation": {
                    "from_instance_configuration_id": "<string>",
                    "to_instance_configuration_id": "<string>"
                  },
                  "docker_image": "<string>",
                  "enabled_built_in_plugins": [
                    "<string>"
                  ],
                  "node_attributes": {
                    "ad__6_": "<string>",
                    "exercitation_817": "<string>"
                  },
                  "system_settings": {
                    "auto_create_index": "<boolean>",
                    "default_shards_per_index": "<integer>",
                    "destructive_requires_name": "<boolean>",
                    "enable_close_index": "<boolean>",
                    "monitoring_collection_interval": "<integer>",
                    "monitoring_history_duration": "<string>",
                    "reindex_whitelist": [
                      "<string>"
                    ],
                    "scripting": {
                      "expressions_enabled": "<boolean>",
                      "file": {
                        "enabled": "<boolean>",
                        "sandbox_mode": "<boolean>"
                      },
                      "inline": {
                        "enabled": "<boolean>",
                        "sandbox_mode": "<boolean>"
                      },
                      "mustache_enabled": "<boolean>",
                      "painless_enabled": "<boolean>",
                      "stored": {
                        "enabled": "<boolean>",
                        "sandbox_mode": "<boolean>"
                      }
                    },
                    "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": "<integer>",
                "node_roles": [
                  "data_frozen"
                ],
                "node_type": {
                  "data": "<boolean>",
                  "ingest": "<boolean>",
                  "master": "<boolean>",
                  "ml": "<boolean>"
                },
                "size": {
                  "resource": "storage",
                  "value": "<integer>"
                },
                "topology_element_control": {
                  "min": {
                    "resource": "memory",
                    "value": "<integer>"
                  }
                },
                "zone_count": "<integer>"
              }
            ],
            "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": {
                "cillum_a1c": "<string>",
                "eiusmod_3": "<string>",
                "est_0ab": "<string>",
                "reprehenderit1": "<string>"
              },
              "system_settings": {
                "auto_create_index": "<boolean>",
                "default_shards_per_index": "<integer>",
                "destructive_requires_name": "<boolean>",
                "enable_close_index": "<boolean>",
                "monitoring_collection_interval": "<integer>",
                "monitoring_history_duration": "<string>",
                "reindex_whitelist": [
                  "<string>"
                ],
                "scripting": {
                  "expressions_enabled": "<boolean>",
                  "file": {
                    "enabled": "<boolean>",
                    "sandbox_mode": "<boolean>"
                  },
                  "inline": {
                    "enabled": "<boolean>",
                    "sandbox_mode": "<boolean>"
                  },
                  "mustache_enabled": "<boolean>",
                  "painless_enabled": "<boolean>",
                  "stored": {
                    "enabled": "<boolean>",
                    "sandbox_mode": "<boolean>"
                  }
                },
                "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": "<long>",
                "cluster_reboot": "forced",
                "extended_maintenance": "<boolean>",
                "max_snapshot_age": "<long>",
                "max_snapshot_attempts": "<integer>",
                "skip_snapshot": "<boolean>",
                "timeout": "<long>"
              },
              "remote_clusters": {
                "resources": [
                  {
                    "alias": "<string>",
                    "deployment_id": "<string>",
                    "elasticsearch_ref_id": "<string>",
                    "info": {
                      "compatible": "<boolean>",
                      "connected": "<boolean>",
                      "healthy": "<boolean>",
                      "trusted": "<boolean>",
                      "trusted_back": "<boolean>"
                    },
                    "skip_unavailable": "<boolean>"
                  }
                ]
              },
              "restore_snapshot": {
                "repository_config": {
                  "raw_settings": {}
                },
                "repository_name": "<string>",
                "restore_payload": {
                  "indices": [
                    "<string>"
                  ],
                  "raw_settings": {}
                },
                "snapshot_name": "<string>",
                "source_cluster_id": "<string>",
                "strategy": "partial"
              },
              "strategy": {
                "autodetect": {},
                "grow_and_shrink": {},
                "rolling": {
                  "allow_inline_resize": "<boolean>",
                  "group_by": "<string>",
                  "shard_init_wait_time": "<long>",
                  "skip_synced_flush": "<boolean>"
                },
                "rolling_grow_and_shrink": {}
              }
            }
          },
          "ref_id": "<string>",
          "region": "<string>",
          "settings": {
            "curation": {
              "specs": [
                {
                  "index_pattern": "<string>",
                  "trigger_interval_seconds": "<integer>"
                }
              ]
            },
            "dedicated_masters_threshold": "<integer>",
            "keystore_contents": {
              "secrets": {
                "in_1": {
                  "as_file": "<boolean>",
                  "value": {}
                },
                "laborum_6": {
                  "as_file": "<boolean>",
                  "value": {}
                }
              }
            },
            "metadata": {
              "name": "<string>"
            },
            "monitoring": {
              "target_cluster_id": "<string>"
            },
            "snapshot": {
              "cron_expression": "<string>",
              "interval": "<string>",
              "retention": {
                "max_age": "<string>",
                "snapshots": "<integer>"
              },
              "slm": "<boolean>"
            },
            "traffic_filter": {
              "rulesets": [
                "<string>"
              ]
            },
            "trust": {
              "accounts": [
                {
                  "account_id": "<string>",
                  "name": "<string>",
                  "trust_all": "<boolean>",
                  "trust_allowlist": [
                    "<string>"
                  ]
                }
              ],
              "direct": [
                {
                  "additional_node_names": [
                    "<string>"
                  ],
                  "certificates": [
                    {
                      "metadata": {
                        "also_trusted_by": [
                          "<string>"
                        ],
                        "fingerprint": "<string>",
                        "valid_from": "<dateTime>",
                        "valid_to": "<dateTime>"
                      },
                      "pem": "<string>"
                    }
                  ],
                  "name": "<string>",
                  "scope_id": "<string>",
                  "trust_all": "<boolean>",
                  "trust_allowlist": [
                    "<string>"
                  ],
                  "type": "ECE",
                  "uid": "<string>"
                }
              ],
              "external": [
                {
                  "name": "<string>",
                  "trust_all": "<boolean>",
                  "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": "<integer>",
                "memory_per_node": {},
                "node_configuration": "<string>",
                "node_count_per_zone": {},
                "node_type": {
                  "appserver": "<boolean>",
                  "connector": "<boolean>",
                  "worker": "<boolean>"
                },
                "size": {
                  "resource": "memory",
                  "value": "<integer>"
                },
                "zone_count": "<integer>"
              }
            ],
            "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": "<long>",
                "cluster_reboot": "forced",
                "extended_maintenance": "<boolean>",
                "move_allocators": [
                  {
                    "allocator_down": "<boolean>",
                    "from": "<string>",
                    "to": [
                      "<string>"
                    ]
                  }
                ],
                "move_instances": [
                  {
                    "from": "<string>",
                    "instance_down": "<boolean>",
                    "to": [
                      "<string>"
                    ]
                  }
                ],
                "preferred_allocators": [
                  "<string>"
                ],
                "reallocate_instances": "<boolean>",
                "timeout": "<long>"
              },
              "strategy": {
                "autodetect": {},
                "grow_and_shrink": {},
                "rolling": {
                  "allow_inline_resize": "<boolean>",
                  "group_by": "<string>",
                  "shard_init_wait_time": "<long>",
                  "skip_synced_flush": "<boolean>"
                },
                "rolling_grow_and_shrink": {}
              }
            }
          },
          "ref_id": "<string>",
          "region": "<string>",
          "settings": {
            "metadata": {
              "name": "<string>"
            }
          }
        }
      ],
      "integrations_server": [
        {
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "plan": {
            "cluster_topology": [
              {
                "instance_configuration_id": "<string>",
                "instance_configuration_version": "<integer>",
                "integrations_server": {
                  "docker_image": "<string>",
                  "mode": "standalone",
                  "system_settings": {
                    "debug_enabled": "<boolean>",
                    "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": "storage",
                  "value": "<integer>"
                },
                "zone_count": "<integer>"
              }
            ],
            "integrations_server": {
              "docker_image": "<string>",
              "mode": "managed",
              "system_settings": {
                "debug_enabled": "<boolean>",
                "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": "<long>",
                "cluster_reboot": "forced",
                "extended_maintenance": "<boolean>",
                "timeout": "<long>"
              },
              "strategy": {
                "autodetect": {},
                "grow_and_shrink": {},
                "rolling": {
                  "allow_inline_resize": "<boolean>",
                  "group_by": "<string>",
                  "shard_init_wait_time": "<long>",
                  "skip_synced_flush": "<boolean>"
                },
                "rolling_grow_and_shrink": {}
              }
            }
          },
          "ref_id": "<string>",
          "region": "<string>",
          "settings": {
            "metadata": {
              "name": "<string>"
            }
          }
        }
      ],
      "kibana": [
        {
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "plan": {
            "cluster_topology": [
              {
                "instance_configuration_id": "<string>",
                "instance_configuration_version": "<integer>",
                "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>"
                },
                "size": {
                  "resource": "memory",
                  "value": "<integer>"
                },
                "zone_count": "<integer>"
              }
            ],
            "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": "<long>",
                "cluster_reboot": "forced",
                "extended_maintenance": "<boolean>",
                "timeout": "<long>"
              },
              "strategy": {
                "autodetect": {},
                "grow_and_shrink": {},
                "rolling": {
                  "allow_inline_resize": "<boolean>",
                  "group_by": "<string>",
                  "shard_init_wait_time": "<long>",
                  "skip_synced_flush": "<boolean>"
                },
                "rolling_grow_and_shrink": {}
              }
            }
          },
          "ref_id": "<string>",
          "region": "<string>",
          "settings": {
            "metadata": {
              "name": "<string>"
            }
          }
        }
      ]
    },
    "settings": {
      "autoscaling_enabled": "<boolean>",
      "observability": {
        "logging": {
          "destination": {
            "deployment_id": "<string>",
            "ref_id": "<string>"
          }
        },
        "metrics": {
          "destination": {
            "deployment_id": "<string>",
            "ref_id": "<string>"
          }
        }
      },
      "traffic_filter_settings": {
        "rulesets": [
          "<string>"
        ]
      }
    },
    "version": "<string>"
  },
  "description": "<string>",
  "id": "<string>",
  "instance_configurations": [
    {
      "config_version": "<integer>",
      "cpu_multiplier": "<double>",
      "description": "<string>",
      "discrete_sizes": {
        "default_size": "<integer>",
        "resource": "memory",
        "sizes": [
          "<integer>"
        ]
      },
      "id": "<string>",
      "instance_type": "kibana",
      "max_zones": "<integer>",
      "metadata": {},
      "name": "<string>",
      "node_types": [
        "<string>"
      ],
      "storage_multiplier": "<double>"
    }
  ],
  "kibana_deeplink": [
    {
      "semver": "<string>",
      "uri": "<string>"
    }
  ],
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "min_version": "<string>",
  "name": "<string>",
  "order": "<integer>",
  "source": {
    "action": "<string>",
    "admin_id": "<string>",
    "date": "<dateTime>",
    "facilitator": "<string>",
    "remote_addresses": [
      "<string>"
    ],
    "user_id": "<string>"
  },
  "system_owned": "<boolean>",
  "template_category_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
template_id
string
required

(Required) The identifier for the deployment template.

Example:

"<string>"

Query Parameters

​
show_instance_configurations
string

If true, will return details for each instance configuration referenced by the template.

Example:

"true"

​
show_max_zones
string

If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.

Example:

"false"

​
stack_version
string

If present, it will cause the returned deployment template to be adapted to return only the elements allowed in that version.

Example:

"<string>"

​
region
string

(Required) Region of the deployment template

Example:

"<string>"

Response

The deployment template was found and returned successfully.

​
deployment_template
object
​
description
string
Example:

"<string>"

​
id
string
Example:

"<string>"

​
instance_configurations
object[]
Example:
[
  {
    "config_version": "<integer>",
    "cpu_multiplier": "<double>",
    "description": "<string>",
    "discrete_sizes": {
      "default_size": "<integer>",
      "resource": "memory",
      "sizes": ["<integer>"]
    },
    "id": "<string>",
    "instance_type": "kibana",
    "max_zones": "<integer>",
    "metadata": {},
    "name": "<string>",
    "node_types": ["<string>"],
    "storage_multiplier": "<double>"
  }
]
​
kibana_deeplink
object[]
Example:
[{ "semver": "<string>", "uri": "<string>" }]
​
metadata
object[]
Example:
[{ "key": "<string>", "value": "<string>" }]
​
min_version
string
Example:

"<string>"

​
name
string
Example:

"<string>"

​
order
string
Example:

"<integer>"

​
source
object
​
system_owned
string
Example:

"<boolean>"

​
template_category_id
string
Example:

"<string>"

⌘I