Elastic Stack (ELK Stack) Cat API

openapi: 3.2.0
info:
  title: Elasticsearch Request & Response Specification Cat API
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
tags:
- name: cat
paths:
  /_cat/aliases:
    get:
      tags:
      - cat
      summary: Get aliases
      description: 'Get the cluster''s index aliases, including filter and routing information.

        This API does not return data stream aliases.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.


        ## Required authorization


        * Index privileges: `view_index_metadata`

        '
      operationId: cat-aliases
      parameters:
      - $ref: '#/components/parameters/cat.aliases-h'
      - $ref: '#/components/parameters/cat.aliases-s'
      - $ref: '#/components/parameters/cat.aliases-expand_wildcards'
      - $ref: '#/components/parameters/cat.aliases-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/cat.aliases-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/aliases/{name}:
    get:
      tags:
      - cat
      summary: Get aliases
      description: 'Get the cluster''s index aliases, including filter and routing information.

        This API does not return data stream aliases.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.


        ## Required authorization


        * Index privileges: `view_index_metadata`

        '
      operationId: cat-aliases-1
      parameters:
      - $ref: '#/components/parameters/cat.aliases-name'
      - $ref: '#/components/parameters/cat.aliases-h'
      - $ref: '#/components/parameters/cat.aliases-s'
      - $ref: '#/components/parameters/cat.aliases-expand_wildcards'
      - $ref: '#/components/parameters/cat.aliases-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/cat.aliases-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/allocation:
    get:
      tags:
      - cat
      summary: Get shard allocation information
      description: 'Get a snapshot of the number of shards allocated to each data node and their disk space.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-allocation
      parameters:
      - $ref: '#/components/parameters/cat.allocation-h'
      - $ref: '#/components/parameters/cat.allocation-s'
      - $ref: '#/components/parameters/cat.allocation-local'
      - $ref: '#/components/parameters/cat.allocation-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/cat.allocation-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/allocation/{node_id}:
    get:
      tags:
      - cat
      summary: Get shard allocation information
      description: 'Get a snapshot of the number of shards allocated to each data node and their disk space.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-allocation-1
      parameters:
      - $ref: '#/components/parameters/cat.allocation-node_id'
      - $ref: '#/components/parameters/cat.allocation-h'
      - $ref: '#/components/parameters/cat.allocation-s'
      - $ref: '#/components/parameters/cat.allocation-local'
      - $ref: '#/components/parameters/cat.allocation-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/cat.allocation-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/circuit_breaker:
    get:
      tags:
      - cat
      summary: Get circuit breakers statistics
      description: 'IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-circuit-breaker
      parameters:
      - $ref: '#/components/parameters/cat.circuit_breaker-h'
      - $ref: '#/components/parameters/cat.circuit_breaker-s'
      - $ref: '#/components/parameters/cat.circuit_breaker-local'
      - $ref: '#/components/parameters/cat.circuit_breaker-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/cat.circuit_breaker-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/circuit_breaker/{circuit_breaker_patterns}:
    get:
      tags:
      - cat
      summary: Get circuit breakers statistics
      description: 'IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-circuit-breaker-1
      parameters:
      - $ref: '#/components/parameters/cat.circuit_breaker-circuit_breaker_patterns'
      - $ref: '#/components/parameters/cat.circuit_breaker-h'
      - $ref: '#/components/parameters/cat.circuit_breaker-s'
      - $ref: '#/components/parameters/cat.circuit_breaker-local'
      - $ref: '#/components/parameters/cat.circuit_breaker-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/cat.circuit_breaker-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/component_templates:
    get:
      tags:
      - cat
      summary: Get component templates
      description: 'Get information about component templates in a cluster.

        Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the get component template API.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-component-templates
      parameters:
      - $ref: '#/components/parameters/cat.component_templates-h'
      - $ref: '#/components/parameters/cat.component_templates-s'
      - $ref: '#/components/parameters/cat.component_templates-local'
      - $ref: '#/components/parameters/cat.component_templates-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/cat.component_templates-200'
      x-state: Generally available; Added in 5.1.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/component_templates/{name}:
    get:
      tags:
      - cat
      summary: Get component templates
      description: 'Get information about component templates in a cluster.

        Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the get component template API.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-component-templates-1
      parameters:
      - $ref: '#/components/parameters/cat.component_templates-name'
      - $ref: '#/components/parameters/cat.component_templates-h'
      - $ref: '#/components/parameters/cat.component_templates-s'
      - $ref: '#/components/parameters/cat.component_templates-local'
      - $ref: '#/components/parameters/cat.component_templates-master_timeout'
      responses:
        '200':
          $ref: '#/components/responses/cat.component_templates-200'
      x-state: Generally available; Added in 5.1.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/count:
    get:
      tags:
      - cat
      summary: Get a document count
      description: 'Get quick access to a document count for a data stream, an index, or an entire cluster.

        The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the count API.


        NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the `POST` method. This is primarily intended for project routing in serverless environments.


        ## Required authorization


        * Index privileges: `read`

        '
      operationId: cat-count-1
      parameters:
      - $ref: '#/components/parameters/cat.count-h'
      - $ref: '#/components/parameters/cat.count-s'
      requestBody:
        $ref: '#/components/requestBodies/cat.count'
      responses:
        '200':
          $ref: '#/components/responses/cat.count-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    post:
      tags:
      - cat
      summary: Get a document count
      description: 'Get quick access to a document count for a data stream, an index, or an entire cluster.

        The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the count API.


        NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the `POST` method. This is primarily intended for project routing in serverless environments.


        ## Required authorization


        * Index privileges: `read`

        '
      operationId: cat-count
      parameters:
      - $ref: '#/components/parameters/cat.count-h'
      - $ref: '#/components/parameters/cat.count-s'
      requestBody:
        $ref: '#/components/requestBodies/cat.count'
      responses:
        '200':
          $ref: '#/components/responses/cat.count-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/count/{index}:
    get:
      tags:
      - cat
      summary: Get a document count
      description: 'Get quick access to a document count for a data stream, an index, or an entire cluster.

        The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the count API.


        NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the `POST` method. This is primarily intended for project routing in serverless environments.


        ## Required authorization


        * Index privileges: `read`

        '
      operationId: cat-count-3
      parameters:
      - $ref: '#/components/parameters/cat.count-index'
      - $ref: '#/components/parameters/cat.count-h'
      - $ref: '#/components/parameters/cat.count-s'
      requestBody:
        $ref: '#/components/requestBodies/cat.count'
      responses:
        '200':
          $ref: '#/components/responses/cat.count-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    post:
      tags:
      - cat
      summary: Get a document count
      description: 'Get quick access to a document count for a data stream, an index, or an entire cluster.

        The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.


        IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the count API.


        NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the `POST` method. This is primarily intended for project routing in serverless environments.


        ## Required authorization


        * Index privileges: `read`

        '
      operationId: cat-count-2
      parameters:
      - $ref: '#/components/parameters/cat.count-index'
      - $ref: '#/components/parameters/cat.count-h'
      - $ref: '#/components/parameters/cat.count-s'
      requestBody:
        $ref: '#/components/requestBodies/cat.count'
      responses:
        '200':
          $ref: '#/components/responses/cat.count-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/fielddata:
    get:
      tags:
      - cat
      summary: Get field data cache information
      description: 'Get the amount of heap memory currently used by the field data cache on every data node in the cluster.


        IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the nodes stats API.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-fielddata
      parameters:
      - $ref: '#/components/parameters/cat.fielddata-fields_'
      - $ref: '#/components/parameters/cat.fielddata-h'
      - $ref: '#/components/parameters/cat.fielddata-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.fielddata-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/fielddata/{fields}:
    get:
      tags:
      - cat
      summary: Get field data cache information
      description: 'Get the amount of heap memory currently used by the field data cache on every data node in the cluster.


        IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the nodes stats API.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-fielddata-1
      parameters:
      - $ref: '#/components/parameters/cat.fielddata-fields'
      - $ref: '#/components/parameters/cat.fielddata-fields_'
      - $ref: '#/components/parameters/cat.fielddata-h'
      - $ref: '#/components/parameters/cat.fielddata-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.fielddata-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/health:
    get:
      tags:
      - cat
      summary: Get the cluster health status
      description: 'IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use the cluster health API.

        This API is often used to check malfunctioning clusters.

        To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:

        `HH:MM:SS`, which is human-readable but includes no date information;

        `Unix epoch time`, which is machine-sortable and includes date information.

        The latter format is useful for cluster recoveries that take multiple days.

        You can use the cat health API to verify cluster health across multiple nodes.

        You also can use the API to track the recovery of a large cluster over a longer period of time.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-health
      parameters:
      - in: query
        name: ts
        description: If true, returns `HH:MM:SS` and Unix epoch timestamps.
        deprecated: false
        schema:
          default: true
          type: boolean
        style: form
      - in: query
        name: h
        description: A comma-separated list of columns names to display. It supports simple wildcards.
        deprecated: false
        schema:
          $ref: '#/components/schemas/cat._types.CatHealthColumns'
        style: form
      - in: query
        name: s
        description: 'List of columns that determine how the table should be sorted.

          Sorting defaults to ascending and can be changed by setting `:asc`

          or `:desc` as a suffix to the column name.'
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Names'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/cat.health.HealthRecord'
              examples:
                CatHealthResponseExample1:
                  description: 'A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps.

                    '
                  value: "[\n  {\n    \"epoch\": \"1475871424\",\n    \"timestamp\": \"16:17:04\",\n    \"cluster\": \"elasticsearch\",\n    \"status\": \"green\",\n    \"node.total\": \"1\",\n    \"node.data\": \"1\",\n    \"shards\": \"1\",\n    \"pri\": \"1\",\n    \"relo\": \"0\",\n    \"init\": \"0\",\n    \"unassign\": \"0\",\n    \"unassign.pri\": \"0\",\n    \"pending_tasks\": \"0\",\n    \"max_task_wait_time\": \"-\",\n    \"active_shards_percent\": \"100.0%\"\n  }\n]"
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat:
    get:
      tags:
      - cat
      summary: Get CAT help
      description: Get help for the CAT APIs.
      operationId: cat-help
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/indices:
    get:
      tags:
      - cat
      summary: Get index information
      description: 'Get high-level information about indices in a cluster, including backing indices for data streams.


        Use this request to get the following information for each index in a cluster:

        - shard count

        - document count

        - deleted document count

        - primary store size

        - total store size of all shards, including shard replicas


        These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.

        To get an accurate count of Elasticsearch documents, use the cat count or count APIs.


        NOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.


        IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to [Elasticsearch billing dimensions](https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions).


        CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use an index endpoint.


        ## Required authorization


        * Index privileges: `monitor`

        * Cluster privileges: `monitor`

        '
      operationId: cat-indices
      parameters:
      - $ref: '#/components/parameters/cat.indices-expand_wildcards'
      - $ref: '#/components/parameters/cat.indices-health'
      - $ref: '#/components/parameters/cat.indices-include_unloaded_segments'
      - $ref: '#/components/parameters/cat.indices-pri'
      - $ref: '#/components/parameters/cat.indices-master_timeout'
      - $ref: '#/components/parameters/cat.indices-h'
      - $ref: '#/components/parameters/cat.indices-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.indices-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/indices/{index}:
    get:
      tags:
      - cat
      summary: Get index information
      description: 'Get high-level information about indices in a cluster, including backing indices for data streams.


        Use this request to get the following information for each index in a cluster:

        - shard count

        - document count

        - deleted document count

        - primary store size

        - total store size of all shards, including shard replicas


        These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.

        To get an accurate count of Elasticsearch documents, use the cat count or count APIs.


        NOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.


        IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to [Elasticsearch billing dimensions](https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions).


        CAT APIs are only intended for human consumption using the command line or Kibana console.

        They are not intended for use by applications. For application consumption, use an index endpoint.


        ## Required authorization


        * Index privileges: `monitor`

        * Cluster privileges: `monitor`

        '
      operationId: cat-indices-1
      parameters:
      - $ref: '#/components/parameters/cat.indices-index'
      - $ref: '#/components/parameters/cat.indices-expand_wildcards'
      - $ref: '#/components/parameters/cat.indices-health'
      - $ref: '#/components/parameters/cat.indices-include_unloaded_segments'
      - $ref: '#/components/parameters/cat.indices-pri'
      - $ref: '#/components/parameters/cat.indices-master_timeout'
      - $ref: '#/components/parameters/cat.indices-h'
      - $ref: '#/components/parameters/cat.indices-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.indices-200'
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/master:
    get:
      tags:
      - cat
      summary: Get master node information
      description: 'Get information about the master node, including the ID, bound IP address, and name.


        IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      operationId: cat-master
      parameters:
      - in: query
        name: h
        description: A comma-separated list of columns names to display. It supports simple wildcards.
        deprecated: false
        schema:
          $ref: '#/components/schemas/cat._types.CatMasterColumns'
        style: form
      - in: query
        name: s
        description: 'List of columns that determine how the table should be sorted.

          Sorting defaults to ascending and can be changed by setting `:asc`

          or `:desc` as a suffix to the column name.'
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Names'
        style: form
      - in: query
        name: local
        description: 'If `true`, the request computes the list of selected nodes from the

          local cluster state. If `false` the list of selected nodes are computed

          from the cluster state of the master node. In both cases the coordinating

          node will send requests for further information to each selected node.'
        deprecated: false
        schema:
          default: false
          type: boolean
        style: form
      - in: query
        name: master_timeout
        description: Period to wait for a connection to the master node.
        deprecated: false
        schema:
          default: 30s
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/cat.master.MasterRecord'
              examples:
                CatMasterResponseExample1:
                  description: 'A successful response from `GET /_cat/master?v=true&format=json`.

                    '
                  value: "[\n  {\n    \"id\": \"YzWoH_2BT-6UjVGDyPdqYg\",\n    \"host\": \"127.0.0.1\",\n    \"ip\": \"127.0.0.1\",\n    \"node\": \"YzWoH_2\"\n  }\n]"
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/ml/data_frame/analytics:
    get:
      tags:
      - cat
      summary: Get data frame analytics jobs
      description: 'Get configuration and usage information about data frame analytics jobs.


        IMPORTANT: CAT APIs are only intended for human consumption using the Kibana

        console or command line. They are not intended for use by applications. For

        application consumption, use the get data frame analytics jobs statistics API.


        ## Required authorization


        * Cluster privileges: `monitor_ml`

        '
      operationId: cat-ml-data-frame-analytics
      parameters:
      - $ref: '#/components/parameters/cat.ml_data_frame_analytics-allow_no_match'
      - $ref: '#/components/parameters/cat.ml_data_frame_analytics-h'
      - $ref: '#/components/parameters/cat.ml_data_frame_analytics-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.ml_data_frame_analytics-200'
      x-state: Generally available; Added in 7.7.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/ml/data_frame/analytics/{id}:
    get:
      tags:
      - cat
      summary: Get data frame analytics jobs
      description: 'Get configuration and usage information about data frame analytics jobs.


        IMPORTANT: CAT APIs are only intended for human consumption using the Kibana

        console or command line. They are not intended for use by applications. For

        application consumption, use the get data frame analytics jobs statistics API.


        ## Required authorization


        * Cluster privileges: `monitor_ml`

        '
      operationId: cat-ml-data-frame-analytics-1
      parameters:
      - $ref: '#/components/parameters/cat.ml_data_frame_analytics-id'
      - $ref: '#/components/parameters/cat.ml_data_frame_analytics-allow_no_match'
      - $ref: '#/components/parameters/cat.ml_data_frame_analytics-h'
      - $ref: '#/components/parameters/cat.ml_data_frame_analytics-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.ml_data_frame_analytics-200'
      x-state: Generally available; Added in 7.7.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/ml/datafeeds:
    get:
      tags:
      - cat
      summary: Get datafeeds
      description: 'Get configuration and usage information about datafeeds.

        This API returns a maximum of 10,000 datafeeds.

        If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`

        cluster privileges to use this API.


        IMPORTANT: CAT APIs are only intended for human consumption using the Kibana

        console or command line. They are not intended for use by applications. For

        application consumption, use the get datafeed statistics API.


        ## Required authorization


        * Cluster privileges: `monitor_ml`

        '
      operationId: cat-ml-datafeeds
      parameters:
      - $ref: '#/components/parameters/cat.ml_datafeeds-allow_no_match'
      - $ref: '#/components/parameters/cat.ml_datafeeds-h'
      - $ref: '#/components/parameters/cat.ml_datafeeds-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.ml_datafeeds-200'
      x-state: Generally available; Added in 7.7.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/ml/datafeeds/{datafeed_id}:
    get:
      tags:
      - cat
      summary: Get datafeeds
      description: 'Get configuration and usage information about datafeeds.

        This API returns a maximum of 10,000 datafeeds.

        If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`

        cluster privileges to use this API.


        IMPORTANT: CAT APIs are only intended for human consumption using the Kibana

        console or command line. They are not intended for use by applications. For

        application consumption, use the get datafeed statistics API.


        ## Required authorization


        * Cluster privileges: `monitor_ml`

        '
      operationId: cat-ml-datafeeds-1
      parameters:
      - $ref: '#/components/parameters/cat.ml_datafeeds-datafeed_id'
      - $ref: '#/components/parameters/cat.ml_datafeeds-allow_no_match'
      - $ref: '#/components/parameters/cat.ml_datafeeds-h'
      - $ref: '#/components/parameters/cat.ml_datafeeds-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.ml_datafeeds-200'
      x-state: Generally available; Added in 7.7.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/ml/anomaly_detectors:
    get:
      tags:
      - cat
      summary: Get anomaly detection jobs
      description: 'Get configuration and usage information for anomaly detection jobs.

        This API returns a maximum of 10,000 jobs.

        If the Elasticsearch security features are enabled, you must have `monitor_ml`,

        `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.


        IMPORTANT: CAT APIs are only intended for human consumption using the Kibana

        console or command line. They are not intended for use by applications. For

        application consumption, use the get anomaly detection job statistics API.


        ## Required authorization


        * Cluster privileges: `monitor_ml`

        '
      operationId: cat-ml-jobs
      parameters:
      - $ref: '#/components/parameters/cat.ml_jobs-allow_no_match'
      - $ref: '#/components/parameters/cat.ml_jobs-h'
      - $ref: '#/components/parameters/cat.ml_jobs-s'
      responses:
        '200':
          $ref: '#/components/responses/cat.ml_jobs-200'
      x-state: Generally available; Added in 7.7.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_cat/ml/anomaly_detectors/{job_id}:
    get:
      tags:
      - cat
      summary: Get anomaly detection jobs
      description: 'Get configu

# --- truncated at 32 KB (258 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-cat-api-openapi.yml