How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Elastic Stack (ELK Stack)

Elastic Stack (ELK Stack) Cat API

The cat API from Elastic Stack (ELK Stack) — 45 operation(s) for cat.

Documentation Provider Profile APIs.io OpenAPI GitHub

Elastic Stack (ELK Stack) Cat 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 Cat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 47 operations across 45 paths, and defines 108 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://{elasticsearch_endpoint}.

47 operations 45 paths 108 schemas 45 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
License
Apache 2.0
Resource Areas
1

Paths & Operations 47

Across 45 paths, the API surfaces 47 operations — 45 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

cat 47
GET
/_cat/aliases
Get aliases
cat-aliases 4 params → 200
GET
/_cat/aliases/{name}
Get aliases
cat-aliases-1 5 params → 200
GET
/_cat/allocation
Get shard allocation information
cat-allocation 4 params → 200
GET
/_cat/allocation/{node_id}
Get shard allocation information
cat-allocation-1 5 params → 200
GET
/_cat/circuit_breaker
Get circuit breakers statistics
cat-circuit-breaker 4 params → 200
GET
/_cat/circuit_breaker/{circuit_breaker_patterns}
Get circuit breakers statistics
cat-circuit-breaker-1 5 params → 200
GET
/_cat/component_templates
Get component templates
cat-component-templates 4 params → 200
GET
/_cat/component_templates/{name}
Get component templates
cat-component-templates-1 5 params → 200
GET
/_cat/count
Get a document count
cat-count-1 2 params body → 200
POST
/_cat/count
Get a document count
cat-count 2 params body → 200
GET
/_cat/count/{index}
Get a document count
cat-count-3 3 params body → 200
POST
/_cat/count/{index}
Get a document count
cat-count-2 3 params body → 200
GET
/_cat/fielddata
Get field data cache information
cat-fielddata 3 params → 200
GET
/_cat/fielddata/{fields}
Get field data cache information
cat-fielddata-1 4 params → 200
GET
/_cat/health
Get the cluster health status
cat-health 3 params → 200
GET
/_cat
Get CAT help
cat-help → 200
GET
/_cat/indices
Get index information
cat-indices 7 params → 200
GET
/_cat/indices/{index}
Get index information
cat-indices-1 8 params → 200
GET
/_cat/master
Get master node information
cat-master 4 params → 200
GET
/_cat/ml/data_frame/analytics
Get data frame analytics jobs
cat-ml-data-frame-analytics 3 params → 200
GET
/_cat/ml/data_frame/analytics/{id}
Get data frame analytics jobs
cat-ml-data-frame-analytics-1 4 params → 200
GET
/_cat/ml/datafeeds
Get datafeeds
cat-ml-datafeeds 3 params → 200
GET
/_cat/ml/datafeeds/{datafeed_id}
Get datafeeds
cat-ml-datafeeds-1 4 params → 200
GET
/_cat/ml/anomaly_detectors
Get anomaly detection jobs
cat-ml-jobs 3 params → 200
GET
/_cat/ml/anomaly_detectors/{job_id}
Get anomaly detection jobs
cat-ml-jobs-1 4 params → 200
GET
/_cat/ml/trained_models
Get trained models
cat-ml-trained-models 5 params → 200
GET
/_cat/ml/trained_models/{model_id}
Get trained models
cat-ml-trained-models-1 6 params → 200
GET
/_cat/nodeattrs
Get node attribute information
cat-nodeattrs 4 params → 200
GET
/_cat/nodes
Get node information
cat-nodes 5 params → 200
GET
/_cat/pending_tasks
Get pending task information
cat-pending-tasks 4 params → 200
GET
/_cat/plugins
Get plugin information
cat-plugins 5 params → 200
GET
/_cat/recovery
Get shard recovery information
cat-recovery 5 params → 200
GET
/_cat/recovery/{index}
Get shard recovery information
cat-recovery-1 6 params → 200
GET
/_cat/repositories
Get snapshot repository information
cat-repositories 4 params → 200
GET
/_cat/segments
Get segment information
cat-segments 9 params → 200
GET
/_cat/segments/{index}
Get segment information
cat-segments-1 10 params → 200
GET
/_cat/shards
Get shard information
cat-shards 3 params → 200
GET
/_cat/shards/{index}
Get shard information
cat-shards-1 4 params → 200
GET
/_cat/snapshots
Get snapshot information
cat-snapshots 4 params → 200
GET
/_cat/snapshots/{repository}
Get snapshot information
cat-snapshots-1 5 params → 200
GET
/_cat/tasks
Get task information
cat-tasks 8 params → 200
GET
/_cat/templates
Get index template information
cat-templates 4 params → 200
GET
/_cat/templates/{name}
Get index template information
cat-templates-1 5 params → 200
GET
/_cat/thread_pool
Get thread pool statistics
cat-thread-pool 4 params → 200
GET
/_cat/thread_pool/{thread_pool_patterns}
Get thread pool statistics
cat-thread-pool-1 5 params → 200
GET
/_cat/transforms
Get transform information
cat-transforms 5 params → 200
GET
/_cat/transforms/{transform_id}
Get transform information
cat-transforms-1 6 params → 200

Schemas 108

The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are cat.indices.IndicesRecord (142 properties), cat.nodes.NodesRecord (97 properties), cat.shards.ShardsRecord (77 properties), cat.ml_jobs.JobsRecord (60 properties). Each schema is shown below with its type and property counts.

cat._types.CatDatafeedColumns
cat._types.CatTrainedModelsColumns
cat._types.CatFieldDataColumns
cat._types.CatIndicesColumn
_types.Percentage
_types.UnitSeconds
number
Time unit for seconds
_types.EpochTimeUnitMillis
_types.ExpandWildcards
ml._types.MemoryStatus
string
cat._types.CatThreadPoolColumns
cat._types.CatShardColumn
cat.ml_data_frame_analytics.DataFrameAnalyticsRecord
object
16 properties
cat.transforms.TransformsRecord
object
33 properties
_types.ByteSize
watcher._types.HourAndMinute
object
2 properties 2 required
cat.allocation.AllocationRecord
object
13 properties
cat.circuit_breaker.CircuitBreakerRecord
object
9 properties
_types.VersionString
string
_types.Ip
string
cat._types.CatNodeattrsColumn
cat._types.CatPendingTasksColumn
cat._types.CatPendingTasksColumns
_types.Host
string
cat._types.CatHealthColumns
_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…
cat.ml_trained_models.TrainedModelsRecord
object
18 properties
cat._types.CatAnomalyDetectorColumn
string
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
cat.aliases.AliasesRecord
object
6 properties
cat._types.CatComponentColumns
_types.EpochTimeUnitSeconds
cat._types.CatCountColumns
cat._types.CatSnapshotsColumn
cat.segments.SegmentsRecord
object
15 properties
cat._types.CatNodeattrsColumns
cat.master.MasterRecord
object
4 properties
cat._types.CatNodeColumns
_types.IndexName
string
cat._types.CatShardColumns
_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…
watcher._types.ScheduleTimeOfDay
A time of day, expressed either as hh:mm, noon, midnight, or an hour/minutes structure.
cat._types.CatTemplatesColumn
cat._types.CatTasksColumns
cat._types.CatThreadPoolColumn
_types.ExpandWildcard
string
ml._types.DatafeedState
string
cat._types.CatDfaColumns
cat._types.CatNodeColumn
cat.component_templates.ComponentTemplate
object
7 properties 7 required
cat.snapshots.SnapshotsRecord
object
13 properties
cat.indices.IndicesRecord
object
142 properties
ml._types.CategorizationStatus
string
cat._types.CatTasksColumn
cat._types.CatTrainedModelsColumn
string
cat._types.CatDfaColumn
string
cat.recovery.RecoveryRecord
object
27 properties
_types.HealthStatus
string
cat._types.CatFieldDataColumn
cat.pending_tasks.PendingTasksRecord
object
4 properties
cat._types.CatIndicesColumns
_types.NodeId
string
cat.thread_pool.ThreadPoolRecord
object
20 properties
_types.Id
string
cat._types.CatSegmentsColumns
cat._types.CatTransformColumns
cat._types.CatRecoveryColumns
cat._types.CatTemplatesColumns
_types.Names
ml._types.JobState
string
cat._types.CatPluginsColumn
cat._types.CatPluginsColumns
_spec_utils.StringifiedEpochTimeUnitSeconds
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
cat.health.HealthRecord
object
15 properties
cat._types.CatMasterColumns
cat.templates.TemplatesRecord
object
5 properties
_types.Indices
cat._types.CatAliasesColumn
cat._types.CatAnomalyDetectorColumns
cat.repositories.RepositoriesRecord
object
2 properties
cat.count.CountRecord
object
3 properties
cat.plugins.PluginsRecord
object
6 properties
cat._types.CatMasterColumn
cat._types.CatSnapshotsColumns
cat.tasks.TasksRecord
object
16 properties
cat.nodes.NodesRecord
object
97 properties
cat.ml_jobs.JobsRecord
object
60 properties
cat._types.CatHealthColumn
cat.ml_datafeeds.DatafeedsRecord
object
12 properties
cat._types.CatSegmentsColumn
_types.TimeOfDay
string
Time of day, expressed as HH:MM:SS
_types.Fields
cat._types.CatDatafeedColumn
string
cat.shards.ShardsRecord
object
77 properties
cat._types.CatAliasesColumns
cat._types.CatTransformColumn
string
cat._types.CatComponentColumn
cat._types.CatAllocationColumns
_types.NodeIds
cat.nodeattrs.NodeAttributesRecord
object
8 properties
cat._types.CatCircuitBreakerColumn
cat._types.CatRecoveryColumn
cat._types.CatCircuitBreakerColumns
cat._types.CatCountColumn
_spec_utils.Stringifieddouble
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_types.Name
string
cat._types.CatAllocationColumn
cat.fielddata.FielddataRecord
object
6 properties
_types.UnitMillis
number
Time unit for milliseconds

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-cat-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
AE Profile APIs.io
Elastic Stack (ELK Stack) Accounts API
AE Profile APIs.io
Elastic Stack (ELK Stack) Actions API
AE Profile APIs.io
Elastic Stack (ELK Stack) agent builder API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting V2 API
AE Profile APIs.io
Elastic Stack (ELK Stack) Analytics API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent configuration API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent keys API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM annotations API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM server schema API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM sourcemaps API
AE Profile APIs.io
#Cat
← Back to E APIs
API Details
ID
elk-stack:elk-stack-cat-api
Base URL
https://{elasticsearch_endpoint}
Docs
https://www.elastic.co/docs/api/doc/elasticsearch/
Provider
Elastic Stack (ELK Stack)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=elk-stack-cat-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/elk-stack-cat-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Cat 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.