Elastic Stack (ELK Stack) Deployments API
The Deployments API from Elastic Stack (ELK Stack) — 58 operation(s) for deployments.
Elastic Stack (ELK Stack) Deployments API is one of 133 APIs that Elastic Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 72 operations across 58 paths, and defines 250 schemas. It is described by OpenAPI 3.2.0, at version 1.
Requests are made against a single base URL, https://{{hostname}}/api/v1.
72 operations
58 paths
250 schemas
5 DELETE22 GET3 PATCH34 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Elastic Stack (ELK Stack) Deployments 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 72
Across 58 paths, the API surfaces 72 operations — 5 DELETE, 22 GET, 3 PATCH, 34 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
Deployments 72
GET
/deployments
List Deployments
POST
/deployments
Create Deployment
POST
/deployments/_resync
Resynchronize Deployments
POST
/deployments/_search
Search Deployments
POST
/deployments/eligible-remote-clusters
Get eligible remote clusters
GET
/deployments/{deployment_id}
Get Deployment
PUT
/deployments/{deployment_id}
Update Deployment
DELETE
/deployments/{deployment_id}
Delete Deployment
POST
/deployments/{deployment_id}/_restore
Restores a shutdown Deployment
POST
/deployments/{deployment_id}/_resync
Resynchronize Deployment
POST
/deployments/{deployment_id}/_shutdown
Shuts down Deployment
GET
/deployments/{deployment_id}/apm/{ref_id}
Get Deployment APM Resource Info
POST
/deployments/{deployment_id}/apm/{ref_id}/_reset-token
Reset the secret token for an APM resource
GET
/deployments/{deployment_id}/appsearch/{ref_id}
Get Deployment App Search Resource Info
GET
/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode
Set AppSearch read-only status
PUT
/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode
Set AppSearch read-only status
GET
/deployments/{deployment_id}/certificate-authority
Get certificate authority
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}
Get Deployment Elasticsearch Resource Info
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr
Migrate Elasticsearch and associated Kibana resources to enable CCR
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm
Migrate Elasticsearch resource to use ILM
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm
Migrate Elasticsearch resource to use SLM
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password
Reset 'elastic' user password
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart
Restart Deployment Elasticsearch Resource
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown
Shutdown Deployment Elasticsearch Resource
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters
Get eligible remote clusters
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move
Move Elasticsearch resource instances
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
Get the items in the Elasticsearch resource keystore
PATCH
/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
Add or remove items from the Elasticsearch resource keystore
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Get certificate based remote clusters
PUT
/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Set certificate based remote clusters
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository
List the attached snapshot repositories
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository
Create a snapshot repository for Elasticsearch resource
DELETE
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name}
Remove the attached snapshot repository
GET
/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers
Get Elasticsearch tiers
PATCH
/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers
Update Elasticsearch tiers
GET
/deployments/{deployment_id}/enterprise_search/{ref_id}
Get Deployment Enterprise Search Resource Info
GET
/deployments/{deployment_id}/heap_dumps
Get details about heap dumps for a Deployment
GET
/deployments/{deployment_id}/integrations_server/{ref_id}
Get Deployment Integrations Server Resource Info
GET
/deployments/{deployment_id}/kibana/{ref_id}
Get Deployment Kibana Resource Info
GET
/deployments/{deployment_id}/migrate_template
Build request to migrate deployment to a different template
GET
/deployments/{deployment_id}/tags
Get the tags for a Deployment
PUT
/deployments/{deployment_id}/tags
Set the tags for a Deployment
POST
/deployments/{deployment_id}/upgrade
Upgrade a Deployment to a new Elastic Stack version
GET
/deployments/{deployment_id}/upgrade_assistant/status
Get Deployment upgrade assistant status
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore
Restores a shutdown resource
GET
/deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id}
Get plan activity
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture
Capture diagnostics for an Elasticsearch or Kibana resource
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start
Start all instances
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop
Stop all instances
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start
Start maintenance mode (all instances)
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop
Stop maintenance mode (all instances)
PUT
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides
Set size overrides
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start
Start instances
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop
Stop instances
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start
Start maintenance mode
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop
Stop maintenance mode
PUT
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides
Set size overrides
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture
Capture a new on-demand heap dump for the given instance
GET
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download
Download the given instance's heap dump
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture
Capture a new thread dump for the given instance
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw
Set a Deployment's resource metadata
PATCH
/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw
Patch a Deployment's resource metadata
DELETE
/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending
Cancel resource pending plan
GET
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Proxy HTTP GET request
POST
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Proxy HTTP POST request
PUT
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Proxy HTTP PUT request
DELETE
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
Proxy HTTP DELETE request
GET
/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings
Get the user settings of a Deployment resource
PUT
/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings
Update user settings for a deployment resource
DELETE
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}
Delete Stateless Resource from Deployment
POST
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart
Restart Deployment Stateless Resource
POST
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown
Shutdown Deployment Stateless Resource
Schemas 250
The contract defines 250 schemas that model the data the API accepts and returns. The most detailed are ElasticsearchClusterInfo (22 properties), ElasticsearchPlanControlConfiguration (18 properties), ElasticsearchClusterTopologyElement (15 properties), IntegrationsServerInfo (14 properties). Each schema is shown below with its type and property counts.
ElasticsearchSystemSettings
object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with usersettingsoverride and us…
9 properties
ClusterMetadataResourcesSettings
object
The top-level configuration settings for the Elasticsearch cluster resources.
1 property
AutoOpsSettings
object
AutoOps settings for this deployment.
1 property
1 required
DeploymentResource
object
Data for a deployment resource
9 properties
4 required
SnapshotRepositories
object
The snapshot repositories linked to this deployment.
1 property
1 required
DeploymentHeapDumps
object
2 properties
2 required
Hyperlink
object
1 property
TargetElasticsearchCluster
object
Information about the specified Elasticsearch cluster.
2 properties
1 required
ClusterPlanStepInfo
object
Information about a step in a plan.
7 properties
5 required
Orphaned
object
Details about orphaned resources.
6 properties
6 required
DeploymentSearchResponse
object
Describes a searched Deployment
7 properties
4 required
ElasticsearchShardsStatus
object
Shards status represented as green, yellow, or red, as returned by the Elasticsearch cluster health API
1 property
1 required
TierInfo
object
Current configuration of an individual Elasticsearch tier
3 properties
CommonClusterPlanInfo
object
11 properties
3 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
ExternalHyperlink
object
3 properties
2 required
KibanaClusterPlan
object
The plan for the Kibana instance.
3 properties
1 required
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
AutodetectStrategyConfig
object
A strategy that lets constructor choose the most optimal way to execute the plan.
AppSearchConfiguration
object
7 properties
ManagedMonitoringSettings
object
The settings for sending monitoring information to another cluster.
1 property
1 required
ElasticsearchMonitoringInfo
object
Information about the monitoring status for the Elasticsearch cluster.
5 properties
5 required
EnterpriseSearchPlan
object
The plan for the Enterprise Search cluster.
3 properties
1 required
AppSearchPayload
object
An AppSearch creation request paired with the alias of the Elasticsearch cluster it should be paired with
6 properties
4 required
Apm
object
Holds diagnostics for an APM resource
4 properties
4 required
AccountTrustRelationship
object
The trust relationship with the clusters of one account.
4 properties
2 required
KibanaClusterSettings
object
The settings for multiple Kibana instances.
1 property
EnterpriseSearchPlanInfo
object
Information about the Enterprise Search Server plan.
11 properties
3 required
ApmSubInfo
object
Information about the APM Servers associated with the Elasticsearch cluster.
3 properties
2 required
GenericResponse
object
1 property
1 required
ReadOnlyRequest
object
Read-only mode request payload
1 property
1 required
ElasticsearchPayload
object
An alias for an Elasticsearch Cluster paired with a request for creating one
5 properties
3 required
KibanaClusterInfo
object
The top-level object information for a Kibana instance.
13 properties
9 required
DeploymentCreateSettings
object
Additional configuration for the new deployment object.
5 properties
ApmPlansInfo
object
Information about current, pending, and past APM Server plans.
4 properties
2 required
Updates
object
Holds diagnostics for existing resources that might be updated
6 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
ElasticsearchCuration
object
The structure that defines the routing settings for index curation.
2 properties
2 required
ClusterSnapshotSettings
object
The snapshot configuration settings for an Elasticsearch cluster.
9 properties
BasicFailedReply
object
1 property
1 required
DeploymentCreateResources
object
Describes the resources that will belong to a Deployment
6 properties
ClusterInstanceDiskInfo
object
Information about the use and storage capacity of a Kibana instance or APM Server.
3 properties
2 required
MetadataItem
object
The key-value pair.
2 properties
2 required
HeapDump
object
6 properties
4 required
ElasticsearchDependant
object
Details about an orphaned Elasticsearch-dependent resources.
2 properties
2 required
DeploymentResourceUserSettings
object
The user-defined settings for a deployment resource
1 property
1 required
RemoteResources
object
The list of resources used as remote clusters
1 property
1 required
AppSearchInfo
object
The overview information for the App Search Server.
13 properties
8 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
ClusterPlanWarning
object
Information about a warning from a plan.
3 properties
2 required
IntegrationsServerResourceInfo
object
Describes an Integrations Server resource belonging to a Deployment
5 properties
5 required
PlanStrategy
object
The options for performing a plan change. Specify only one property each time. The default is growandshrink.
4 properties
AppSearchPlanInfo
object
Information about the App Search Server plan.
11 properties
3 required
AppSearchTopologyElement
object
Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)
6 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
Elasticsearch
object
Holds diagnostics for an Elasticsearch cluster
3 properties
3 required
DeploymentUpdateResponse
object
A response returned from the Deployment update endpoint
7 properties
3 required
RangeQuery
object
The query that matches documents with fields that contain terms within a specified range.
7 properties
DeploymentLoggingSettings
object
The logging settings for a deployment
1 property
1 required
ClusterSnapshotRepositoryReference
object
The reference object for the Elasticsearch cluster snapshot repository.
1 property
ClusterMetadataSettings
object
The top-level configuration settings for the Elasticsearch cluster.
8 properties
ApmPayload
object
An APM creation request paired with the alias of the Elasticsearch cluster it should be paired with
6 properties
4 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
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
ApmPlan
object
The plan for the APM Server.
3 properties
1 required
CreateSnapshotDependencyResponse
object
Response from creating a snapshot dependency
1 property
1 required
IndexPattern
object
An index pattern described indicating how it has to be migrated to ILM.
3 properties
2 required
IntegrationsServerInfo
object
The overview information for the Integrations Server.
14 properties
8 required
OrphanedElasticsearch
object
Details about an orphaned Elasticsearch resources.
2 properties
2 required
InstanceConfigurationInfo
object
The configuration template for Elasticsearch instances, Kibana instances, and APM Servers.
11 properties
2 required
IntegrationsServerPlansInfo
object
Information about current, pending, and past Integrations Server plans.
4 properties
2 required
KibanaResourceInfo
object
Describes an Kibana resource belonging to a Deployment
5 properties
5 required
AppSearchSettings
object
The settings for the App Search.
1 property
CertificateMetaData
object
The certificate MetaData
4 properties
3 required
TiersUpdateRequest
object
Update the size and/or zone count of one or more Elasticsearch tiers. Only include the tiers you want to modify.
7 properties
IndexSynchronizationResults
object
Results from synchronizing indices
4 properties
4 required
EnterpriseSearchPlanControlConfiguration
object
10 properties
MatchQuery
object
Consumes and analyzes text, numbers, and dates, then constructs a query.
4 properties
1 required
DeploymentDiagnostics
object
Describes the diagnostics for a given Deployment-modifying payload
2 properties
ElasticsearchClusterTrustSettings
object
Configuration of trust with other clusters.
3 properties
ApmSettings
object
The settings for the APM Server.
1 property
ClusterCredentials
object
The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster create command.
2 properties
2 required
DeploymentUpdateSettings
object
Additional configuration for the new deployment object.
3 properties
ElasticsearchClusterSettings
object
The settings for an Elasticsearch cluster.
8 properties
CertificateAuthority
object
The certificate authority used to sign the certificates of this deployment
2 properties
2 required
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
DeploymentLogging
object
Logging information for a deployment
3 properties
1 required
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
DeploymentCreateMetadata
object
Additional information about the new deployment object.
2 properties
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…
DeploymentTagsResponse
object
A response returned from the Deployment tags endpoints
1 property
EnterpriseSearchInfo
object
The overview information for the Enterprise Search Server.
13 properties
8 required
SimpleQueryStringQuery
object
A query that uses simple query string syntax. Will ignore invalid syntax.
13 properties
1 required
ClusterSystemAlert
object
Information about a system alert on an Elasticsearch cluster.
5 properties
3 required
ClusterSnapshotRepositoryDefault
object
The default object for the Elasticsearch cluster snapshot repository.
RestoreSnapshotRepoConfiguration
object
Configures the location of a remote repository. The default is the system repository.
1 property
InstanceOverrides
object
2 properties
DeploymentUpgradeAssistantStatusResponse
object
The status of your cluster and its readiness to be upgraded
2 properties
2 required
TransientAppSearchPlanConfiguration
object
Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
2 properties
DeploymentShutdownResponse
object
A response returned from the Deployment shutdown endpoint
3 properties
2 required
CreateSnapshotDependencyRequest
object
Request to create a snapshot dependency between deployments
1 property
1 required
ClusterCurationSettings
object
The index curation settings for an Elasticsearch cluster.
1 property
1 required
ClusterCurationSpec
object
Specifies the conditions to trigger an Elasticsearch cluster curation.
2 properties
2 required
ApmCrudResponse
object
The response to an APM CRUD (create/update-plan) request.
3 properties
1 required
ApmResourceInfo
object
Describes an APM resource belonging to a Deployment
5 properties
5 required
DeploymentUpdateMetadata
object
Additional information about the current deployment object.
3 properties
ClusterSnapshotRetention
object
Information about the Elasticsearch cluster snapshot retention.
2 properties
ElasticsearchClusterPlan
object
The plan for the Elasticsearch cluster.
5 properties
2 required
TransientElasticsearchPlanConfiguration
object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
6 properties
BoolQuery
object
A query for documents that match boolean combinations of other queries.
5 properties
ElasticsearchResourceInfo
object
Describes an Elasticsearch resource belonging to a Deployment
4 properties
4 required
MatchNoneQuery
object
A query that doesn't match any documents.
RemoteResourceInfo
object
Information about a Remote Cluster.
5 properties
5 required
ElasticsearchClusterPlansInfo
object
Information about the current, pending, and past Elasticsearch cluster plans.
4 properties
2 required
ElasticsearchShardsInfo
object
WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use shardsstatus instead. Information about the shards and replicas…
4 properties
4 required
AppSearchPlan
object
The plan for the App Search cluster.
3 properties
1 required
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
ElasticsearchClusterInfo
object
The information for an Elasticsearch cluster.
22 properties
14 required
DeploymentObservabilitySettings
object
The observability settings for a deployment
2 properties
ElasticsearchClusterSecurityInfo
object
For 2.x Elasticsearch clusters, specifies the information about the users and roles. For 5.x Elasticsearch clusters, use the Kibana management UI.
5 properties
5 required
IntegrationsServerSettings
object
The settings for the Integrations Server.
1 property
KibanaSystemSettings
object
A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with usersettingsoverride and usersettings.
2 properties
RestoreSnapshotApiConfiguration
object
The configuration for the restore command, such as which indices you want to restore.
2 properties
UpgradeDeploymentRequest
object
Request to upgrade a deployment to a new Elastic Stack version
1 property
1 required
KeystoreSecret
object
The value that you configure for the Elasticsearch keystore secret.
4 properties
KibanaClusterPlansInfo
object
Information about the current, pending, or past Kibana instance plans.
4 properties
2 required
ExistsQuery
object
Matches documents that have at least one non-null value in the original field.
1 property
1 required
DeploymentResourceUserSettingsResponse
object
The user-defined settings for a Deployment resource.
1 property
EnterpriseSearchResourceInfo
object
Describes an Enterprise Search resource belonging to a Deployment
5 properties
5 required
DeploymentResources
object
Describes a resource belonging to a Deployment
6 properties
6 required
ElasticsearchPlanControlConfiguration
object
The configuration settings for the timeout and fallback parameters.
18 properties
ElasticsearchClusterTopologyElement
object
The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated.
15 properties
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
Kibana
object
Holds diagnostics for a Kibana resource
4 properties
4 required
ClusterSnapshotRepositoryStatic
object
The static object for the Elasticsearch cluster snapshot repository.
2 properties
TierConfig
object
Desired configuration for an individual Elasticsearch tier
2 properties
DirectTrustRelationship
object
The trust relationship with entities trusted directly having their certificate bundled together with the trust settings.
8 properties
3 required
SearchRequest
object
An Elasticsearch search request with a subset of options.
5 properties
DeploymentMetrics
object
Metrics information for a deployment
3 properties
1 required
ClusterPlanAttemptError
object
Information about an error during a plan attempt.
4 properties
3 required
Creates
object
Holds diagnostics for resources that will be created
6 properties
PublicCertificate
object
A certificate used to sign the certificates of this deployment
3 properties
3 required
ElasticsearchClusterBlockingIssueElement
object
WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use blocks in clusterblockingissues instead Information about an iss…
2 properties
2 required
ByokSettings
object
Information required to create a Bring Your Own Key (BYOK) deployment.
1 property
1 required
EnterpriseSearch
object
Holds diagnostics for an Enterprise Search resource
4 properties
4 required
ElasticsearchClusterPlanInfo
object
Information about the Elasticsearch cluster plan.
11 properties
3 required
ObservabilityIssue
object
Observability health issue
2 properties
2 required
ElasticsearchInfo
object
Information about the Elasticsearch cluster.
6 properties
4 required
IntegrationsServerConfiguration
object
The configuration options for the Integrations Server.
8 properties
ApmConfiguration
object
The configuration options for the APM Server.
7 properties
ClusterMetadataPortInfo
object
Information about the ports that allow communication between the Elasticsearch cluster and various protocols.
3 properties
3 required
ClusterInstanceConfigurationInfo
object
Information about a configuration that creates a Kibana instance or APM Server.
4 properties
3 required
DeploymentsListingData
object
3 properties
3 required
DiscreteSizes
object
Instance sizes that are supported by the Elasticsearch instance, Kibana instance, or APM Server configuration.
3 properties
1 required
KibanaClusterPlanInfo
object
Information about the current, pending, or past Kibana instance plan.
11 properties
3 required
AppSearchNodeTypes
object
Node types to enable for an AppSearch instance
2 properties
2 required
ElasticsearchMasterElement
object
Information about the Elasticsearch instances. For split-brain cases, this also includes sub-clusters.
3 properties
2 required
KibanaSubClusterInfo
object
Information about the Kibana instances associated with the Elasticsearch cluster.
3 properties
2 required
DeploymentResourceCommandResponse
object
Response returned when a command is successfully issued against a given Deployment resource
1 property
ClusterTopologyInfo
object
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers…
2 properties
2 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
AppSearchPlansInfo
object
Information about current, pending, and past App Search Server plans.
4 properties
2 required
ElasticsearchUserBundle
object
A list of admin-uploaded bundle objects, such as scripts and synonym files.
3 properties
3 required
ExternalTrustRelationship
object
The trust relationship with external entities (remote environments, remote accounts...).
4 properties
2 required
DeploymentRestoreResponse
object
A response returned from the Deployment restore endpoint
1 property
1 required
ServiceUrl
object
A URL to access the service of a resource
2 properties
2 required
ClusterMetadataInfo
object
Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
10 properties
2 required
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
DeploymentCreateRequest
object
A request for creating a new Deployment consisting of multiple clusters
7 properties
IntegrationsServer
object
Holds diagnostics for an Integrations Server resource
4 properties
4 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
ElasticsearchReplicaElement
object
Information about the unavailable replicas. NOTE: Unlike shards, unavailable replicas indicate a loss of redundancy rather than a loss of availability.
2 properties
2 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
ClusterPlanStepLogMessageInfo
object
The log message from a specified stage of an executed step in a plan.
7 properties
4 required
BasicFailedReplyElement
object
3 properties
2 required
DeploymentDeleteResponse
object
A response returned from the Deployment delete endpoint
3 properties
2 required
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
DeploymentMetricsSettings
object
The metrics settings for a deployment
2 properties
1 required
ObservabilityAbsoluteDeployment
object
The destination to send logs and metrics to
2 properties
1 required
DeploymentUpdateResources
object
Describes the Deployment resource updates
6 properties
DeploymentUpdateRequest
object
A request for updating a Deployment consisting of multiple resources
6 properties
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
ElasticsearchClusterBlockingIssues
object
WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use clusterblockingissues instead Issues that prevent the Elasticsea…
3 properties
3 required
QueryStringQuery
object
A query that uses the strict query string syntax for parsing. Will return an error for invalid syntax.
5 properties
1 required
ElasticsearchBlockingIssueElement
object
Information about index or cluster blocks
2 properties
2 required
ElasticsearchClusterUser
object
The information about an Elasticsearch cluster user.
2 properties
2 required
DeploymentsListResponse
object
Contains a list of deployments
1 property
1 required
DeploymentCreateResponse
object
A response returned from the Deployment create endpoint
6 properties
4 required
ChangeSourceInfo
object
A container for information about the source of a change.
6 properties
3 required
ResourceHeapDumps
object
3 properties
3 required
QueryContainer
object
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
11 properties
DeploymentMetadata
object
Additional information about the current deployment object.
11 properties
1 required
AppSearchPlanControlConfiguration
object
10 properties
SnapshotDependency
object
The additional resource of Elasticsearch cluster.
4 properties
2 required
KeystoreContents
object
The contents of the Elasticsearch keystore.
1 property
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
RemoteResourceRef
object
The Elasticsearch resource used as a Remote Cluster.
5 properties
3 required
IntegrationsServerPlanInfo
object
Information about the Integrations Server plan.
11 properties
3 required
EnterpriseSearchSubInfo
object
Information about the APM Servers associated with the Elasticsearch cluster.
3 properties
2 required
EnterpriseSearchConfiguration
object
7 properties
ClusterInstanceMemoryInfo
object
Information about the specific instances memory capacity and its usage
4 properties
1 required
ElasticsearchClusterRole
object
The authorization information for an Elasticsearch cluster user.
2 properties
2 required
DeploymentSettings
object
Additional configuration about the current deployment object.
6 properties
1 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
AppSearchSubInfo
object
Information about the APM Servers associated with the Elasticsearch cluster.
3 properties
2 required
ApmPlanControlConfiguration
object
The plan control configuration options for the APM Server.
10 properties
DeploymentsSearchResponse
object
Contains a list of Deployments as result of a search request.
5 properties
2 required
TrafficFilterSettings
object
The configuration settings for the traffic filter.
1 property
1 required
AppSearch
object
Holds diagnostics for an AppSearch resource
4 properties
4 required
ClusterSnapshotRepositoryInfo
object
Information about the Elasticsearch cluster snapshot repository.
3 properties
TiersResponse
object
Size configuration of Elasticsearch tiers in a deployment. Disabled tiers are omitted from responses.
7 properties
ClusterInstanceInfo
object
Information about each Kibana instance and APM Server in the Elasticsearch cluster.
14 properties
5 required
RestoreSnapshotConfiguration
object
Restores a snapshot from a local or remote repository.
6 properties
1 required
EnableIlmRequest
object
Request sent to enable ILM on a deployment.
1 property
1 required
ElasticsearchShardElement
object
Information about the shards for each Elasticsearch instance container that hosts an Elasticsearch node. TIP: When the shard is unavailable, the cluster is una…
2 properties
2 required
ApmInfo
object
The overview information for the APM Server.
14 properties
8 required
ElasticsearchMasterInfo
object
Information about the master nodes in the Elasticsearch cluster.
3 properties
3 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
DeploymentObservability
object
Observability information for a deployment
4 properties
1 required
AppSearchResourceInfo
object
Describes an App Search resource belonging to a Deployment
5 properties
5 required
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
TrustedCertificate
object
An x509 certificate used by a DirectTrustRelationship
2 properties
1 required
ElasticsearchBlockingIssues
object
Issues that prevent the Elasticsearch cluster or index from correctly operating.
2 properties
2 required
ReadOnlyResponse
object
Read-only mode response
1 property
1 required
DeploymentResourceCrudResponse
object
A response returned from the Deployment Resource endpoints
3 properties
3 required
EnterpriseSearchNodeTypes
object
Node types to enable for an Enterprise Search instance
3 properties
3 required
EnterpriseSearchPlansInfo
object
Information about current, pending, and past Enterprise Search Server plans.
4 properties
2 required
EnterpriseSearchSettings
object
The settings for the Enterprise Search.
1 property
ApmPlanInfo
object
Information about the APM Server plan.
11 properties
3 required
PrefixQuery
object
The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.
2 properties
1 required
ElasticsearchElasticUserPasswordResetResponse
object
Envelope holding the newly-reset password for a cluster's user
2 properties
2 required
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
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
ClusterMetadataCpuResourcesSettings
object
Specifies the CPU resource settings for the Elasticsearch cluster.
2 properties
IntegrationsServerPlan
object
The plan for the Integrations Server.
3 properties
1 required
EmptyResponse
object
SnapshotStatusInfo
object
Information about the snapshot status for the Elasticsearch cluster. For example, the health status.
8 properties
3 required
DeploymentGetResponse
object
Describes a given Deployment
9 properties
4 required
ReplyWarning
object
2 properties
1 required
TermQuery
object
A query for documents that contain the specified term in the inverted index.
1 property
1 required
DeploymentTemplateReference
object
Specifies the deployment template used to create the plan.
2 properties
1 required
NestedQuery
object
A query that matches nested objects.
3 properties
2 required
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…
MatchAllQuery
object
A query that matches all documents.
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
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
EnterpriseSearchTopologyElement
object
Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated)
10 properties
KibanaPlanControlConfiguration
object
The configuration settings for the timeout and fallback parameters.
10 properties
IntegrationsServerPlanControlConfiguration
object
The plan control configuration options for the Integrations Server.
10 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Stack 12
Other APIs Elastic 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
#Deployment
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Deployments 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.