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

Elastic Stack (ELK Stack) Cat API

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

Elastic Stack (ELK Stack) Cat 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 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, at version 1.0.

Requests are made against 2 base URLs: http://localhost:9200, https://{host}:{port}.

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
API Version
1.0
Base URL
https://{elasticsearch_endpoint}
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

Elastic Stack (ELK Stack) Cat API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (apiKeyAuth).

  • apiKeyAuth — ApiKey

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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
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.