Elastic Stack (ELK Stack) Cluster API
The cluster API from Elastic Stack (ELK Stack) — 35 operation(s) for cluster.
Elastic Stack (ELK Stack) Cluster 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 Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 38 operations across 35 paths, and defines 292 schemas. It is described by OpenAPI 3.2.0.
Requests are made against the base URL https://{elasticsearch_endpoint}.
38 operations
35 paths
292 schemas
2 DELETE29 GET1 HEAD5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 38
Across 35 paths, the API surfaces 38 operations — 2 DELETE, 29 GET, 1 HEAD, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
cluster 38
GET
/_cluster/allocation/explain
Explain the shard allocations
POST
/_cluster/allocation/explain
Explain the shard allocations
POST
/_cluster/voting_config_exclusions
Update voting configuration exclusions
DELETE
/_cluster/voting_config_exclusions
Clear cluster voting config exclusions
GET
/_cluster/settings
Get cluster-wide settings
PUT
/_cluster/settings
Update the cluster settings
GET
/_cluster/health
Get the cluster health status
GET
/_cluster/health/{index}
Get the cluster health status
GET
/_info/{target}
Get cluster info
GET
/_cluster/pending_tasks
Get the pending cluster tasks
GET
/_remote/info
Get remote cluster information
POST
/_cluster/reroute
Reroute the cluster
GET
/_cluster/state
Get the cluster state
GET
/_cluster/state/{metric}
Get the cluster state
GET
/_cluster/state/{metric}/{index}
Get the cluster state
GET
/_cluster/stats
Get cluster statistics
GET
/_cluster/stats/nodes/{node_id}
Get cluster statistics
HEAD
/
Ping the cluster
DELETE
/_nodes/{node_id}/_repositories_metering/{max_archive_version}
Clear the archived repositories metering
GET
/_nodes/{node_id}/_repositories_metering
Get cluster repositories metering
GET
/_nodes/hot_threads
Get the hot threads for nodes
GET
/_nodes/{node_id}/hot_threads
Get the hot threads for nodes
GET
/_nodes
Get node information
GET
/_nodes/{node_id}
Get node information
GET
/_nodes/{metric}
Get node information
GET
/_nodes/{node_id}/{metric}
Get node information
POST
/_nodes/reload_secure_settings
Reload the keystore on nodes in the cluster
POST
/_nodes/{node_id}/reload_secure_settings
Reload the keystore on nodes in the cluster
GET
/_nodes/stats
Get node statistics
GET
/_nodes/{node_id}/stats
Get node statistics
GET
/_nodes/stats/{metric}
Get node statistics
GET
/_nodes/{node_id}/stats/{metric}
Get node statistics
GET
/_nodes/stats/{metric}/{index_metric}
Get node statistics
GET
/_nodes/{node_id}/stats/{metric}/{index_metric}
Get node statistics
GET
/_nodes/usage
Get feature usage information
GET
/_nodes/{node_id}/usage
Get feature usage information
GET
/_nodes/usage/{metric}
Get feature usage information
GET
/_nodes/{node_id}/usage/{metric}
Get feature usage information
Schemas 292
The contract defines 292 schemas that model the data the API accepts and returns. The most detailed are nodes.info.NodeInfoSettingsIngest (34 properties), indices.stats.ShardStats (28 properties), nodes.info.NodeInfo (27 properties), nodes._types.DataPathStats (24 properties). Each schema is shown below with its type and property counts.
nodes.usage.NodeUsage
object
4 properties
4 required
nodes._types.ClusterStateQueue
object
3 properties
cluster.stats.ClusterProcessor
object
5 properties
4 required
_types.FieldMemoryUsage
object
2 properties
1 required
_types.EpochTimeUnitMillis
nodes._types.Context
object
4 properties
nodes._types.JvmThreads
object
2 properties
nodes.info.NodeInfoDiscover
object
3 properties
_types.RecoveryStats
object
8 properties
3 required
nodes.info.NodeInfoIngest
object
1 property
1 required
nodes.info.NodeInfoIngestProcessor
object
1 property
1 required
nodes.info.NodeInfoRepositories
object
1 property
1 required
cluster.allocation_explain.ReservedSize
object
4 properties
4 required
_types.Ip
string
cluster.stats.RepositoryStatsShards
object
4 properties
4 required
_types.Host
string
nodes.info.NodeInfoXpackSecurityAuthcRealmsStatus
object
2 properties
1 required
nodes._types.Client
object
14 properties
_types.DateTime
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch…
nodes.stats.ResponseBase
_types.ClusterInfoTarget
string
_types.CompletionStats
object
3 properties
1 required
_types.IndexName
string
nodes._types.PublishedClusterStates
object
3 properties
_types.IndexingStats
object
18 properties
11 required
nodes.info.NodeInfoClient
object
1 property
1 required
cluster.stats.DenseVectorStats
object
2 properties
1 required
_types.Uuid
string
cluster.allocation_explain.UnassignedInformationReason
string
indices.stats.ShardRetentionLeases
object
3 properties
3 required
cluster.state.ClusterStateMetrics
nodes.info.NodeInfoSettingsNetwork
object
1 property
nodes._types.OperatingSystem
object
5 properties
nodes.info.NodeInfoSettingsHttpType
object
1 property
1 required
_types.StoreStats
object
6 properties
2 required
cluster.stats.ClusterJvmVersion
object
7 properties
7 required
nodes.usage.ResponseBase
_types.DateFormat
string
cluster.stats.IndexingPressure
object
1 property
1 required
cluster.stats.ExtendedRetrieversSearchUsage
object
1 property
_types.HealthStatus
string
nodes.info.NodeInfoSearchRemote
object
1 property
1 required
cluster.stats.ClusterOperatingSystemPrettyName
object
2 properties
2 required
cluster.stats.ClusterIngest
object
2 properties
2 required
_types.Id
string
nodes._types.TransportHistogram
object
5 properties
cluster.health.IndexHealthStats
object
10 properties
9 required
nodes.info.RemoveClusterServer
object
2 properties
2 required
cluster.stats.ClusterOperatingSystem
object
6 properties
5 required
cluster.stats.ClusterIndices
object
14 properties
11 required
cluster.reroute.RerouteDecision
object
3 properties
3 required
_types.WaitForActiveShardOptions
string
_types.Indices
indices._types.IndexRoutingRebalanceOptions
string
nodes.info.NodeInfoSettingsNode
object
3 properties
2 required
nodes._types.HttpRouteResponses
object
5 properties
4 required
nodes.clear_repositories_metering_archive.ResponseBase
cluster.stats.IndicesVersions
object
5 properties
4 required
cluster.health.ShardHealthStats
object
7 properties
7 required
nodes.info.NodeInfoSettingsHttp
object
4 properties
1 required
nodes._types.Cpu
object
9 properties
nodes.info.NodeInfoAggregation
object
1 property
1 required
nodes.info.NodeInfoXpackSecurity
object
4 properties
1 required
_types.Fields
_types.WarmerStats
object
4 properties
3 required
cluster.stats.CharFilterTypes
object
10 properties
9 required
indices.stats.ShardLease
object
4 properties
4 required
nodes.info.NodeInfoXpackSecurityAuthc
object
2 properties
nodes.info.NodeInfoXpackLicense
object
1 property
1 required
nodes.info.NodeInfoMemory
object
2 properties
2 required
cluster.stats.ClusterProcess
object
2 properties
2 required
nodes._types.Stats
object
24 properties
cluster.stats.CCSUsageStats
object
12 properties
10 required
nodes.info.NodeInfoHttp
object
4 properties
3 required
nodes.info.NodeInfoSettingsCluster
object
5 properties
2 required
cluster.allocation_explain.AllocationExplainDecision
string
nodes._types.Process
object
5 properties
cluster.stats.CCSUsageClusterStats
object
3 properties
3 required
nodes._types.IoStatDevice
object
6 properties
nodes.reload_secure_settings.ResponseBase
cluster.allocation_explain.ClusterInfo
object
5 properties
4 required
indices.stats.MappingStats
object
6 properties
5 required
_types.CommonStatsFlag
string
nodes.info.NodeInfoSearch
object
1 property
1 required
_types.RefreshStats
object
7 properties
5 required
nodes._types.Ingest
object
2 properties
cluster.reroute.CommandAllocateReplicaAction
object
3 properties
3 required
_types.Password
string
_types.ByteSize
cluster.stats.CCSUsageTimeValue
object
3 properties
3 required
_types.QueryCacheStats
object
8 properties
7 required
nodes.info.NodeInfoRepositoriesUrl
object
1 property
1 required
nodes._types.HttpRouteRequests
object
4 properties
3 required
nodes.info.DeprecationIndexing
object
1 property
1 required
cluster.health.HealthResponseBody
object
19 properties
16 required
nodes._types.TransportMessageSizeHistogramBucket
object
5 properties
1 required
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
nodes.info.NodeInfoXpackMl
object
1 property
nodes.info.NodeOperatingSystemInfo
object
10 properties
6 required
_types.FieldSizeUsage
object
2 properties
1 required
nodes._types.RepositoryLocation
object
3 properties
1 required
nodes._types.NodeReloadResult
object
6 properties
1 required
nodes._types.Scripting
object
5 properties
_types.ExpandWildcard
string
indices._types.IndexRouting
object
2 properties
_types.Level
string
nodes._types.GarbageCollectorTotal
object
3 properties
nodes.info.NodeInfoIngestDownloader
object
1 property
1 required
nodes.info.NodeInfoXpackLicenseType
object
1 property
1 required
nodes.info.NodeProcessInfo
object
3 properties
3 required
nodes._types.Transport
object
11 properties
nodes._types.RequestCounts
object
11 properties
indices.stats.ShardFileSizeInfo
object
6 properties
2 required
_types.NodeId
string
nodes.get_repositories_metering_info.ResponseBase
nodes._types.IngestStats
object
10 properties
7 required
nodes._types.Allocations
object
7 properties
nodes.info.NodeJvmInfo
object
12 properties
11 required
nodes._types.AdaptiveSelection
object
7 properties
cluster.stats.CCSStats
object
3 properties
1 required
cluster.stats.ClusterJvmMemory
object
4 properties
2 required
nodes.info.NodeInfoSettingsTransportType
object
1 property
1 required
nodes.stats.NodeStatsMetric
string
nodes._types.SizeHttpHistogram
object
5 properties
1 required
nodes.info.NodeInfoJvmMemory
object
10 properties
5 required
indices.stats.ShardsTotalStats
object
1 property
1 required
_types.SearchStats
object
21 properties
14 required
indices._types.IndexRoutingRebalance
object
1 property
1 required
cluster.reroute.CommandCancelAction
object
4 properties
3 required
indices.stats.ShardStats
object
28 properties
_types.Ids
nodes._types.TransportActionMessageStats
object
4 properties
3 required
nodes._types.ExtendedMemoryStats
cluster.stats.ClusterProcessOpenFileDescriptors
object
3 properties
3 required
_types.SequenceNumber
number
cluster.stats.OperatingSystemMemoryInfo
object
10 properties
5 required
cluster.stats.StatsResponseBase
nodes._types.RepositoryMeteringInformation
object
9 properties
7 required
_types.ClusterInfoTargets
nodes.info.NodeInfoAction
object
1 property
1 required
_types.TranslogStats
object
7 properties
5 required
cluster.health.WaitForNodes
nodes.info.NodeInfoXpackSecuritySsl
object
1 property
1 required
_types.ThreadType
string
nodes.info.NodeInfoIngestInfo
object
1 property
1 required
cluster.allocation_explain.CurrentNode
object
6 properties
6 required
_types.RequestCacheStats
object
5 properties
4 required
_types.Name
string
nodes.info.NodesInfoMetric
string
cluster.stats.ClusterNetworkTypes
object
2 properties
2 required
nodes._types.ThreadCount
object
6 properties
cluster.remote_info.ClusterRemoteInfo
cluster.stats.ClusterShardMetrics
object
3 properties
3 required
nodes.info.NodeInfoScript
object
2 properties
1 required
nodes._types.DataPathStats
object
24 properties
_types.GlobalOrdinalFieldStats
object
3 properties
2 required
cluster.stats.ClusterOperatingSystemArchitecture
object
2 properties
2 required
_types.TransportAddress
string
indices._types.IndexRoutingAllocationDisk
object
1 property
nodes._types.IoStats
object
2 properties
_types.ExpandWildcards
cluster.stats.ExtendedSectionSearchUsage
object
1 property
nodes.stats.NodeStatsMetrics
nodes._types.Http
object
4 properties
1 required
_types.VersionString
string
_types.NodeRoles
array
nodes._types.KeyedProcessor
object
2 properties
cluster.allocation_explain.UnassignedInformation
object
7 properties
2 required
nodes.info.NodesInfoMetrics
cluster.allocation_explain.AllocationDecision
object
3 properties
3 required
cluster.stats.RepositoryStatsCurrentCounts
object
7 properties
7 required
nodes._types.Processor
object
5 properties
cluster.stats.ExtendedSearchUsage
object
2 properties
nodes.usage.NodesUsageMetrics
nodes._types.CgroupCpu
object
4 properties
_types.DurationValueUnitNanos
cluster.stats.FieldTypesMappings
object
7 properties
3 required
cluster.stats.ClusterFileSystem
object
17 properties
nodes._types.Jvm
object
8 properties
nodes.info.NodeInfoXpackSecurityAuthcRealms
object
3 properties
nodes._types.IndexingPressureMemory
object
4 properties
nodes._types.Recording
object
4 properties
nodes._types.PressureMemory
object
15 properties
nodes._types.CgroupCpuStat
object
3 properties
cluster.reroute.Command
object
5 properties
cluster.stats.SearchUsageStats
object
6 properties
6 required
nodes._types.IndexingPressure
object
1 property
nodes.info.NodeInfo
object
27 properties
13 required
nodes._types.SerializedClusterState
object
2 properties
cluster.allocation_explain.Decision
string
nodes._types.NodesResponseBase
object
1 property
nodes.info.NodeInfoSettingsTransportFeatures
object
1 property
1 required
indices.stats.ShardRoutingState
string
nodes._types.Breaker
object
6 properties
_types.UnitNanos
number
Time unit for nanoseconds
_types.Names
cluster.stats.ClusterProcessCpu
object
1 property
1 required
cluster.stats.SnapshotCurrentCounts
object
5 properties
5 required
nodes._types.SerializedClusterStateDetail
object
5 properties
nodes.info.NodeInfoOSCPU
object
8 properties
8 required
nodes._types.Pool
object
8 properties
nodes._types.RepositorySnapshotStats
object
14 properties
9 required
_types.SegmentsStats
object
23 properties
13 required
nodes._types.JvmMemoryStats
object
12 properties
nodes.info.NodeInfoSettingsClusterElection
object
1 property
1 required
_types.BulkStats
object
9 properties
5 required
_types.FlushStats
object
6 properties
4 required
_types.NodeRole
string
nodes.info.NodeInfoBootstrap
object
1 property
1 required
cluster.stats.ClusterNodes
object
12 properties
12 required
_types.GetStats
object
10 properties
7 required
cluster.allocation_explain.NodeAllocationExplanation
object
9 properties
6 required
cluster.allocation_explain.DiskUsage
object
6 properties
6 required
_types.GlobalOrdinalsStats
object
3 properties
1 required
nodes.usage.NodesUsageMetric
string
_types.MergesStats
object
16 properties
10 required
nodes.info.NodeInfoXpack
object
4 properties
1 required
cluster.stats.ExtendedTextSimilarityRetrieverUsage
object
1 property
cluster.stats.ClusterJvm
object
5 properties
4 required
indices.stats.ShardRouting
object
4 properties
3 required
nodes.info.NodeInfoSettingsIngest
object
34 properties
cluster.allocation_explain.NodeDiskUsage
object
3 properties
3 required
nodes._types.MemoryStats
object
14 properties
cluster.stats.RemoteClusterInfo
object
15 properties
12 required
_types.DurationValueUnitMillis
cluster.state.ClusterStateMetric
string
_types.DocStats
object
4 properties
2 required
nodes._types.GarbageCollector
object
1 property
cluster.reroute.CommandMoveAction
object
4 properties
4 required
indices._types.IndexRoutingAllocationOptions
string
cluster.pending_tasks.PendingTask
object
6 properties
5 required
nodes._types.Discovery
object
5 properties
indices.stats.ShardPath
object
3 properties
3 required
cluster.reroute.RerouteParameters
object
6 properties
4 required
nodes._types.HttpRoute
object
2 properties
2 required
cluster.stats.NodePackagingType
object
3 properties
3 required
_types.NodeStatistics
object
Contains statistics about the number of nodes selected by the request.
4 properties
3 required
cluster.reroute.RerouteExplanation
object
3 properties
3 required
indices._types.IndexRoutingAllocationInclude
object
2 properties
nodes._types.ScriptCache
object
4 properties
cluster.allocation_explain.AllocationStore
object
6 properties
6 required
cluster.stats.FieldTypes
object
10 properties
3 required
cluster.stats.MultipleSynonymGraphFilter
object
2 properties
nodes.info.NodeThreadPoolInfo
object
6 properties
2 required
nodes._types.JvmClasses
object
3 properties
nodes.info.NodeInfoXpackSecurityAuthcToken
object
1 property
1 required
nodes._types.FileSystemTotal
object
6 properties
indices._types.IndexRoutingAllocation
object
4 properties
_types.VersionNumber
number
nodes._types.CpuAcct
object
2 properties
nodes.info.NodeInfoTransport
object
3 properties
3 required
nodes._types.NodeBufferPool
object
5 properties
_types.FielddataStats
object
5 properties
2 required
_types.NodeStatsLevel
string
cluster.remote_info.ClusterRemoteProxyInfo
object
9 properties
8 required
indices._types.IndexRoutingAllocationInitialRecovery
object
1 property
_types.WaitForEvents
string
_types.Duration
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indica…
_types.WaitForActiveShards
indices.stats.ShardCommit
object
4 properties
4 required
nodes._types.Cgroup
object
3 properties
cluster.stats.ClusterIndicesShardsIndex
object
3 properties
3 required
cluster.remote_info.ClusterRemoteSniffInfo
object
7 properties
7 required
cluster.stats.DenseVectorOffHeapStats
object
15 properties
7 required
nodes.info.NodeInfoPath
object
4 properties
nodes._types.FileSystem
object
4 properties
nodes.info.NodeInfoSettingsTransport
object
3 properties
1 required
cluster.stats.ClusterIndicesShards
object
Contains statistics about shards assigned to selected nodes.
4 properties
indices.stats.ShardSequenceNumber
object
3 properties
3 required
_types.PluginStats
object
9 properties
9 required
cluster.stats.PerRepositoryStats
object
4 properties
3 required
cluster.stats.RuntimeFieldTypes
object
14 properties
14 required
cluster.reroute.CommandAllocatePrimaryAction
object
4 properties
4 required
indices.stats.ShardQueryCache
object
8 properties
7 required
_types.CommonStatsFlags
nodes._types.CgroupMemory
object
3 properties
nodes.info.NodeInfoSettings
object
15 properties
4 required
cluster.stats.SparseVectorStats
object
1 property
1 required
nodes._types.IngestTotal
object
5 properties
4 required
cluster.stats.SynonymsStats
object
2 properties
2 required
_types.NodeName
string
cluster.stats.ClusterSnapshotStats
object
2 properties
2 required
nodes._types.ClusterStateUpdate
object
15 properties
1 required
nodes._types.TransportActionStats
object
2 properties
2 required
_types.NodeIds
nodes.info.ResponseBase
nodes._types.ClusterAppliedStats
object
1 property
cluster.stats.ClusterOperatingSystemName
object
2 properties
2 required
nodes._types.TimeHttpHistogram
object
5 properties
1 required
cluster.stats.ClusterNodeCount
object
16 properties
1 required
_types.ErrorCause
object
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on th…
6 properties
1 required
_types.UnitMillis
number
Time unit for milliseconds
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
#Cluster
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Cluster 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.