Elastic Stack (ELK Stack) Deployment Templates API
The DeploymentTemplates API from Elastic Stack (ELK Stack) — 2 operation(s) for deploymenttemplates.
Elastic Stack (ELK Stack) Deployment Templates API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include DeploymentTemplates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 2 paths, and defines 114 schemas. It is described by OpenAPI 3.2.0, at version 1.
Requests are made against a single base URL, https://{{hostname}}/api/v1.
5 operations
2 paths
114 schemas
1 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Elastic Stack (ELK Stack) Deployment Templates API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKey).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
DeploymentTemplates 5
GET
/deployments/templates
Get deployment templates
POST
/deployments/templates
Create deployment template
GET
/deployments/templates/{template_id}
Get deployment template
PUT
/deployments/templates/{template_id}
Set deployment template
DELETE
/deployments/templates/{template_id}
Delete deployment template
Schemas 114
The contract defines 114 schemas that model the data the API accepts and returns. The most detailed are ElasticsearchPlanControlConfiguration (18 properties), ElasticsearchClusterTopologyElement (15 properties), DeploymentTemplateInfoV2 (13 properties), ElasticsearchConfiguration (12 properties). Each schema is shown below with its type and property counts.
ElasticsearchPayload
object
An alias for an Elasticsearch Cluster paired with a request for creating one
5 properties
3 required
AppSearchConfiguration
object
7 properties
TransientEnterpriseSearchPlanConfiguration
object
Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied
2 properties
ElasticsearchNodeType
object
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WAR…
4 properties
ClusterMetadataResourcesSettings
object
The top-level configuration settings for the Elasticsearch cluster resources.
1 property
DeploymentCreateResources
object
Describes the resources that will belong to a Deployment
6 properties
RestoreSnapshotConfiguration
object
Restores a snapshot from a local or remote repository.
6 properties
1 required
ElasticsearchScriptTypeSettings
object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API request…
2 properties
ElasticsearchConfiguration
object
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the over…
12 properties
EmptyResponse
object
DiscreteSizes
object
Instance sizes that are supported by the Elasticsearch instance, Kibana instance, or APM Server configuration.
3 properties
1 required
ApmConfiguration
object
The configuration options for the APM Server.
7 properties
ManagedMonitoringSettings
object
The settings for sending monitoring information to another cluster.
1 property
1 required
ElasticsearchClusterTrustSettings
object
Configuration of trust with other clusters.
3 properties
IntegrationsServerConfiguration
object
The configuration options for the Integrations Server.
8 properties
DeploymentCreateMetadata
object
Additional information about the new deployment object.
2 properties
ClusterCurationSpec
object
Specifies the conditions to trigger an Elasticsearch cluster curation.
2 properties
2 required
EnterpriseSearchPayload
object
An Enterprise Search creation request paired with the alias of the Elasticsearch cluster it should be paired with
6 properties
4 required
TopologyElementControl
object
Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
1 property
1 required
InstanceMoveRequest
object
The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction wit…
3 properties
1 required
AllocatorMoveRequest
object
As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
3 properties
1 required
KibanaPlanControlConfiguration
object
The configuration settings for the timeout and fallback parameters.
10 properties
RollingGrowShrinkStrategyConfig
object
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of…
ElasticsearchUserPlugin
object
A list of admin-uploaded plugin objects.
3 properties
3 required
KibanaPayload
object
A Kibana creation request paired with the alias of the Elasticsearch cluster it should be paired with
6 properties
4 required
GrowShrinkStrategyConfig
object
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer…
ClusterSnapshotRetention
object
Information about the Elasticsearch cluster snapshot retention.
2 properties
BasicFailedReplyElement
object
3 properties
2 required
KibanaDeeplink
object
Embedded object that contains information for linking into a specific Kibana page configured via the template.
2 properties
2 required
ElasticsearchCuration
object
The structure that defines the routing settings for index curation.
2 properties
2 required
IntegrationsServerPayload
object
An Integrations Server creation request paired with the alias of the Elasticsearch cluster it should be paired with
6 properties
4 required
InstanceConfigurationInfo
object
The configuration template for Elasticsearch instances, Kibana instances, and APM Servers.
11 properties
2 required
EnterpriseSearchSettings
object
The settings for the Enterprise Search.
1 property
AppSearchTopologyElement
object
Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)
6 properties
AutodetectStrategyConfig
object
A strategy that lets constructor choose the most optimal way to execute the plan.
TransientAppSearchPlanConfiguration
object
Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
2 properties
RestoreSnapshotRepoConfiguration
object
Configures the location of a remote repository. The default is the system repository.
1 property
TrustedCertificate
object
An x509 certificate used by a DirectTrustRelationship
2 properties
1 required
ApmSettings
object
The settings for the APM Server.
1 property
RollingStrategyConfig
object
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan ch…
4 properties
ApmPlan
object
The plan for the APM Server.
3 properties
1 required
KibanaSystemSettings
object
A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with usersettingsoverride and usersettings.
2 properties
IntegrationsServerPlanControlConfiguration
object
The plan control configuration options for the Integrations Server.
10 properties
DeploymentCreateSettings
object
Additional configuration for the new deployment object.
5 properties
ClusterSnapshotRepositoryStatic
object
The static object for the Elasticsearch cluster snapshot repository.
2 properties
KibanaClusterSettings
object
The settings for multiple Kibana instances.
1 property
ApmPayload
object
An APM creation request paired with the alias of the Elasticsearch cluster it should be paired with
6 properties
4 required
DirectTrustRelationship
object
The trust relationship with entities trusted directly having their certificate bundled together with the trust settings.
8 properties
3 required
ClusterSnapshotSettings
object
The snapshot configuration settings for an Elasticsearch cluster.
9 properties
SnapshotDependencyConfiguration
object
Configuration for attaching a snapshot repository dependency from another cluster. This creates a snapshot repository in the target cluster pointing to the sou…
1 property
1 required
ByokSettings
object
Information required to create a Bring Your Own Key (BYOK) deployment.
1 property
1 required
KeystoreSecret
object
The value that you configure for the Elasticsearch keystore secret.
4 properties
ApmSystemSettings
object
A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with userset…
4 properties
EnterpriseSearchNodeTypes
object
Node types to enable for an Enterprise Search instance
3 properties
3 required
ClusterMetadataSettings
object
The top-level configuration settings for the Elasticsearch cluster.
8 properties
ElasticsearchPlanControlConfiguration
object
The configuration settings for the timeout and fallback parameters.
18 properties
IntegrationsServerPlan
object
The plan for the Integrations Server.
3 properties
1 required
TrafficFilterSettings
object
The configuration settings for the traffic filter.
1 property
1 required
TransientKibanaPlanConfiguration
object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.
2 properties
IntegrationsServerTopologyElement
object
Defines the topology of the Integrations Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
5 properties
TransientIntegrationsServerPlanConfiguration
object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.
2 properties
RestoreSnapshotApiConfiguration
object
The configuration for the restore command, such as which indices you want to restore.
2 properties
AppSearchNodeTypes
object
Node types to enable for an AppSearch instance
2 properties
2 required
DeploymentCreateRequest
object
A request for creating a new Deployment consisting of multiple clusters
7 properties
ElasticsearchClusterSettings
object
The settings for an Elasticsearch cluster.
8 properties
EnterpriseSearchPlanControlConfiguration
object
10 properties
AccountTrustRelationship
object
The trust relationship with the clusters of one account.
4 properties
2 required
RemoteResources
object
The list of resources used as remote clusters
1 property
1 required
AppSearchPlanControlConfiguration
object
10 properties
ClusterCurationSettings
object
The index curation settings for an Elasticsearch cluster.
1 property
1 required
IntegrationsServerSettings
object
The settings for the Integrations Server.
1 property
DeploymentObservabilitySettings
object
The observability settings for a deployment
2 properties
ObservabilityAbsoluteDeployment
object
The destination to send logs and metrics to
2 properties
1 required
KeystoreContents
object
The contents of the Elasticsearch keystore.
1 property
1 required
AppSearchSystemSettings
object
This structure defines a curated subset of the AppSearch settings. (This field together with 'usersettingsoverride' and 'usersettings' defines the total set of…
4 properties
DeploymentTemplateInfoV2
object
Deployment template detailed information
13 properties
4 required
DeploymentLoggingSettings
object
The logging settings for a deployment
1 property
1 required
ClusterMetadataCpuResourcesSettings
object
Specifies the CPU resource settings for the Elasticsearch cluster.
2 properties
KibanaClusterPlan
object
The plan for the Kibana instance.
3 properties
1 required
BasicFailedReply
object
1 property
1 required
EnterpriseSearchTopologyElement
object
Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated)
10 properties
RemoteResourceInfo
object
Information about a Remote Cluster.
5 properties
5 required
TopologySize
object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
2 properties
2 required
AppSearchSettings
object
The settings for the App Search.
1 property
RemoteResourceRef
object
The Elasticsearch resource used as a Remote Cluster.
5 properties
3 required
ElasticsearchUserBundle
object
A list of admin-uploaded bundle objects, such as scripts and synonym files.
3 properties
3 required
ClusterSnapshotRepositoryDefault
object
The default object for the Elasticsearch cluster snapshot repository.
ApmTopologyElement
object
Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
5 properties
TransientApmPlanConfiguration
object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
2 properties
AppSearchPlan
object
The plan for the App Search cluster.
3 properties
1 required
EnterpriseSearchPlan
object
The plan for the Enterprise Search cluster.
3 properties
1 required
ApmPlanControlConfiguration
object
The plan control configuration options for the APM Server.
10 properties
KibanaConfiguration
object
The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override s…
7 properties
ExternalTrustRelationship
object
The trust relationship with external entities (remote environments, remote accounts...).
4 properties
2 required
ElasticsearchSystemSettings
object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with usersettingsoverride and us…
9 properties
EnterpriseSearchSystemSettings
object
This structure defines a curated subset of the Enterprise Search settings. (This field together with 'usersettingsoverride' and 'usersettings' defines the tota…
3 properties
ChangeSourceInfo
object
A container for information about the source of a change.
6 properties
3 required
PlanStrategy
object
The options for performing a plan change. Specify only one property each time. The default is growandshrink.
4 properties
MetadataItem
object
The key-value pair.
2 properties
2 required
ElasticsearchClusterTopologyElement
object
The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated.
15 properties
ElasticsearchClusterPlan
object
The plan for the Elasticsearch cluster.
5 properties
2 required
CertificateMetaData
object
The certificate MetaData
4 properties
3 required
ElasticsearchScriptingUserSettings
object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file,…
6 properties
EnterpriseSearchConfiguration
object
7 properties
DeploymentMetricsSettings
object
The metrics settings for a deployment
2 properties
1 required
KibanaClusterTopologyElement
object
The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated.
7 properties
ClusterSnapshotRepositoryInfo
object
Information about the Elasticsearch cluster snapshot repository.
3 properties
ClusterSnapshotRepositoryReference
object
The reference object for the Elasticsearch cluster snapshot repository.
1 property
AppSearchPayload
object
An AppSearch creation request paired with the alias of the Elasticsearch cluster it should be paired with
6 properties
4 required
IntegrationsServerSystemSettings
object
A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use Integrations…
4 properties
TransientElasticsearchPlanConfiguration
object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
6 properties
DeploymentTemplateRequestBody
object
Request body to create or update a Deployment Template
10 properties
2 required
DeploymentTemplateReference
object
Specifies the deployment template used to create the plan.
2 properties
1 required
IdResponse
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Stack (ELK Stack) 12
Other APIs Elastic Stack (ELK Stack) publishes across the network.
Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
#DeploymentTemplates
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Deployment Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.