openapi: 3.2.0 info: title: Elasticsearch Cat API description: 'Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features. ## Documentation source and versions This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International. This documentation contains work-in-progress information for future Elastic Stack releases.' license: name: Apache 2.0 url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE version: '' security: - apiKeyAuth: [] - basicAuth: [] - bearerAuth: [] tags: - name: Cat description: 'The compact and aligned text (CAT) APIs aim are intended only for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, it''s recommend to use a corresponding JSON API. All the cat commands accept a query string parameter `help` to see all the headers and info they provide, and the `/_cat` command alone lists all the available commands.' x-displayName: Compact and aligned text (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.' operationId: cat-aliases parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `alias` (or `a`): The name of the alias.\n - `index` (or `i`, `idx`): The name of the index the alias points to.\n - `filter` (or `f`, `fi`): The filter applied to the alias.\n - `routing.index` (or `ri`, `routingIndex`): Index routing value for the alias.\n - `routing.search` (or `rs`, `routingSearch`): Search routing value for the alias.\n - `is_write_index` (or `w`, `isWriteIndex`): Indicates if the index is the write index for the alias.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatAliasesColumns' 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: expand_wildcards description: "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n" deprecated: false schema: $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: master_timeout description: 'The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to `-1`.' deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.aliases.AliasesRecord' examples: CatAliasesResponseExample1: description: 'A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations. ' value: "[\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"*\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias3\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"1\",\n \"routing.search\": \"1\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias4\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"2\",\n \"routing.search\": \"1,2\",\n \"is_write_index\": \"true\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/aliases\n
\n " x-req-auth: - 'Index privileges: `view_index_metadata` ' x-api: aliases.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/aliases?format=json&v=true ' - lang: Python source: "resp = client.cat.aliases(\n format=\"json\",\n v=True,\n)" - lang: JavaScript source: "const response = await client.cat.aliases({\n format: \"json\",\n v: \"true\",\n});" - lang: Ruby source: "response = client.cat.aliases(\n format: \"json\",\n v: \"true\"\n)" - lang: PHP source: "$resp = $client->cat()->aliases([\n \"format\" => \"json\",\n \"v\" => \"true\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/aliases?format=json&v=true"' - lang: Java source: 'client.cat().aliases(); ' 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.' operationId: cat-aliases-1 parameters: - in: path name: name description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `alias` (or `a`): The name of the alias.\n - `index` (or `i`, `idx`): The name of the index the alias points to.\n - `filter` (or `f`, `fi`): The filter applied to the alias.\n - `routing.index` (or `ri`, `routingIndex`): Index routing value for the alias.\n - `routing.search` (or `rs`, `routingSearch`): Search routing value for the alias.\n - `is_write_index` (or `w`, `isWriteIndex`): Indicates if the index is the write index for the alias.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatAliasesColumns' 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: expand_wildcards description: "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n" deprecated: false schema: $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: master_timeout description: 'The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to `-1`.' deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.aliases.AliasesRecord' examples: CatAliasesResponseExample1: description: 'A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations. ' value: "[\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"*\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias3\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"1\",\n \"routing.search\": \"1\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias4\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"2\",\n \"routing.search\": \"1,2\",\n \"is_write_index\": \"true\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/aliases/{name}\n
\n " x-req-auth: - 'Index privileges: `view_index_metadata` ' x-api: aliases.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/aliases?format=json&v=true ' - lang: Python source: "resp = client.cat.aliases(\n format=\"json\",\n v=True,\n)" - lang: JavaScript source: "const response = await client.cat.aliases({\n format: \"json\",\n v: \"true\",\n});" - lang: Ruby source: "response = client.cat.aliases(\n format: \"json\",\n v: \"true\"\n)" - lang: PHP source: "$resp = $client->cat()->aliases([\n \"format\" => \"json\",\n \"v\" => \"true\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/aliases?format=json&v=true"' - lang: Java source: 'client.cat().aliases(); ' 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.' operationId: cat-allocation parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `shards` (or `s`): The number of shards on the node.\n - `shards.undesired`: The number of shards scheduled to be moved elsewhere in the cluster.\n - `write_load.forecast` (or `wlf`, `writeLoadForecast`): The sum of index write load forecasts.\n - `disk.indices.forecast` (or `dif`, `diskIndicesForecast`): The sum of shard size forecasts.\n - `disk.indices` (or `di`, `diskIndices`): The disk space used by Elasticsearch indices.\n - `disk.used` (or `du`, `diskUsed`): The total disk space used on the node.\n - `disk.avail` (or `da`, `diskAvail`): The available disk space on the node.\n - `disk.total` (or `dt`, `diskTotal`): The total disk capacity of all volumes on the node.\n - `disk.percent` (or `dp`, `diskPercent`): The percentage of disk space used on the node.\n - `host` (or `h`): IThe host of the node.\n - `ip`: The IP address of the node.\n - `node` (or `n`): The name of the node.\n - `node.role` (or `r`, `role`, `nodeRole`): The roles assigned to the node.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatAllocationColumns' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.allocation.AllocationRecord' examples: CatAllocationResponseExample1: description: 'A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available. ' value: "[\n {\n \"shards\": \"1\",\n \"shards.undesired\": \"0\",\n \"write_load.forecast\": \"0.0\",\n \"disk.indices.forecast\": \"260b\",\n \"disk.indices\": \"260b\",\n \"disk.used\": \"47.3gb\",\n \"disk.avail\": \"43.4gb\",\n \"disk.total\": \"100.7gb\",\n \"disk.percent\": \"46\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"CSUXak2\",\n \"node.role\": \"himrst\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/allocation\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: allocation.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/allocation?v=true&format=json ' - lang: Python source: "resp = client.cat.allocation(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.allocation({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.allocation(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->allocation([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/allocation?v=true&format=json"' - lang: Java source: 'client.cat().allocation(); ' 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.' operationId: cat-allocation-1 parameters: - in: path name: node_id description: A comma-separated list of node identifiers or names used to limit the returned information. required: true deprecated: false schema: $ref: '#/components/schemas/_types.NodeIds' style: simple - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `shards` (or `s`): The number of shards on the node.\n - `shards.undesired`: The number of shards scheduled to be moved elsewhere in the cluster.\n - `write_load.forecast` (or `wlf`, `writeLoadForecast`): The sum of index write load forecasts.\n - `disk.indices.forecast` (or `dif`, `diskIndicesForecast`): The sum of shard size forecasts.\n - `disk.indices` (or `di`, `diskIndices`): The disk space used by Elasticsearch indices.\n - `disk.used` (or `du`, `diskUsed`): The total disk space used on the node.\n - `disk.avail` (or `da`, `diskAvail`): The available disk space on the node.\n - `disk.total` (or `dt`, `diskTotal`): The total disk capacity of all volumes on the node.\n - `disk.percent` (or `dp`, `diskPercent`): The percentage of disk space used on the node.\n - `host` (or `h`): IThe host of the node.\n - `ip`: The IP address of the node.\n - `node` (or `n`): The name of the node.\n - `node.role` (or `r`, `role`, `nodeRole`): The roles assigned to the node.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatAllocationColumns' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.allocation.AllocationRecord' examples: CatAllocationResponseExample1: description: 'A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available. ' value: "[\n {\n \"shards\": \"1\",\n \"shards.undesired\": \"0\",\n \"write_load.forecast\": \"0.0\",\n \"disk.indices.forecast\": \"260b\",\n \"disk.indices\": \"260b\",\n \"disk.used\": \"47.3gb\",\n \"disk.avail\": \"43.4gb\",\n \"disk.total\": \"100.7gb\",\n \"disk.percent\": \"46\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"CSUXak2\",\n \"node.role\": \"himrst\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/allocation/{node_id}\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: allocation.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/allocation?v=true&format=json ' - lang: Python source: "resp = client.cat.allocation(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.allocation({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.allocation(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->allocation([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/allocation?v=true&format=json"' - lang: Java source: 'client.cat().allocation(); ' 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.' operationId: cat-circuit-breaker parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `node_id` (or `id`): Persistent node ID\n - `node_name` (or `nn`): Node name\n - `breaker` (or `br`): Breaker name\n - `limit` (or `l`): Limit size\n - `limit_bytes` (or `lb`): Limit size in bytes\n - `estimated` (or `e`): Estimated size\n - `estimated_bytes` (or `eb`): Estimated size in bytes\n - `tripped` (or `t`): Tripped count\n - `overhead` (or `o`): Overhead\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatCircuitBreakerColumns' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.circuit_breaker.CircuitBreakerRecord' examples: CatCircuitBreakerResponseExample1: description: 'A successful response from `GET /_cat/circuit_breaker?v=true&format=json`. It shows two circuit breakers are active on one node. ' value: "[\n {\n \"breaker\": \"request\",\n \"estimated\": \"0b\",\n \"limit\": \"614.3mb\",\n \"node_id\": \"ozKxpP9oS3SL0Sp-Mfxc6w\",\n \"tripped\": \"0\"\n },\n {\n \"breaker\": \"fielddata\",\n \"estimated\": \"0b\",\n \"limit\": \"409.5mb\",\n \"node_id\": \"ozKxpP9oS3SL0Sp-Mfxc6w\",\n \"tripped\": \"0\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/circuit_breaker\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: circuit_breaker.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/circuit_breaker?v=true&format=json ' - lang: Python source: "resp = client.cat.circuit_breaker(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.circuitBreaker({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.circuit_breaker(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->circuitBreaker([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/circuit_breaker?v=true&format=json"' 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.' operationId: cat-circuit-breaker-1 parameters: - in: path name: circuit_breaker_patterns description: A comma-separated list of regular-expressions to filter the circuit breakers in the output required: true deprecated: false schema: oneOf: - type: string - type: array items: type: string style: simple - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `node_id` (or `id`): Persistent node ID\n - `node_name` (or `nn`): Node name\n - `breaker` (or `br`): Breaker name\n - `limit` (or `l`): Limit size\n - `limit_bytes` (or `lb`): Limit size in bytes\n - `estimated` (or `e`): Estimated size\n - `estimated_bytes` (or `eb`): Estimated size in bytes\n - `tripped` (or `t`): Tripped count\n - `overhead` (or `o`): Overhead\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatCircuitBreakerColumns' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.circuit_breaker.CircuitBreakerRecord' examples: CatCircuitBreakerResponseExample1: description: 'A successful response from `GET /_cat/circuit_breaker?v=true&format=json`. It shows two circuit breakers are active on one node. ' value: "[\n {\n \"breaker\": \"request\",\n \"estimated\": \"0b\",\n \"limit\": \"614.3mb\",\n \"node_id\": \"ozKxpP9oS3SL0Sp-Mfxc6w\",\n \"tripped\": \"0\"\n },\n {\n \"breaker\": \"fielddata\",\n \"estimated\": \"0b\",\n \"limit\": \"409.5mb\",\n \"node_id\": \"ozKxpP9oS3SL0Sp-Mfxc6w\",\n \"tripped\": \"0\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/circuit_breaker/{circuit_breaker_patterns}\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: circuit_breaker.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/circuit_breaker?v=true&format=json ' - lang: Python source: "resp = client.cat.circuit_breaker(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.circuitBreaker({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.circuit_breaker(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->circuitBreaker([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/circuit_breaker?v=true&format=json"' 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.' operationId: cat-component-templates parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `name` (or `n`): The name of the component template.\n - `version` (or `v`): The version number of the component template.\n - `alias_count` (or `a`): The number of aliases in the component template.\n - `mapping_count` (or `m`): The number of mappings in the component template.\n - `settings_count` (or `s`): The number of settings in the component template.\n - `metadata_count` (or `me`): The number of metadata entries in the component template.\n - `included_in` (or `i`): The index templates that include this component template.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatComponentColumns' 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: type: boolean style: form - in: query name: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.component_templates.ComponentTemplate' examples: CatComponentTemplatesResponseExample1: description: 'A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`. ' value: "[\n {\n \"name\": \"my-template-1\",\n \"version\": \"null\",\n \"alias_count\": \"0\",\n \"mapping_count\": \"0\",\n \"settings_count\": \"1\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n },\n {\n \"name\": \"my-template-2\",\n \"version\": null,\n \"alias_count\": \"0\",\n \"mapping_count\": \"3\",\n \"settings_count\": \"0\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n }\n]" x-state: Generally available; Added in 5.1.0 x-variations: - "
\n GET\n /_cat/component_templates\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: component_templates.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/component_templates/my-template-*?v=true&s=name&format=json ' - lang: Python source: "resp = client.cat.component_templates(\n name=\"my-template-*\",\n v=True,\n s=\"name\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.componentTemplates({\n name: \"my-template-*\",\n v: \"true\",\n s: \"name\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.component_templates(\n name: \"my-template-*\",\n v: \"true\",\n s: \"name\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->componentTemplates([\n \"name\" => \"my-template-*\",\n \"v\" => \"true\",\n \"s\" => \"name\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/component_templates/my-template-*?v=true&s=name&format=json"' - lang: Java source: 'client.cat().componentTemplates(); ' 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.' operationId: cat-component-templates-1 parameters: - in: path name: name description: 'The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.' required: true deprecated: false schema: type: string style: simple - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `name` (or `n`): The name of the component template.\n - `version` (or `v`): The version number of the component template.\n - `alias_count` (or `a`): The number of aliases in the component template.\n - `mapping_count` (or `m`): The number of mappings in the component template.\n - `settings_count` (or `s`): The number of settings in the component template.\n - `metadata_count` (or `me`): The number of metadata entries in the component template.\n - `included_in` (or `i`): The index templates that include this component template.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatComponentColumns' 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: type: boolean style: form - in: query name: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.component_templates.ComponentTemplate' examples: CatComponentTemplatesResponseExample1: description: 'A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`. ' value: "[\n {\n \"name\": \"my-template-1\",\n \"version\": \"null\",\n \"alias_count\": \"0\",\n \"mapping_count\": \"0\",\n \"settings_count\": \"1\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n },\n {\n \"name\": \"my-template-2\",\n \"version\": null,\n \"alias_count\": \"0\",\n \"mapping_count\": \"3\",\n \"settings_count\": \"0\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n }\n]" x-state: Generally available; Added in 5.1.0 x-variations: - "
\n GET\n /_cat/component_templates/{name}\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: component_templates.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/component_templates/my-template-*?v=true&s=name&format=json ' - lang: Python source: "resp = client.cat.component_templates(\n name=\"my-template-*\",\n v=True,\n s=\"name\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.componentTemplates({\n name: \"my-template-*\",\n v: \"true\",\n s: \"name\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.component_templates(\n name: \"my-template-*\",\n v: \"true\",\n s: \"name\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->componentTemplates([\n \"name\" => \"my-template-*\",\n \"v\" => \"true\",\n \"s\" => \"name\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/component_templates/my-template-*?v=true&s=name&format=json"' - lang: Java source: 'client.cat().componentTemplates(); ' 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.' operationId: cat-count parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `epoch` (or `t`, `time`): The Unix epoch time in seconds since 1970-01-01 00:00:00.\n - `timestamp` (or `ts`, `hms`, `hhmmss`): The current time in HH:MM:SS format.\n - `count` (or `dc`, `docs.count`, `docsCount`): The document count in the cluster or index.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatCountColumns' 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 requestBody: content: application/json: schema: type: object responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.count.CountRecord' examples: CatCountResponseExample1: summary: Single data stream or index count description: 'A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index. ' value: "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]" CatCountResponseExample2: summary: All data streams and indices count description: 'A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster. ' value: "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/count\n
\n " - "
\n POST\n /_cat/count\n
\n " x-req-auth: - 'Index privileges: `read` ' x-api: count.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/count/my-index-000001?v=true&format=json ' - lang: Python source: "resp = client.cat.count(\n index=\"my-index-000001\",\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.count({\n index: \"my-index-000001\",\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.count(\n index: \"my-index-000001\",\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->count([\n \"index\" => \"my-index-000001\",\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/count/my-index-000001?v=true&format=json"' - lang: Java source: 'client.cat().count(); ' 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.' operationId: cat-count-1 parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `epoch` (or `t`, `time`): The Unix epoch time in seconds since 1970-01-01 00:00:00.\n - `timestamp` (or `ts`, `hms`, `hhmmss`): The current time in HH:MM:SS format.\n - `count` (or `dc`, `docs.count`, `docsCount`): The document count in the cluster or index.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatCountColumns' 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 requestBody: content: application/json: schema: type: object responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.count.CountRecord' examples: CatCountResponseExample1: summary: Single data stream or index count description: 'A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index. ' value: "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]" CatCountResponseExample2: summary: All data streams and indices count description: 'A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster. ' value: "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/count\n
\n " - "
\n POST\n /_cat/count\n
\n " x-req-auth: - 'Index privileges: `read` ' x-api: count.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/count/my-index-000001?v=true&format=json ' - lang: Python source: "resp = client.cat.count(\n index=\"my-index-000001\",\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.count({\n index: \"my-index-000001\",\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.count(\n index: \"my-index-000001\",\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->count([\n \"index\" => \"my-index-000001\",\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/count/my-index-000001?v=true&format=json"' - lang: Java source: 'client.cat().count(); ' 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.' operationId: cat-count-2 parameters: - in: path name: index description: 'A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `epoch` (or `t`, `time`): The Unix epoch time in seconds since 1970-01-01 00:00:00.\n - `timestamp` (or `ts`, `hms`, `hhmmss`): The current time in HH:MM:SS format.\n - `count` (or `dc`, `docs.count`, `docsCount`): The document count in the cluster or index.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatCountColumns' 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 requestBody: content: application/json: schema: type: object responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.count.CountRecord' examples: CatCountResponseExample1: summary: Single data stream or index count description: 'A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index. ' value: "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]" CatCountResponseExample2: summary: All data streams and indices count description: 'A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster. ' value: "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/count/{index}\n
\n " - "
\n POST\n /_cat/count/{index}\n
\n " x-req-auth: - 'Index privileges: `read` ' x-api: count.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/count/my-index-000001?v=true&format=json ' - lang: Python source: "resp = client.cat.count(\n index=\"my-index-000001\",\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.count({\n index: \"my-index-000001\",\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.count(\n index: \"my-index-000001\",\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->count([\n \"index\" => \"my-index-000001\",\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/count/my-index-000001?v=true&format=json"' - lang: Java source: 'client.cat().count(); ' 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.' operationId: cat-count-3 parameters: - in: path name: index description: 'A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `epoch` (or `t`, `time`): The Unix epoch time in seconds since 1970-01-01 00:00:00.\n - `timestamp` (or `ts`, `hms`, `hhmmss`): The current time in HH:MM:SS format.\n - `count` (or `dc`, `docs.count`, `docsCount`): The document count in the cluster or index.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatCountColumns' 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 requestBody: content: application/json: schema: type: object responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.count.CountRecord' examples: CatCountResponseExample1: summary: Single data stream or index count description: 'A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index. ' value: "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]" CatCountResponseExample2: summary: All data streams and indices count description: 'A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster. ' value: "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/count/{index}\n
\n " - "
\n POST\n /_cat/count/{index}\n
\n " x-req-auth: - 'Index privileges: `read` ' x-api: count.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/count/my-index-000001?v=true&format=json ' - lang: Python source: "resp = client.cat.count(\n index=\"my-index-000001\",\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.count({\n index: \"my-index-000001\",\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.count(\n index: \"my-index-000001\",\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->count([\n \"index\" => \"my-index-000001\",\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/count/my-index-000001?v=true&format=json"' - lang: Java source: 'client.cat().count(); ' 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.' operationId: cat-fielddata parameters: - in: query name: fields description: Comma-separated list of fields used to limit returned information. deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: form - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `id`: The node ID.\n - `host` (or `h`): The host name of the node.\n - `ip`: The IP address of the node.\n - `node` (or `n`): The node name.\n - `field` (or `f`): The field name.\n - `size` (or `s`): The field data usage.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatFieldDataColumns' 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.fielddata.FielddataRecord' examples: CatFielddataResponseExample1: summary: Single field data description: 'A successful response from `GET /_cat/fielddata?v=true&fields=body&format=json`. You can specify an individual field in the request body or URL path. This example retrieves heap memory size information for the `body` field. ' value: "[\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"body\",\n \"size\": \"544b\"\n }\n]" CatFielddataResponseExample2: summary: Multiple fields data description: 'A successful response from `GET /_cat/fielddata/body,soul?v=true&format=json`. You can specify a comma-separated list of fields in the request body or URL path. This example retrieves heap memory size information for the `body` and `soul` fields. To get information for all fields, run `GET /_cat/fielddata?v=true`. ' value: "[\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"1127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"body\",\n \"size\": \"544b\"\n },\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"soul\",\n \"size\": \"480b\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/fielddata\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: fielddata.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/fielddata?v=true&fields=body&format=json ' - lang: Python source: "resp = client.cat.fielddata(\n v=True,\n fields=\"body\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.fielddata({\n v: \"true\",\n fields: \"body\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.fielddata(\n v: \"true\",\n fields: \"body\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->fielddata([\n \"v\" => \"true\",\n \"fields\" => \"body\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/fielddata?v=true&fields=body&format=json"' - lang: Java source: 'client.cat().fielddata(); ' 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.' operationId: cat-fielddata-1 parameters: - in: path name: fields description: 'Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: simple - in: query name: fields description: Comma-separated list of fields used to limit returned information. deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: form - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `id`: The node ID.\n - `host` (or `h`): The host name of the node.\n - `ip`: The IP address of the node.\n - `node` (or `n`): The node name.\n - `field` (or `f`): The field name.\n - `size` (or `s`): The field data usage.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatFieldDataColumns' 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.fielddata.FielddataRecord' examples: CatFielddataResponseExample1: summary: Single field data description: 'A successful response from `GET /_cat/fielddata?v=true&fields=body&format=json`. You can specify an individual field in the request body or URL path. This example retrieves heap memory size information for the `body` field. ' value: "[\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"body\",\n \"size\": \"544b\"\n }\n]" CatFielddataResponseExample2: summary: Multiple fields data description: 'A successful response from `GET /_cat/fielddata/body,soul?v=true&format=json`. You can specify a comma-separated list of fields in the request body or URL path. This example retrieves heap memory size information for the `body` and `soul` fields. To get information for all fields, run `GET /_cat/fielddata?v=true`. ' value: "[\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"1127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"body\",\n \"size\": \"544b\"\n },\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"soul\",\n \"size\": \"480b\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/fielddata/{fields}\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: fielddata.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/fielddata?v=true&fields=body&format=json ' - lang: Python source: "resp = client.cat.fielddata(\n v=True,\n fields=\"body\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.fielddata({\n v: \"true\",\n fields: \"body\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.fielddata(\n v: \"true\",\n fields: \"body\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->fielddata([\n \"v\" => \"true\",\n \"fields\" => \"body\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/fielddata?v=true&fields=body&format=json"' - lang: Java source: 'client.cat().fielddata(); ' 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.' operationId: cat-health parameters: - in: query name: ts description: If true, returns `HH:MM:SS` and Unix epoch timestamps. deprecated: false schema: type: boolean style: form - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `epoch` (or `t`, `time`): The number of seconds since 1970-01-01 00:00:00.\n - `timestamp` (or `ts`, `hms`, `hhmmss`): The time in HH:MM:SS format.\n - `cluster` (or `cl`): The cluster name.\n - `status` (or `st`): The health status.\n - `node.total` (or `nt`, `nodeTotal`): The total number of nodes that can store data.\n - `node.data` (or `nd`, `nodeData`): The number of nodes that can store data.\n - `shards` (or `t`, `sh`, `shards.total`, `shardsTotal`): The total number of shards.\n - `pri` (or `p`, `shards.primary`, `shardsPrimary`): The number of primary shards.\n - `relo` (or `r`, `shards.relocating`, `shardsRelocating`): The number of relocating nodes.\n - `init` (or `i`, `shards.initializing`, `shardsInitializing`): The number of initializing nodes.\n - `unassign` (or `u`, `shards.unassigned`, `shardsUnassigned`): The number of unassigned shards.\n - `unassign.pri` (or `up`, `shards.unassigned.primary`, `shardsUnassignedPrimary`): The number of unassigned primary shards.\n - `pending_tasks` (or `pt`, `pendingTasks`): The number of pending tasks.\n - `max_task_wait_time` (or `mtwt`, `maxTaskWaitTime`): The wait time of the longest pending task.\n - `active_shards_percent` (or `asp`, `activeShardsPercent`): The percentage of active shards.\n\n" 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-variations: - "
\n GET\n /_cat/health\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: health.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/health?v=true&format=json ' - lang: Python source: "resp = client.cat.health(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.health({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.health(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->health([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/health?v=true&format=json"' - lang: Java source: 'client.cat().health(); ' 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-variations: - "
\n GET\n /_cat\n
\n " x-api: help.cat x-category: info 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. 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.' operationId: cat-indices parameters: - in: query name: expand_wildcards description: "The type of index that wildcard patterns can match.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n" deprecated: false schema: $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: health description: "The health status used to limit returned indices. By default, the response includes indices of any health status.\n\nSupported values include:\n - `green` (or `GREEN`): All shards are assigned.\n - `yellow` (or `YELLOW`): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.\n - `red` (or `RED`): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.\n - `unknown`\n - `unavailable`\n\n" deprecated: false schema: $ref: '#/components/schemas/_types.HealthStatus' style: form - in: query name: include_unloaded_segments description: If true, the response includes information from segments that are not loaded into memory. deprecated: false schema: type: boolean style: form - in: query name: pri description: If true, the response only includes information from primary shards. deprecated: false schema: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `health` (or `h`): The current health status.\n - `status` (or `s`): The open/close status.\n - `index` (or `i`, `idx`): The index name.\n - `uuid` (or `id`, `uuid`): The index UUID.\n - `pri` (or `p`, `shards.primary`, `shardsPrimary`): The number of primary shards.\n - `rep` (or `r`, `shards.replica`, `shardsReplica`): The number of replica shards.\n - `docs.count` (or `dc`, `docsCount`): The number of available documents.\n - `docs.deleted` (or `dd`, `docsDeleted`): The number of deleted documents.\n - `creation.date` (or `cd`): The index creation date (millisecond value).\n - `creation.date.string` (or `cds`): The index creation date (as string).\n - `store.size` (or `ss`, `storeSize`): The store size of primaries and replicas.\n - `pri.store.size`: The store size of primaries.\n - `dataset.size`: The total size of the dataset.\n - `completion.size` (or `cs`, `completionSize`): The size of completion for primaries and replicas.\n - `pri.completion.size`: The size of completion for primaries.\n - `fielddata.memory_size` (or `fm`, `fielddataMemory`): The used fielddata cache for primaries and replicas.\n - `pri.fielddata.memory_size`: The used fielddata cache for primaries.\n - `fielddata.evictions` (or `fe`, `fielddataEvictions`): The number of fielddata evictions for primaries and replicas.\n - `pri.fielddata.evictions`: The number of fielddata evictions for primaries.\n - `query_cache.memory_size` (or `qcm`, `queryCacheMemory`): The used query cache for primaries and replicas.\n - `pri.query_cache.memory_size`: The used query cache for primaries.\n - `query_cache.evictions` (or `qce`, `queryCacheEvictions`): The number of query cache evictions for primaries and replicas.\n - `pri.query_cache.evictions`: The number of query cache evictions for primaries.\n - `request_cache.memory_size` (or `rcm`, `requestCacheMemory`): The used request cache for primaries and replicas.\n - `pri.request_cache.memory_size`: The used request cache for primaries.\n - `request_cache.evictions` (or `rce`, `requestCacheEvictions`): The number of request cache evictions for primaries and replicas.\n - `pri.request_cache.evictions`: The number of request cache evictions for primaries.\n - `request_cache.hit_count` (or `rchc`, `requestCacheHitCount`): The request cache hit count for primaries and replicas.\n - `pri.request_cache.hit_count`: The request cache hit count for primaries.\n - `request_cache.miss_count` (or `rcmc`, `requestCacheMissCount`): The request cache miss count for primaries and replicas.\n - `pri.request_cache.miss_count`: The request cache miss count for primaries.\n - `flush.total` (or `ft`, `flushTotal`): The number of flushes for primaries and replicas.\n - `pri.flush.total`: The number of flushes for primaries.\n - `flush.total_time` (or `ftt`, `flushTotalTime`): The time spent in flush for primaries and replicas.\n - `pri.flush.total_time`: The time spent in flush for primaries.\n - `get.current` (or `gc`, `getCurrent`): The number of current get operations for primaries and replicas.\n - `pri.get.current`: The number of current get operations for primaries.\n - `get.time` (or `gti`, `getTime`): The time spent in get for primaries and replicas.\n - `pri.get.time`: The time spent in get for primaries.\n - `get.total` (or `gto`, `getTotal`): The number of get operations for primaries and replicas.\n - `pri.get.total`: The number of get operations for primaries.\n - `get.exists_time` (or `geti`, `getExistsTime`): The time spent in successful gets for primaries and replicas.\n - `pri.get.exists_time`: The time spent in successful gets for primaries.\n - `get.exists_total` (or `geto`, `getExistsTotal`): The number of successful gets for primaries and replicas.\n - `pri.get.exists_total`: The number of successful gets for primaries.\n - `get.missing_time` (or `gmti`, `getMissingTime`): The time spent in failed gets for primaries and replicas.\n - `pri.get.missing_time`: The time spent in failed gets for primaries.\n - `get.missing_total` (or `gmto`, `getMissingTotal`): The number of failed gets for primaries and replicas.\n - `pri.get.missing_total`: The number of failed gets for primaries.\n - `indexing.delete_current` (or `idc`, `indexingDeleteCurrent`): The number of current deletions for primaries and replicas.\n - `pri.indexing.delete_current`: The number of current deletions for primaries.\n - `indexing.delete_time` (or `idti`, `indexingDeleteTime`): The time spent in deletions for primaries and replicas.\n - `pri.indexing.delete_time`: The time spent in deletions for primaries.\n - `indexing.delete_total` (or `idto`, `indexingDeleteTotal`): The number of delete operations for primaries and replicas.\n - `pri.indexing.delete_total`: The number of delete operations for primaries.\n - `indexing.index_current` (or `iic`, `indexingIndexCurrent`): The number of current indexing operations for primaries and replicas.\n - `pri.indexing.index_current`: The number of current indexing operations for primaries.\n - `indexing.index_time` (or `iiti`, `indexingIndexTime`): The time spent in indexing for primaries and replicas.\n - `pri.indexing.index_time`: The time spent in indexing for primaries.\n - `indexing.index_total` (or `iito`, `indexingIndexTotal`): The number of indexing operations for primaries and replicas.\n - `pri.indexing.index_total`: The number of indexing operations for primaries.\n - `indexing.index_failed` (or `iif`, `indexingIndexFailed`): The number of failed indexing operations for primaries and replicas.\n - `pri.indexing.index_failed`: The number of failed indexing operations for primaries.\n - `indexing.index_failed_due_to_version_conflict` (or `iifvc`, `indexingIndexFailedDueToVersionConflict`): The number of failed indexing operations due to version conflict for primaries and replicas.\n - `pri.indexing.index_failed_due_to_version_conflict`: The number of failed indexing operations due to version conflict for primaries.\n - `merges.current` (or `mc`, `mergesCurrent`): The number of current merges for primaries and replicas.\n - `pri.merges.current`: The number of current merges for primaries.\n - `merges.current_docs` (or `mcd`, `mergesCurrentDocs`): The number of current merging documents for primaries and replicas.\n - `pri.merges.current_docs`: The number of current merging documents for primaries.\n - `merges.current_size` (or `mcs`, `mergesCurrentSize`): The size of current merges for primaries and replicas.\n - `pri.merges.current_size`: The size of current merges for primaries.\n - `merges.total` (or `mt`, `mergesTotal`): The number of completed merge operations for primaries and replicas.\n - `pri.merges.total`: The number of completed merge operations for primaries.\n - `merges.total_docs` (or `mtd`, `mergesTotalDocs`): The number of merged documents for primaries and replicas.\n - `pri.merges.total_docs`: The number of merged documents for primaries.\n - `merges.total_size` (or `mts`, `mergesTotalSize`): The merged size for primaries and replicas.\n - `pri.merges.total_size`: The merged size for primaries.\n - `merges.total_time` (or `mtt`, `mergesTotalTime`): The time spent in merges for primaries and replicas.\n - `pri.merges.total_time`: The time spent in merges for primaries.\n - `refresh.total` (or `rto`, `refreshTotal`): The total refreshes for primaries and replicas.\n - `pri.refresh.total`: The total refreshes for primaries.\n - `refresh.time` (or `rti`, `refreshTime`): The time spent in refreshes for primaries and replicas.\n - `pri.refresh.time`: The time spent in refreshes for primaries.\n - `refresh.external_total` (or `rto`, `refreshTotal`): The total external refreshes for primaries and replicas.\n - `pri.refresh.external_total`: The total external refreshes for primaries.\n - `refresh.external_time` (or `rti`, `refreshTime`): The time spent in external refreshes for primaries and replicas.\n - `pri.refresh.external_time`: The time spent in external refreshes for primaries.\n - `refresh.listeners` (or `rli`, `refreshListeners`): The number of pending refresh listeners for primaries and replicas.\n - `pri.refresh.listeners`: The number of pending refresh listeners for primaries.\n - `search.fetch_current` (or `sfc`, `searchFetchCurrent`): The current fetch phase operations for primaries and replicas.\n - `pri.search.fetch_current`: The current fetch phase operations for primaries.\n - `search.fetch_time` (or `sfti`, `searchFetchTime`): The time spent in fetch phase for primaries and replicas.\n - `pri.search.fetch_time`: The time spent in fetch phase for primaries.\n - `search.fetch_total` (or `sfto`, `searchFetchTotal`): The total fetch operations for primaries and replicas.\n - `pri.search.fetch_total`: The total fetch operations for primaries.\n - `search.open_contexts` (or `so`, `searchOpenContexts`): The open search contexts for primaries and replicas.\n - `pri.search.open_contexts`: The open search contexts for primaries.\n - `search.query_current` (or `sqc`, `searchQueryCurrent`): The current query phase operations for primaries and replicas.\n - `pri.search.query_current`: The current query phase operations for primaries.\n - `search.query_time` (or `sqti`, `searchQueryTime`): The time spent in query phase for primaries and replicas.\n - `pri.search.query_time`: The time spent in query phase for primaries.\n - `search.query_total` (or `sqto`, `searchQueryTotal`): The total query phase operations for primaries and replicas.\n - `pri.search.query_total`: The total query phase operations for primaries.\n - `search.scroll_current` (or `scc`, `searchScrollCurrent`): The open scroll contexts for primaries and replicas.\n - `pri.search.scroll_current`: The open scroll contexts for primaries.\n - `search.scroll_time` (or `scti`, `searchScrollTime`): The time scroll contexts held open for primaries and replicas.\n - `pri.search.scroll_time`: The time scroll contexts held open for primaries.\n - `search.scroll_total` (or `scto`, `searchScrollTotal`): The completed scroll contexts for primaries and replicas.\n - `pri.search.scroll_total`: The completed scroll contexts for primaries.\n - `segments.count` (or `sc`, `segmentsCount`): The number of segments for primaries and replicas.\n - `pri.segments.count`: The number of segments for primaries.\n - `segments.memory` (or `sm`, `segmentsMemory`): The memory used by segments for primaries and replicas.\n - `pri.segments.memory`: The memory used by segments for primaries.\n - `segments.index_writer_memory` (or `siwm`, `segmentsIndexWriterMemory`): The memory used by index writer for primaries and replicas.\n - `pri.segments.index_writer_memory`: The memory used by index writer for primaries.\n - `segments.version_map_memory` (or `svmm`, `segmentsVersionMapMemory`): The memory used by version map for primaries and replicas.\n - `pri.segments.version_map_memory`: The memory used by version map for primaries.\n - `segments.fixed_bitset_memory` (or `sfbm`, `fixedBitsetMemory`): The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. Applicable for primaries and replicas.\n - `pri.segments.fixed_bitset_memory`: The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. Applicable for primaries.\n - `warmer.current` (or `wc`, `warmerCurrent`): The current warmer operations for primaries and replicas.\n - `pri.warmer.current`: The current warmer operations for primaries.\n - `warmer.total` (or `wto`, `warmerTotal`): The total warmer operations for primaries and replicas.\n - `pri.warmer.total`: The total warmer operations for primaries.\n - `warmer.total_time` (or `wtt`, `warmerTotalTime`): The time spent in warmers for primaries and replicas.\n - `pri.warmer.total_time`: The time spent in warmers for primaries.\n - `suggest.current` (or `suc`, `suggestCurrent`): The current suggest operations for primaries and replicas.\n - `pri.suggest.current`: The current suggest operations for primaries.\n - `suggest.time` (or `suti`, `suggestTime`): The time spent in suggest for primaries and replicas.\n - `pri.suggest.time`: The time spent in suggest for primaries.\n - `suggest.total` (or `suto`, `suggestTotal`): The number of suggest operations for primaries and replicas.\n - `pri.suggest.total`: The number of suggest operations for primaries.\n - `memory.total` (or `tm`, `memoryTotal`): The total used memory for primaries and replicas.\n - `pri.memory.total`: The total used memory for primaries.\n - `bulk.total_operations` (or `bto`, `bulkTotalOperation`): The number of bulk shard operations for primaries and replicas.\n - `pri.bulk.total_operations`: The number of bulk shard operations for primaries.\n - `bulk.total_time` (or `btti`, `bulkTotalTime`): The time spent in shard bulk for primaries and replicas.\n - `pri.bulk.total_time`: The time spent in shard bulk for primaries.\n - `bulk.total_size_in_bytes` (or `btsi`, `bulkTotalSizeInBytes`): The total size in bytes of shard bulk for primaries and replicas.\n - `pri.bulk.total_size_in_bytes`: The total size in bytes of shard bulk for primaries.\n - `bulk.avg_time` (or `bati`, `bulkAvgTime`): The average time spent in shard bulk for primaries and replicas.\n - `pri.bulk.avg_time`: The average time spent in shard bulk for primaries.\n - `bulk.avg_size_in_bytes` (or `basi`, `bulkAvgSizeInBytes`): The average size in bytes of shard bulk for primaries and replicas.\n - `pri.bulk.avg_size_in_bytes`: The average size in bytes of shard bulk for primaries.\n - `dense_vector.value_count` (or `dvc`, `denseVectorCount`): The total count of indexed dense vectors for primaries and replicas.\n - `pri.dense_vector.value_count`: The total count of indexed dense vectors for primaries.\n - `sparse_vector.value_count` (or `svc`, `sparseVectorCount`): The total count of indexed sparse vectors for primaries and replicas.\n - `pri.sparse_vector.value_count`: The total count of indexed sparse vectors for primaries.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatIndicesColumns' 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.indices.IndicesRecord' examples: CatIndicesResponseExample1: description: 'A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`. ' value: "[\n {\n \"health\": \"yellow\",\n \"status\": \"open\",\n \"index\": \"my-index-000001\",\n \"uuid\": \"u8FNjxh8Rfy_awN11oDKYQ\",\n \"pri\": \"1\",\n \"rep\": \"1\",\n \"docs.count\": \"1200\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"88.1kb\",\n \"pri.store.size\": \"88.1kb\",\n \"dataset.size\": \"88.1kb\"\n },\n {\n \"health\": \"green\",\n \"status\": \"open\",\n \"index\": \"my-index-000002\",\n \"uuid\": \"nYFWZEO7TUiOjLQXBaYJpA \",\n \"pri\": \"1\",\n \"rep\": \"0\",\n \"docs.count\": \"0\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"260b\",\n \"pri.store.size\": \"260b\",\n \"dataset.size\": \"260b\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/indices\n
\n " x-req-auth: - 'Index privileges: `monitor` ' - 'Cluster privileges: `monitor` ' x-api: indices.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/indices/my-index-*?v=true&s=index&format=json ' - lang: Python source: "resp = client.cat.indices(\n index=\"my-index-*\",\n v=True,\n s=\"index\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.indices({\n index: \"my-index-*\",\n v: \"true\",\n s: \"index\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.indices(\n index: \"my-index-*\",\n v: \"true\",\n s: \"index\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->indices([\n \"index\" => \"my-index-*\",\n \"v\" => \"true\",\n \"s\" => \"index\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/indices/my-index-*?v=true&s=index&format=json"' - lang: Java source: 'client.cat().indices(); ' 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. 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.' operationId: cat-indices-1 parameters: - in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: expand_wildcards description: "The type of index that wildcard patterns can match.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n" deprecated: false schema: $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: health description: "The health status used to limit returned indices. By default, the response includes indices of any health status.\n\nSupported values include:\n - `green` (or `GREEN`): All shards are assigned.\n - `yellow` (or `YELLOW`): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.\n - `red` (or `RED`): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.\n - `unknown`\n - `unavailable`\n\n" deprecated: false schema: $ref: '#/components/schemas/_types.HealthStatus' style: form - in: query name: include_unloaded_segments description: If true, the response includes information from segments that are not loaded into memory. deprecated: false schema: type: boolean style: form - in: query name: pri description: If true, the response only includes information from primary shards. deprecated: false schema: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `health` (or `h`): The current health status.\n - `status` (or `s`): The open/close status.\n - `index` (or `i`, `idx`): The index name.\n - `uuid` (or `id`, `uuid`): The index UUID.\n - `pri` (or `p`, `shards.primary`, `shardsPrimary`): The number of primary shards.\n - `rep` (or `r`, `shards.replica`, `shardsReplica`): The number of replica shards.\n - `docs.count` (or `dc`, `docsCount`): The number of available documents.\n - `docs.deleted` (or `dd`, `docsDeleted`): The number of deleted documents.\n - `creation.date` (or `cd`): The index creation date (millisecond value).\n - `creation.date.string` (or `cds`): The index creation date (as string).\n - `store.size` (or `ss`, `storeSize`): The store size of primaries and replicas.\n - `pri.store.size`: The store size of primaries.\n - `dataset.size`: The total size of the dataset.\n - `completion.size` (or `cs`, `completionSize`): The size of completion for primaries and replicas.\n - `pri.completion.size`: The size of completion for primaries.\n - `fielddata.memory_size` (or `fm`, `fielddataMemory`): The used fielddata cache for primaries and replicas.\n - `pri.fielddata.memory_size`: The used fielddata cache for primaries.\n - `fielddata.evictions` (or `fe`, `fielddataEvictions`): The number of fielddata evictions for primaries and replicas.\n - `pri.fielddata.evictions`: The number of fielddata evictions for primaries.\n - `query_cache.memory_size` (or `qcm`, `queryCacheMemory`): The used query cache for primaries and replicas.\n - `pri.query_cache.memory_size`: The used query cache for primaries.\n - `query_cache.evictions` (or `qce`, `queryCacheEvictions`): The number of query cache evictions for primaries and replicas.\n - `pri.query_cache.evictions`: The number of query cache evictions for primaries.\n - `request_cache.memory_size` (or `rcm`, `requestCacheMemory`): The used request cache for primaries and replicas.\n - `pri.request_cache.memory_size`: The used request cache for primaries.\n - `request_cache.evictions` (or `rce`, `requestCacheEvictions`): The number of request cache evictions for primaries and replicas.\n - `pri.request_cache.evictions`: The number of request cache evictions for primaries.\n - `request_cache.hit_count` (or `rchc`, `requestCacheHitCount`): The request cache hit count for primaries and replicas.\n - `pri.request_cache.hit_count`: The request cache hit count for primaries.\n - `request_cache.miss_count` (or `rcmc`, `requestCacheMissCount`): The request cache miss count for primaries and replicas.\n - `pri.request_cache.miss_count`: The request cache miss count for primaries.\n - `flush.total` (or `ft`, `flushTotal`): The number of flushes for primaries and replicas.\n - `pri.flush.total`: The number of flushes for primaries.\n - `flush.total_time` (or `ftt`, `flushTotalTime`): The time spent in flush for primaries and replicas.\n - `pri.flush.total_time`: The time spent in flush for primaries.\n - `get.current` (or `gc`, `getCurrent`): The number of current get operations for primaries and replicas.\n - `pri.get.current`: The number of current get operations for primaries.\n - `get.time` (or `gti`, `getTime`): The time spent in get for primaries and replicas.\n - `pri.get.time`: The time spent in get for primaries.\n - `get.total` (or `gto`, `getTotal`): The number of get operations for primaries and replicas.\n - `pri.get.total`: The number of get operations for primaries.\n - `get.exists_time` (or `geti`, `getExistsTime`): The time spent in successful gets for primaries and replicas.\n - `pri.get.exists_time`: The time spent in successful gets for primaries.\n - `get.exists_total` (or `geto`, `getExistsTotal`): The number of successful gets for primaries and replicas.\n - `pri.get.exists_total`: The number of successful gets for primaries.\n - `get.missing_time` (or `gmti`, `getMissingTime`): The time spent in failed gets for primaries and replicas.\n - `pri.get.missing_time`: The time spent in failed gets for primaries.\n - `get.missing_total` (or `gmto`, `getMissingTotal`): The number of failed gets for primaries and replicas.\n - `pri.get.missing_total`: The number of failed gets for primaries.\n - `indexing.delete_current` (or `idc`, `indexingDeleteCurrent`): The number of current deletions for primaries and replicas.\n - `pri.indexing.delete_current`: The number of current deletions for primaries.\n - `indexing.delete_time` (or `idti`, `indexingDeleteTime`): The time spent in deletions for primaries and replicas.\n - `pri.indexing.delete_time`: The time spent in deletions for primaries.\n - `indexing.delete_total` (or `idto`, `indexingDeleteTotal`): The number of delete operations for primaries and replicas.\n - `pri.indexing.delete_total`: The number of delete operations for primaries.\n - `indexing.index_current` (or `iic`, `indexingIndexCurrent`): The number of current indexing operations for primaries and replicas.\n - `pri.indexing.index_current`: The number of current indexing operations for primaries.\n - `indexing.index_time` (or `iiti`, `indexingIndexTime`): The time spent in indexing for primaries and replicas.\n - `pri.indexing.index_time`: The time spent in indexing for primaries.\n - `indexing.index_total` (or `iito`, `indexingIndexTotal`): The number of indexing operations for primaries and replicas.\n - `pri.indexing.index_total`: The number of indexing operations for primaries.\n - `indexing.index_failed` (or `iif`, `indexingIndexFailed`): The number of failed indexing operations for primaries and replicas.\n - `pri.indexing.index_failed`: The number of failed indexing operations for primaries.\n - `indexing.index_failed_due_to_version_conflict` (or `iifvc`, `indexingIndexFailedDueToVersionConflict`): The number of failed indexing operations due to version conflict for primaries and replicas.\n - `pri.indexing.index_failed_due_to_version_conflict`: The number of failed indexing operations due to version conflict for primaries.\n - `merges.current` (or `mc`, `mergesCurrent`): The number of current merges for primaries and replicas.\n - `pri.merges.current`: The number of current merges for primaries.\n - `merges.current_docs` (or `mcd`, `mergesCurrentDocs`): The number of current merging documents for primaries and replicas.\n - `pri.merges.current_docs`: The number of current merging documents for primaries.\n - `merges.current_size` (or `mcs`, `mergesCurrentSize`): The size of current merges for primaries and replicas.\n - `pri.merges.current_size`: The size of current merges for primaries.\n - `merges.total` (or `mt`, `mergesTotal`): The number of completed merge operations for primaries and replicas.\n - `pri.merges.total`: The number of completed merge operations for primaries.\n - `merges.total_docs` (or `mtd`, `mergesTotalDocs`): The number of merged documents for primaries and replicas.\n - `pri.merges.total_docs`: The number of merged documents for primaries.\n - `merges.total_size` (or `mts`, `mergesTotalSize`): The merged size for primaries and replicas.\n - `pri.merges.total_size`: The merged size for primaries.\n - `merges.total_time` (or `mtt`, `mergesTotalTime`): The time spent in merges for primaries and replicas.\n - `pri.merges.total_time`: The time spent in merges for primaries.\n - `refresh.total` (or `rto`, `refreshTotal`): The total refreshes for primaries and replicas.\n - `pri.refresh.total`: The total refreshes for primaries.\n - `refresh.time` (or `rti`, `refreshTime`): The time spent in refreshes for primaries and replicas.\n - `pri.refresh.time`: The time spent in refreshes for primaries.\n - `refresh.external_total` (or `rto`, `refreshTotal`): The total external refreshes for primaries and replicas.\n - `pri.refresh.external_total`: The total external refreshes for primaries.\n - `refresh.external_time` (or `rti`, `refreshTime`): The time spent in external refreshes for primaries and replicas.\n - `pri.refresh.external_time`: The time spent in external refreshes for primaries.\n - `refresh.listeners` (or `rli`, `refreshListeners`): The number of pending refresh listeners for primaries and replicas.\n - `pri.refresh.listeners`: The number of pending refresh listeners for primaries.\n - `search.fetch_current` (or `sfc`, `searchFetchCurrent`): The current fetch phase operations for primaries and replicas.\n - `pri.search.fetch_current`: The current fetch phase operations for primaries.\n - `search.fetch_time` (or `sfti`, `searchFetchTime`): The time spent in fetch phase for primaries and replicas.\n - `pri.search.fetch_time`: The time spent in fetch phase for primaries.\n - `search.fetch_total` (or `sfto`, `searchFetchTotal`): The total fetch operations for primaries and replicas.\n - `pri.search.fetch_total`: The total fetch operations for primaries.\n - `search.open_contexts` (or `so`, `searchOpenContexts`): The open search contexts for primaries and replicas.\n - `pri.search.open_contexts`: The open search contexts for primaries.\n - `search.query_current` (or `sqc`, `searchQueryCurrent`): The current query phase operations for primaries and replicas.\n - `pri.search.query_current`: The current query phase operations for primaries.\n - `search.query_time` (or `sqti`, `searchQueryTime`): The time spent in query phase for primaries and replicas.\n - `pri.search.query_time`: The time spent in query phase for primaries.\n - `search.query_total` (or `sqto`, `searchQueryTotal`): The total query phase operations for primaries and replicas.\n - `pri.search.query_total`: The total query phase operations for primaries.\n - `search.scroll_current` (or `scc`, `searchScrollCurrent`): The open scroll contexts for primaries and replicas.\n - `pri.search.scroll_current`: The open scroll contexts for primaries.\n - `search.scroll_time` (or `scti`, `searchScrollTime`): The time scroll contexts held open for primaries and replicas.\n - `pri.search.scroll_time`: The time scroll contexts held open for primaries.\n - `search.scroll_total` (or `scto`, `searchScrollTotal`): The completed scroll contexts for primaries and replicas.\n - `pri.search.scroll_total`: The completed scroll contexts for primaries.\n - `segments.count` (or `sc`, `segmentsCount`): The number of segments for primaries and replicas.\n - `pri.segments.count`: The number of segments for primaries.\n - `segments.memory` (or `sm`, `segmentsMemory`): The memory used by segments for primaries and replicas.\n - `pri.segments.memory`: The memory used by segments for primaries.\n - `segments.index_writer_memory` (or `siwm`, `segmentsIndexWriterMemory`): The memory used by index writer for primaries and replicas.\n - `pri.segments.index_writer_memory`: The memory used by index writer for primaries.\n - `segments.version_map_memory` (or `svmm`, `segmentsVersionMapMemory`): The memory used by version map for primaries and replicas.\n - `pri.segments.version_map_memory`: The memory used by version map for primaries.\n - `segments.fixed_bitset_memory` (or `sfbm`, `fixedBitsetMemory`): The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. Applicable for primaries and replicas.\n - `pri.segments.fixed_bitset_memory`: The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. Applicable for primaries.\n - `warmer.current` (or `wc`, `warmerCurrent`): The current warmer operations for primaries and replicas.\n - `pri.warmer.current`: The current warmer operations for primaries.\n - `warmer.total` (or `wto`, `warmerTotal`): The total warmer operations for primaries and replicas.\n - `pri.warmer.total`: The total warmer operations for primaries.\n - `warmer.total_time` (or `wtt`, `warmerTotalTime`): The time spent in warmers for primaries and replicas.\n - `pri.warmer.total_time`: The time spent in warmers for primaries.\n - `suggest.current` (or `suc`, `suggestCurrent`): The current suggest operations for primaries and replicas.\n - `pri.suggest.current`: The current suggest operations for primaries.\n - `suggest.time` (or `suti`, `suggestTime`): The time spent in suggest for primaries and replicas.\n - `pri.suggest.time`: The time spent in suggest for primaries.\n - `suggest.total` (or `suto`, `suggestTotal`): The number of suggest operations for primaries and replicas.\n - `pri.suggest.total`: The number of suggest operations for primaries.\n - `memory.total` (or `tm`, `memoryTotal`): The total used memory for primaries and replicas.\n - `pri.memory.total`: The total used memory for primaries.\n - `bulk.total_operations` (or `bto`, `bulkTotalOperation`): The number of bulk shard operations for primaries and replicas.\n - `pri.bulk.total_operations`: The number of bulk shard operations for primaries.\n - `bulk.total_time` (or `btti`, `bulkTotalTime`): The time spent in shard bulk for primaries and replicas.\n - `pri.bulk.total_time`: The time spent in shard bulk for primaries.\n - `bulk.total_size_in_bytes` (or `btsi`, `bulkTotalSizeInBytes`): The total size in bytes of shard bulk for primaries and replicas.\n - `pri.bulk.total_size_in_bytes`: The total size in bytes of shard bulk for primaries.\n - `bulk.avg_time` (or `bati`, `bulkAvgTime`): The average time spent in shard bulk for primaries and replicas.\n - `pri.bulk.avg_time`: The average time spent in shard bulk for primaries.\n - `bulk.avg_size_in_bytes` (or `basi`, `bulkAvgSizeInBytes`): The average size in bytes of shard bulk for primaries and replicas.\n - `pri.bulk.avg_size_in_bytes`: The average size in bytes of shard bulk for primaries.\n - `dense_vector.value_count` (or `dvc`, `denseVectorCount`): The total count of indexed dense vectors for primaries and replicas.\n - `pri.dense_vector.value_count`: The total count of indexed dense vectors for primaries.\n - `sparse_vector.value_count` (or `svc`, `sparseVectorCount`): The total count of indexed sparse vectors for primaries and replicas.\n - `pri.sparse_vector.value_count`: The total count of indexed sparse vectors for primaries.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatIndicesColumns' 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.indices.IndicesRecord' examples: CatIndicesResponseExample1: description: 'A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`. ' value: "[\n {\n \"health\": \"yellow\",\n \"status\": \"open\",\n \"index\": \"my-index-000001\",\n \"uuid\": \"u8FNjxh8Rfy_awN11oDKYQ\",\n \"pri\": \"1\",\n \"rep\": \"1\",\n \"docs.count\": \"1200\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"88.1kb\",\n \"pri.store.size\": \"88.1kb\",\n \"dataset.size\": \"88.1kb\"\n },\n {\n \"health\": \"green\",\n \"status\": \"open\",\n \"index\": \"my-index-000002\",\n \"uuid\": \"nYFWZEO7TUiOjLQXBaYJpA \",\n \"pri\": \"1\",\n \"rep\": \"0\",\n \"docs.count\": \"0\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"260b\",\n \"pri.store.size\": \"260b\",\n \"dataset.size\": \"260b\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/indices/{index}\n
\n " x-req-auth: - 'Index privileges: `monitor` ' - 'Cluster privileges: `monitor` ' x-api: indices.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/indices/my-index-*?v=true&s=index&format=json ' - lang: Python source: "resp = client.cat.indices(\n index=\"my-index-*\",\n v=True,\n s=\"index\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.indices({\n index: \"my-index-*\",\n v: \"true\",\n s: \"index\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.indices(\n index: \"my-index-*\",\n v: \"true\",\n s: \"index\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->indices([\n \"index\" => \"my-index-*\",\n \"v\" => \"true\",\n \"s\" => \"index\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/indices/my-index-*?v=true&s=index&format=json"' - lang: Java source: 'client.cat().indices(); ' 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.' operationId: cat-master parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `id`: The node ID.\n - `host` (or `h`): The host name of the node.\n - `ip`: The IP address of the node.\n - `node` (or `n`): The node name.\n\n" 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $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-variations: - "
\n GET\n /_cat/master\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: master.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/master?v=true&format=json ' - lang: Python source: "resp = client.cat.master(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.master({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.master(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->master([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/master?v=true&format=json"' - lang: Java source: 'client.cat().master(); ' 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.' operationId: cat-ml-data-frame-analytics parameters: - in: query name: allow_no_match description: 'Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified.)' deprecated: false schema: type: boolean style: form - in: query name: h description: "Comma-separated list of column names to display.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): Contains messages relating to the selection of a node.\n - `create_time` (or `ct`, `createTime`): The time when the data frame analytics job was created.\n - `description` (or `d`): A description of a job.\n - `dest_index` (or `di`, `destIndex`): Name of the destination index.\n - `failure_reason` (or `fr`, `failureReason`): Contains messages about the reason why a data frame analytics job failed.\n - `id`: Identifier for the data frame analytics job.\n - `model_memory_limit` (or `mml`, `modelMemoryLimit`): The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that the data frame analytics job is\nassigned to.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that the data frame analytics job is assigned\nto.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that the data frame analytics job is\nassigned to.\n - `node.name` (or `nn`, `nodeName`): The name of the node that the data frame analytics job is assigned to.\n - `progress` (or `p`): The progress report of the data frame analytics job by phase.\n - `source_index` (or `si`, `sourceIndex`): Name of the source index.\n - `state` (or `s`): Current state of the data frame analytics job.\n - `type` (or `t`): The type of analysis that the data frame analytics job performs.\n - `version` (or `v`): The Elasticsearch version number in which the data frame analytics job was\ncreated.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatDfaColumns' style: form - in: query name: s description: "Comma-separated list of column names or column aliases used to sort the\nresponse.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): Contains messages relating to the selection of a node.\n - `create_time` (or `ct`, `createTime`): The time when the data frame analytics job was created.\n - `description` (or `d`): A description of a job.\n - `dest_index` (or `di`, `destIndex`): Name of the destination index.\n - `failure_reason` (or `fr`, `failureReason`): Contains messages about the reason why a data frame analytics job failed.\n - `id`: Identifier for the data frame analytics job.\n - `model_memory_limit` (or `mml`, `modelMemoryLimit`): The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that the data frame analytics job is\nassigned to.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that the data frame analytics job is assigned\nto.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that the data frame analytics job is\nassigned to.\n - `node.name` (or `nn`, `nodeName`): The name of the node that the data frame analytics job is assigned to.\n - `progress` (or `p`): The progress report of the data frame analytics job by phase.\n - `source_index` (or `si`, `sourceIndex`): Name of the source index.\n - `state` (or `s`): Current state of the data frame analytics job.\n - `type` (or `t`): The type of analysis that the data frame analytics job performs.\n - `version` (or `v`): The Elasticsearch version number in which the data frame analytics job was\ncreated.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatDfaColumns' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.ml_data_frame_analytics.DataFrameAnalyticsRecord' examples: CatDataframeanalyticsResponseExample1: description: A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`. value: "[\n {\n \"id\": \"classifier_job_1\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:09.594Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_2\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:14.479Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_3\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:16.928Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_4\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:19.127Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_5\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:21.349Z\",\n \"state\": \"stopped\"\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/ml/data_frame/analytics\n
\n " x-req-auth: - 'Cluster privileges: `monitor_ml` ' x-api: ml_data_frame_analytics.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/ml/data_frame/analytics?v=true&format=json ' - lang: Python source: "resp = client.cat.ml_data_frame_analytics(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.mlDataFrameAnalytics({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.ml_data_frame_analytics(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->mlDataFrameAnalytics([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/data_frame/analytics?v=true&format=json"' - lang: Java source: 'client.cat().mlDataFrameAnalytics(); ' 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.' operationId: cat-ml-data-frame-analytics-1 parameters: - in: path name: id description: The ID of the data frame analytics to fetch required: true deprecated: false schema: $ref: '#/components/schemas/_types.Id' style: simple - in: query name: allow_no_match description: 'Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified.)' deprecated: false schema: type: boolean style: form - in: query name: h description: "Comma-separated list of column names to display.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): Contains messages relating to the selection of a node.\n - `create_time` (or `ct`, `createTime`): The time when the data frame analytics job was created.\n - `description` (or `d`): A description of a job.\n - `dest_index` (or `di`, `destIndex`): Name of the destination index.\n - `failure_reason` (or `fr`, `failureReason`): Contains messages about the reason why a data frame analytics job failed.\n - `id`: Identifier for the data frame analytics job.\n - `model_memory_limit` (or `mml`, `modelMemoryLimit`): The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that the data frame analytics job is\nassigned to.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that the data frame analytics job is assigned\nto.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that the data frame analytics job is\nassigned to.\n - `node.name` (or `nn`, `nodeName`): The name of the node that the data frame analytics job is assigned to.\n - `progress` (or `p`): The progress report of the data frame analytics job by phase.\n - `source_index` (or `si`, `sourceIndex`): Name of the source index.\n - `state` (or `s`): Current state of the data frame analytics job.\n - `type` (or `t`): The type of analysis that the data frame analytics job performs.\n - `version` (or `v`): The Elasticsearch version number in which the data frame analytics job was\ncreated.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatDfaColumns' style: form - in: query name: s description: "Comma-separated list of column names or column aliases used to sort the\nresponse.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): Contains messages relating to the selection of a node.\n - `create_time` (or `ct`, `createTime`): The time when the data frame analytics job was created.\n - `description` (or `d`): A description of a job.\n - `dest_index` (or `di`, `destIndex`): Name of the destination index.\n - `failure_reason` (or `fr`, `failureReason`): Contains messages about the reason why a data frame analytics job failed.\n - `id`: Identifier for the data frame analytics job.\n - `model_memory_limit` (or `mml`, `modelMemoryLimit`): The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that the data frame analytics job is\nassigned to.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that the data frame analytics job is assigned\nto.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that the data frame analytics job is\nassigned to.\n - `node.name` (or `nn`, `nodeName`): The name of the node that the data frame analytics job is assigned to.\n - `progress` (or `p`): The progress report of the data frame analytics job by phase.\n - `source_index` (or `si`, `sourceIndex`): Name of the source index.\n - `state` (or `s`): Current state of the data frame analytics job.\n - `type` (or `t`): The type of analysis that the data frame analytics job performs.\n - `version` (or `v`): The Elasticsearch version number in which the data frame analytics job was\ncreated.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatDfaColumns' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.ml_data_frame_analytics.DataFrameAnalyticsRecord' examples: CatDataframeanalyticsResponseExample1: description: A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`. value: "[\n {\n \"id\": \"classifier_job_1\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:09.594Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_2\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:14.479Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_3\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:16.928Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_4\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:19.127Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_5\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:21.349Z\",\n \"state\": \"stopped\"\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/ml/data_frame/analytics/{id}\n
\n " x-req-auth: - 'Cluster privileges: `monitor_ml` ' x-api: ml_data_frame_analytics.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/ml/data_frame/analytics?v=true&format=json ' - lang: Python source: "resp = client.cat.ml_data_frame_analytics(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.mlDataFrameAnalytics({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.ml_data_frame_analytics(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->mlDataFrameAnalytics([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/data_frame/analytics?v=true&format=json"' - lang: Java source: 'client.cat().mlDataFrameAnalytics(); ' 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.' operationId: cat-ml-datafeeds parameters: - in: query name: allow_no_match description: 'Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.' deprecated: false schema: type: boolean style: form - in: query name: h description: "Comma-separated list of column names to display.\n\nSupported values include:\n - `ae` (or `assignment_explanation`): For started datafeeds only, contains messages relating to the selection of\na node.\n - `bc` (or `buckets.count`, `bucketsCount`): The number of buckets processed.\n - `id`: A numerical character string that uniquely identifies the datafeed.\n - `na` (or `node.address`, `nodeAddress`): For started datafeeds only, the network address of the node where the\ndatafeed is started.\n - `ne` (or `node.ephemeral_id`, `nodeEphemeralId`): For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.\n - `ni` (or `node.id`, `nodeId`): For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.\n - `nn` (or `node.name`, `nodeName`): For started datafeeds only, the name of the node where the datafeed is\nstarted.\n - `sba` (or `search.bucket_avg`, `searchBucketAvg`): The average search time per bucket, in milliseconds.\n - `sc` (or `search.count`, `searchCount`): The number of searches run by the datafeed.\n - `seah` (or `search.exp_avg_hour`, `searchExpAvgHour`): The exponential average search time per hour, in milliseconds.\n - `st` (or `search.time`, `searchTime`): The total time the datafeed spent searching, in milliseconds.\n - `s` (or `state`): The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`.\nIf `starting`, the datafeed has been requested to start but has not yet\nstarted. If `started`, the datafeed is actively receiving data. If\n`stopping`, the datafeed has been requested to stop gracefully and is\ncompleting its final action. If `stopped`, the datafeed is stopped and will\nnot receive data until it is re-started.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatDatafeedColumns' style: form - in: query name: s description: "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `ae` (or `assignment_explanation`): For started datafeeds only, contains messages relating to the selection of\na node.\n - `bc` (or `buckets.count`, `bucketsCount`): The number of buckets processed.\n - `id`: A numerical character string that uniquely identifies the datafeed.\n - `na` (or `node.address`, `nodeAddress`): For started datafeeds only, the network address of the node where the\ndatafeed is started.\n - `ne` (or `node.ephemeral_id`, `nodeEphemeralId`): For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.\n - `ni` (or `node.id`, `nodeId`): For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.\n - `nn` (or `node.name`, `nodeName`): For started datafeeds only, the name of the node where the datafeed is\nstarted.\n - `sba` (or `search.bucket_avg`, `searchBucketAvg`): The average search time per bucket, in milliseconds.\n - `sc` (or `search.count`, `searchCount`): The number of searches run by the datafeed.\n - `seah` (or `search.exp_avg_hour`, `searchExpAvgHour`): The exponential average search time per hour, in milliseconds.\n - `st` (or `search.time`, `searchTime`): The total time the datafeed spent searching, in milliseconds.\n - `s` (or `state`): The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`.\nIf `starting`, the datafeed has been requested to start but has not yet\nstarted. If `started`, the datafeed is actively receiving data. If\n`stopping`, the datafeed has been requested to stop gracefully and is\ncompleting its final action. If `stopped`, the datafeed is stopped and will\nnot receive data until it is re-started.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatDatafeedColumns' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.ml_datafeeds.DatafeedsRecord' examples: CatDatafeedsResponseExample1: description: A successful response from `GET _cat/ml/datafeeds?v=true&format=json`. value: "[\n {\n \"id\": \"datafeed-high_sum_total_sales\",\n \"state\": \"stopped\",\n \"buckets.count\": \"743\",\n \"search.count\": \"7\"\n },\n {\n \"id\": \"datafeed-low_request_rate\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1457\",\n \"search.count\": \"3\"\n },\n {\n \"id\": \"datafeed-response_code_rates\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n },\n {\n \"id\": \"datafeed-url_scanning\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/ml/datafeeds\n
\n " x-req-auth: - 'Cluster privileges: `monitor_ml` ' x-api: ml_datafeeds.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/ml/datafeeds?v=true&format=json ' - lang: Python source: "resp = client.cat.ml_datafeeds(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.mlDatafeeds({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.ml_datafeeds(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->mlDatafeeds([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/datafeeds?v=true&format=json"' - lang: Java source: 'client.cat().mlDatafeeds(); ' 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.' operationId: cat-ml-datafeeds-1 parameters: - in: path name: datafeed_id description: A numerical character string that uniquely identifies the datafeed. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Id' style: simple - in: query name: allow_no_match description: 'Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.' deprecated: false schema: type: boolean style: form - in: query name: h description: "Comma-separated list of column names to display.\n\nSupported values include:\n - `ae` (or `assignment_explanation`): For started datafeeds only, contains messages relating to the selection of\na node.\n - `bc` (or `buckets.count`, `bucketsCount`): The number of buckets processed.\n - `id`: A numerical character string that uniquely identifies the datafeed.\n - `na` (or `node.address`, `nodeAddress`): For started datafeeds only, the network address of the node where the\ndatafeed is started.\n - `ne` (or `node.ephemeral_id`, `nodeEphemeralId`): For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.\n - `ni` (or `node.id`, `nodeId`): For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.\n - `nn` (or `node.name`, `nodeName`): For started datafeeds only, the name of the node where the datafeed is\nstarted.\n - `sba` (or `search.bucket_avg`, `searchBucketAvg`): The average search time per bucket, in milliseconds.\n - `sc` (or `search.count`, `searchCount`): The number of searches run by the datafeed.\n - `seah` (or `search.exp_avg_hour`, `searchExpAvgHour`): The exponential average search time per hour, in milliseconds.\n - `st` (or `search.time`, `searchTime`): The total time the datafeed spent searching, in milliseconds.\n - `s` (or `state`): The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`.\nIf `starting`, the datafeed has been requested to start but has not yet\nstarted. If `started`, the datafeed is actively receiving data. If\n`stopping`, the datafeed has been requested to stop gracefully and is\ncompleting its final action. If `stopped`, the datafeed is stopped and will\nnot receive data until it is re-started.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatDatafeedColumns' style: form - in: query name: s description: "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `ae` (or `assignment_explanation`): For started datafeeds only, contains messages relating to the selection of\na node.\n - `bc` (or `buckets.count`, `bucketsCount`): The number of buckets processed.\n - `id`: A numerical character string that uniquely identifies the datafeed.\n - `na` (or `node.address`, `nodeAddress`): For started datafeeds only, the network address of the node where the\ndatafeed is started.\n - `ne` (or `node.ephemeral_id`, `nodeEphemeralId`): For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.\n - `ni` (or `node.id`, `nodeId`): For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.\n - `nn` (or `node.name`, `nodeName`): For started datafeeds only, the name of the node where the datafeed is\nstarted.\n - `sba` (or `search.bucket_avg`, `searchBucketAvg`): The average search time per bucket, in milliseconds.\n - `sc` (or `search.count`, `searchCount`): The number of searches run by the datafeed.\n - `seah` (or `search.exp_avg_hour`, `searchExpAvgHour`): The exponential average search time per hour, in milliseconds.\n - `st` (or `search.time`, `searchTime`): The total time the datafeed spent searching, in milliseconds.\n - `s` (or `state`): The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`.\nIf `starting`, the datafeed has been requested to start but has not yet\nstarted. If `started`, the datafeed is actively receiving data. If\n`stopping`, the datafeed has been requested to stop gracefully and is\ncompleting its final action. If `stopped`, the datafeed is stopped and will\nnot receive data until it is re-started.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatDatafeedColumns' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.ml_datafeeds.DatafeedsRecord' examples: CatDatafeedsResponseExample1: description: A successful response from `GET _cat/ml/datafeeds?v=true&format=json`. value: "[\n {\n \"id\": \"datafeed-high_sum_total_sales\",\n \"state\": \"stopped\",\n \"buckets.count\": \"743\",\n \"search.count\": \"7\"\n },\n {\n \"id\": \"datafeed-low_request_rate\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1457\",\n \"search.count\": \"3\"\n },\n {\n \"id\": \"datafeed-response_code_rates\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n },\n {\n \"id\": \"datafeed-url_scanning\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/ml/datafeeds/{datafeed_id}\n
\n " x-req-auth: - 'Cluster privileges: `monitor_ml` ' x-api: ml_datafeeds.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/ml/datafeeds?v=true&format=json ' - lang: Python source: "resp = client.cat.ml_datafeeds(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.mlDatafeeds({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.ml_datafeeds(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->mlDatafeeds([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/datafeeds?v=true&format=json"' - lang: Java source: 'client.cat().mlDatafeeds(); ' 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.' operationId: cat-ml-jobs parameters: - in: query name: allow_no_match description: 'Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.' deprecated: false schema: type: boolean style: form - in: query name: h description: "Comma-separated list of column names to display.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.\n - `buckets.count` (or `bc`, `bucketsCount`): The number of bucket results produced by the job.\n - `buckets.time.exp_avg` (or `btea`, `bucketsTimeExpAvg`): Exponential moving average of all bucket processing times, in milliseconds.\n - `buckets.time.exp_avg_hour` (or `bteah`, `bucketsTimeExpAvgHour`): Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.\n - `buckets.time.max` (or `btmax`, `bucketsTimeMax`): Maximum among all bucket processing times, in milliseconds.\n - `buckets.time.min` (or `btmin`, `bucketsTimeMin`): Minimum among all bucket processing times, in milliseconds.\n - `buckets.time.total` (or `btt`, `bucketsTimeTotal`): Sum of all bucket processing times, in milliseconds.\n - `data.buckets` (or `db`, `dataBuckets`): The number of buckets processed.\n - `data.earliest_record` (or `der`, `dataEarliestRecord`): The timestamp of the earliest chronologically input document.\n - `data.empty_buckets` (or `deb`, `dataEmptyBuckets`): The number of buckets which did not contain any data.\n - `data.input_bytes` (or `dib`, `dataInputBytes`): The number of bytes of input data posted to the anomaly detection job.\n - `data.input_fields` (or `dif`, `dataInputFields`): The total number of fields in input documents posted to the anomaly\ndetection job. This count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the\nrequired fields from the documents it retrieves before posting them to the job.\n - `data.input_records` (or `dir`, `dataInputRecords`): The number of input documents posted to the anomaly detection job.\n - `data.invalid_dates` (or `did`, `dataInvalidDates`): The number of input documents with either a missing date field or a date\nthat could not be parsed.\n - `data.last` (or `dl`, `dataLast`): The timestamp at which data was last analyzed, according to server time.\n - `data.last_empty_bucket` (or `dleb`, `dataLastEmptyBucket`): The timestamp of the last bucket that did not contain any data.\n - `data.last_sparse_bucket` (or `dlsb`, `dataLastSparseBucket`): The timestamp of the last bucket that was considered sparse.\n - `data.latest_record` (or `dlr`, `dataLatestRecord`): The timestamp of the latest chronologically input document.\n - `data.missing_fields` (or `dmf`, `dataMissingFields`): The number of input documents that are missing a field that the anomaly\ndetection job is configured to analyze. Input documents with missing fields\nare still processed because it is possible that not all fields are missing.\n - `data.out_of_order_timestamps` (or `doot`, `dataOutOfOrderTimestamps`): The number of input documents that have a timestamp chronologically\npreceding the start of the current anomaly detection bucket offset by the\nlatency window. This information is applicable only when you provide data\nto the anomaly detection job by using the post data API. These out of order\ndocuments are discarded, since jobs require time series data to be in\nascending chronological order.\n - `data.processed_fields` (or `dpf`, `dataProcessedFields`): The total number of fields in all the documents that have been processed by\nthe anomaly detection job. Only fields that are specified in the detector\nconfiguration object contribute to this count. The timestamp is not\nincluded in this count.\n - `data.processed_records` (or `dpr`, `dataProcessedRecords`): The number of input documents that have been processed by the anomaly\ndetection job. This value includes documents with missing fields, since\nthey are nonetheless analyzed. If you use datafeeds and have aggregations\nin your search query, the processed record count is the number of\naggregation results processed, not the number of Elasticsearch documents.\n - `data.sparse_buckets` (or `dsb`, `dataSparseBuckets`): The number of buckets that contained few data points compared to the\nexpected number of data points.\n - `forecasts.memory.avg` (or `fmavg`, `forecastsMemoryAvg`): The average memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.max` (or `fmmax`, `forecastsMemoryMax`): The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.min` (or `fmmin`, `forecastsMemoryMin`): The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.total` (or `fmt`, `forecastsMemoryTotal`): The total memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.records.avg` (or `fravg`, `forecastsRecordsAvg`): The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.max` (or `frmax`, `forecastsRecordsMax`): The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.min` (or `frmin`, `forecastsRecordsMin`): The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.total` (or `frt`, `forecastsRecordsTotal`): The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.time.avg` (or `ftavg`, `forecastsTimeAvg`): The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.max` (or `ftmax`, `forecastsTimeMax`): The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.min` (or `ftmin`, `forecastsTimeMin`): The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.total` (or `ftt`, `forecastsTimeTotal`): The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.total` (or `ft`, `forecastsTotal`): The number of individual forecasts currently available for the job.\n - `id`: Identifier for the anomaly detection job.\n - `model.bucket_allocation_failures` (or `mbaf`, `modelBucketAllocationFailures`): The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.\n - `model.by_fields` (or `mbf`, `modelByFields`): The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.\n - `model.bytes` (or `mb`, `modelBytes`): The number of bytes of memory used by the models. This is the maximum value\nsince the last time the model was persisted. If the job is closed, this\nvalue indicates the latest size.\n - `model.bytes_exceeded` (or `mbe`, `modelBytesExceeded`): The number of bytes over the high limit for memory usage at the last\nallocation failure.\n - `model.categorization_status` (or `mcs`, `modelCategorizationStatus`): The status of categorization for the job: `ok` or `warn`. If `ok`,\ncategorization is performing acceptably well (or not being used at all). If\n`warn`, categorization is detecting a distribution of categories that\nsuggests the input data is inappropriate for categorization. Problems could\nbe that there is only one category, more than 90% of categories are rare,\nthe number of categories is greater than 50% of the number of categorized\ndocuments, there are no frequently matched categories, or more than 50% of\ncategories are dead.\n - `model.categorized_doc_count` (or `mcdc`, `modelCategorizedDocCount`): The number of documents that have had a field categorized.\n - `model.dead_category_count` (or `mdcc`, `modelDeadCategoryCount`): The number of categories created by categorization that will never be\nassigned again because another category’s definition makes it a superset of\nthe dead category. Dead categories are a side effect of the way\ncategorization has no prior training.\n - `model.failed_category_count` (or `mdcc`, `modelFailedCategoryCount`): The number of times that categorization wanted to create a new category but\ncouldn’t because the job had hit its model memory limit. This count does\nnot track which specific categories failed to be created. Therefore, you\ncannot use this value to determine the number of unique categories that\nwere missed.\n - `model.frequent_category_count` (or `mfcc`, `modelFrequentCategoryCount`): The number of categories that match more than 1% of categorized documents.\n - `model.log_time` (or `mlt`, `modelLogTime`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_limit` (or `mml`, `modelMemoryLimit`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_status` (or `mms`, `modelMemoryStatus`): The status of the mathematical models: `ok`, `soft_limit`, or `hard_limit`.\nIf `ok`, the models stayed below the configured value. If `soft_limit`, the\nmodels used more than 60% of the configured memory limit and older unused\nmodels will be pruned to free up space. Additionally, in categorization jobs\nno further category examples will be stored. If `hard_limit`, the models\nused more space than the configured memory limit. As a result, not all\nincoming data was processed.\n - `model.over_fields` (or `mof`, `modelOverFields`): The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.partition_fields` (or `mpf`, `modelPartitionFields`): The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.rare_category_count` (or `mrcc`, `modelRareCategoryCount`): The number of categories that match just one categorized document.\n - `model.timestamp` (or `mt`, `modelTimestamp`): The timestamp of the last record when the model stats were gathered.\n - `model.total_category_count` (or `mtcc`, `modelTotalCategoryCount`): The number of categories created by categorization.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that runs the job. This information is\navailable only for open jobs.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that runs the job. This information is\navailable only for open jobs.\n - `node.name` (or `nn`, `nodeName`): The name of the node that runs the job. This information is available only\nfor open jobs.\n - `opened_time` (or `ot`): For open jobs only, the elapsed time for which the job has been open.\n - `state` (or `s`): The status of the anomaly detection job: `closed`, `closing`, `failed`,\n`opened`, or `opening`. If `closed`, the job finished successfully with its\nmodel state persisted. The job must be opened before it can accept further\ndata. If `closing`, the job close action is in progress and has not yet\ncompleted. A closing job cannot accept further data. If `failed`, the job\ndid not finish successfully due to an error. This situation can occur due\nto invalid input data, a fatal error occurring during the analysis, or an\nexternal interaction such as the process being killed by the Linux out of\nmemory (OOM) killer. If the job had irrevocably failed, it must be force\nclosed and then deleted. If the datafeed can be corrected, the job can be\nclosed and then re-opened. If `opened`, the job is available to receive and\nprocess data. If `opening`, the job open action is in progress and has not\nyet completed.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatAnomalyDetectorColumns' style: form - in: query name: s description: "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.\n - `buckets.count` (or `bc`, `bucketsCount`): The number of bucket results produced by the job.\n - `buckets.time.exp_avg` (or `btea`, `bucketsTimeExpAvg`): Exponential moving average of all bucket processing times, in milliseconds.\n - `buckets.time.exp_avg_hour` (or `bteah`, `bucketsTimeExpAvgHour`): Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.\n - `buckets.time.max` (or `btmax`, `bucketsTimeMax`): Maximum among all bucket processing times, in milliseconds.\n - `buckets.time.min` (or `btmin`, `bucketsTimeMin`): Minimum among all bucket processing times, in milliseconds.\n - `buckets.time.total` (or `btt`, `bucketsTimeTotal`): Sum of all bucket processing times, in milliseconds.\n - `data.buckets` (or `db`, `dataBuckets`): The number of buckets processed.\n - `data.earliest_record` (or `der`, `dataEarliestRecord`): The timestamp of the earliest chronologically input document.\n - `data.empty_buckets` (or `deb`, `dataEmptyBuckets`): The number of buckets which did not contain any data.\n - `data.input_bytes` (or `dib`, `dataInputBytes`): The number of bytes of input data posted to the anomaly detection job.\n - `data.input_fields` (or `dif`, `dataInputFields`): The total number of fields in input documents posted to the anomaly\ndetection job. This count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the\nrequired fields from the documents it retrieves before posting them to the job.\n - `data.input_records` (or `dir`, `dataInputRecords`): The number of input documents posted to the anomaly detection job.\n - `data.invalid_dates` (or `did`, `dataInvalidDates`): The number of input documents with either a missing date field or a date\nthat could not be parsed.\n - `data.last` (or `dl`, `dataLast`): The timestamp at which data was last analyzed, according to server time.\n - `data.last_empty_bucket` (or `dleb`, `dataLastEmptyBucket`): The timestamp of the last bucket that did not contain any data.\n - `data.last_sparse_bucket` (or `dlsb`, `dataLastSparseBucket`): The timestamp of the last bucket that was considered sparse.\n - `data.latest_record` (or `dlr`, `dataLatestRecord`): The timestamp of the latest chronologically input document.\n - `data.missing_fields` (or `dmf`, `dataMissingFields`): The number of input documents that are missing a field that the anomaly\ndetection job is configured to analyze. Input documents with missing fields\nare still processed because it is possible that not all fields are missing.\n - `data.out_of_order_timestamps` (or `doot`, `dataOutOfOrderTimestamps`): The number of input documents that have a timestamp chronologically\npreceding the start of the current anomaly detection bucket offset by the\nlatency window. This information is applicable only when you provide data\nto the anomaly detection job by using the post data API. These out of order\ndocuments are discarded, since jobs require time series data to be in\nascending chronological order.\n - `data.processed_fields` (or `dpf`, `dataProcessedFields`): The total number of fields in all the documents that have been processed by\nthe anomaly detection job. Only fields that are specified in the detector\nconfiguration object contribute to this count. The timestamp is not\nincluded in this count.\n - `data.processed_records` (or `dpr`, `dataProcessedRecords`): The number of input documents that have been processed by the anomaly\ndetection job. This value includes documents with missing fields, since\nthey are nonetheless analyzed. If you use datafeeds and have aggregations\nin your search query, the processed record count is the number of\naggregation results processed, not the number of Elasticsearch documents.\n - `data.sparse_buckets` (or `dsb`, `dataSparseBuckets`): The number of buckets that contained few data points compared to the\nexpected number of data points.\n - `forecasts.memory.avg` (or `fmavg`, `forecastsMemoryAvg`): The average memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.max` (or `fmmax`, `forecastsMemoryMax`): The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.min` (or `fmmin`, `forecastsMemoryMin`): The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.total` (or `fmt`, `forecastsMemoryTotal`): The total memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.records.avg` (or `fravg`, `forecastsRecordsAvg`): The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.max` (or `frmax`, `forecastsRecordsMax`): The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.min` (or `frmin`, `forecastsRecordsMin`): The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.total` (or `frt`, `forecastsRecordsTotal`): The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.time.avg` (or `ftavg`, `forecastsTimeAvg`): The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.max` (or `ftmax`, `forecastsTimeMax`): The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.min` (or `ftmin`, `forecastsTimeMin`): The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.total` (or `ftt`, `forecastsTimeTotal`): The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.total` (or `ft`, `forecastsTotal`): The number of individual forecasts currently available for the job.\n - `id`: Identifier for the anomaly detection job.\n - `model.bucket_allocation_failures` (or `mbaf`, `modelBucketAllocationFailures`): The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.\n - `model.by_fields` (or `mbf`, `modelByFields`): The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.\n - `model.bytes` (or `mb`, `modelBytes`): The number of bytes of memory used by the models. This is the maximum value\nsince the last time the model was persisted. If the job is closed, this\nvalue indicates the latest size.\n - `model.bytes_exceeded` (or `mbe`, `modelBytesExceeded`): The number of bytes over the high limit for memory usage at the last\nallocation failure.\n - `model.categorization_status` (or `mcs`, `modelCategorizationStatus`): The status of categorization for the job: `ok` or `warn`. If `ok`,\ncategorization is performing acceptably well (or not being used at all). If\n`warn`, categorization is detecting a distribution of categories that\nsuggests the input data is inappropriate for categorization. Problems could\nbe that there is only one category, more than 90% of categories are rare,\nthe number of categories is greater than 50% of the number of categorized\ndocuments, there are no frequently matched categories, or more than 50% of\ncategories are dead.\n - `model.categorized_doc_count` (or `mcdc`, `modelCategorizedDocCount`): The number of documents that have had a field categorized.\n - `model.dead_category_count` (or `mdcc`, `modelDeadCategoryCount`): The number of categories created by categorization that will never be\nassigned again because another category’s definition makes it a superset of\nthe dead category. Dead categories are a side effect of the way\ncategorization has no prior training.\n - `model.failed_category_count` (or `mdcc`, `modelFailedCategoryCount`): The number of times that categorization wanted to create a new category but\ncouldn’t because the job had hit its model memory limit. This count does\nnot track which specific categories failed to be created. Therefore, you\ncannot use this value to determine the number of unique categories that\nwere missed.\n - `model.frequent_category_count` (or `mfcc`, `modelFrequentCategoryCount`): The number of categories that match more than 1% of categorized documents.\n - `model.log_time` (or `mlt`, `modelLogTime`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_limit` (or `mml`, `modelMemoryLimit`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_status` (or `mms`, `modelMemoryStatus`): The status of the mathematical models: `ok`, `soft_limit`, or `hard_limit`.\nIf `ok`, the models stayed below the configured value. If `soft_limit`, the\nmodels used more than 60% of the configured memory limit and older unused\nmodels will be pruned to free up space. Additionally, in categorization jobs\nno further category examples will be stored. If `hard_limit`, the models\nused more space than the configured memory limit. As a result, not all\nincoming data was processed.\n - `model.over_fields` (or `mof`, `modelOverFields`): The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.partition_fields` (or `mpf`, `modelPartitionFields`): The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.rare_category_count` (or `mrcc`, `modelRareCategoryCount`): The number of categories that match just one categorized document.\n - `model.timestamp` (or `mt`, `modelTimestamp`): The timestamp of the last record when the model stats were gathered.\n - `model.total_category_count` (or `mtcc`, `modelTotalCategoryCount`): The number of categories created by categorization.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that runs the job. This information is\navailable only for open jobs.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that runs the job. This information is\navailable only for open jobs.\n - `node.name` (or `nn`, `nodeName`): The name of the node that runs the job. This information is available only\nfor open jobs.\n - `opened_time` (or `ot`): For open jobs only, the elapsed time for which the job has been open.\n - `state` (or `s`): The status of the anomaly detection job: `closed`, `closing`, `failed`,\n`opened`, or `opening`. If `closed`, the job finished successfully with its\nmodel state persisted. The job must be opened before it can accept further\ndata. If `closing`, the job close action is in progress and has not yet\ncompleted. A closing job cannot accept further data. If `failed`, the job\ndid not finish successfully due to an error. This situation can occur due\nto invalid input data, a fatal error occurring during the analysis, or an\nexternal interaction such as the process being killed by the Linux out of\nmemory (OOM) killer. If the job had irrevocably failed, it must be force\nclosed and then deleted. If the datafeed can be corrected, the job can be\nclosed and then re-opened. If `opened`, the job is available to receive and\nprocess data. If `opening`, the job open action is in progress and has not\nyet completed.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatAnomalyDetectorColumns' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.ml_jobs.JobsRecord' examples: CatJobsResponseExample1: description: A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`. value: "[\n {\n \"id\": \"high_sum_total_sales\",\n \"s\": \"closed\",\n \"dpr\": \"14022\",\n \"mb\": \"1.5mb\"\n },\n {\n \"id\": \"low_request_rate\",\n \"s\": \"closed\",\n \"dpr\": \"1216\",\n \"mb\": \"40.5kb\"\n },\n {\n \"id\": \"response_code_rates\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"132.7kb\"\n },\n {\n \"id\": \"url_scanning\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"501.6kb\"\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/ml/anomaly_detectors\n
\n " x-req-auth: - 'Cluster privileges: `monitor_ml` ' x-api: ml_jobs.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json ' - lang: Python source: "resp = client.cat.ml_jobs(\n h=\"id,s,dpr,mb\",\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.mlJobs({\n h: \"id,s,dpr,mb\",\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.ml_jobs(\n h: \"id,s,dpr,mb\",\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->mlJobs([\n \"h\" => \"id,s,dpr,mb\",\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json"' - lang: Java source: 'client.cat().mlJobs(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/ml/anomaly_detectors/{job_id}: 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.' operationId: cat-ml-jobs-1 parameters: - in: path name: job_id description: Identifier for the anomaly detection job. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Id' style: simple - in: query name: allow_no_match description: 'Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.' deprecated: false schema: type: boolean style: form - in: query name: h description: "Comma-separated list of column names to display.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.\n - `buckets.count` (or `bc`, `bucketsCount`): The number of bucket results produced by the job.\n - `buckets.time.exp_avg` (or `btea`, `bucketsTimeExpAvg`): Exponential moving average of all bucket processing times, in milliseconds.\n - `buckets.time.exp_avg_hour` (or `bteah`, `bucketsTimeExpAvgHour`): Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.\n - `buckets.time.max` (or `btmax`, `bucketsTimeMax`): Maximum among all bucket processing times, in milliseconds.\n - `buckets.time.min` (or `btmin`, `bucketsTimeMin`): Minimum among all bucket processing times, in milliseconds.\n - `buckets.time.total` (or `btt`, `bucketsTimeTotal`): Sum of all bucket processing times, in milliseconds.\n - `data.buckets` (or `db`, `dataBuckets`): The number of buckets processed.\n - `data.earliest_record` (or `der`, `dataEarliestRecord`): The timestamp of the earliest chronologically input document.\n - `data.empty_buckets` (or `deb`, `dataEmptyBuckets`): The number of buckets which did not contain any data.\n - `data.input_bytes` (or `dib`, `dataInputBytes`): The number of bytes of input data posted to the anomaly detection job.\n - `data.input_fields` (or `dif`, `dataInputFields`): The total number of fields in input documents posted to the anomaly\ndetection job. This count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the\nrequired fields from the documents it retrieves before posting them to the job.\n - `data.input_records` (or `dir`, `dataInputRecords`): The number of input documents posted to the anomaly detection job.\n - `data.invalid_dates` (or `did`, `dataInvalidDates`): The number of input documents with either a missing date field or a date\nthat could not be parsed.\n - `data.last` (or `dl`, `dataLast`): The timestamp at which data was last analyzed, according to server time.\n - `data.last_empty_bucket` (or `dleb`, `dataLastEmptyBucket`): The timestamp of the last bucket that did not contain any data.\n - `data.last_sparse_bucket` (or `dlsb`, `dataLastSparseBucket`): The timestamp of the last bucket that was considered sparse.\n - `data.latest_record` (or `dlr`, `dataLatestRecord`): The timestamp of the latest chronologically input document.\n - `data.missing_fields` (or `dmf`, `dataMissingFields`): The number of input documents that are missing a field that the anomaly\ndetection job is configured to analyze. Input documents with missing fields\nare still processed because it is possible that not all fields are missing.\n - `data.out_of_order_timestamps` (or `doot`, `dataOutOfOrderTimestamps`): The number of input documents that have a timestamp chronologically\npreceding the start of the current anomaly detection bucket offset by the\nlatency window. This information is applicable only when you provide data\nto the anomaly detection job by using the post data API. These out of order\ndocuments are discarded, since jobs require time series data to be in\nascending chronological order.\n - `data.processed_fields` (or `dpf`, `dataProcessedFields`): The total number of fields in all the documents that have been processed by\nthe anomaly detection job. Only fields that are specified in the detector\nconfiguration object contribute to this count. The timestamp is not\nincluded in this count.\n - `data.processed_records` (or `dpr`, `dataProcessedRecords`): The number of input documents that have been processed by the anomaly\ndetection job. This value includes documents with missing fields, since\nthey are nonetheless analyzed. If you use datafeeds and have aggregations\nin your search query, the processed record count is the number of\naggregation results processed, not the number of Elasticsearch documents.\n - `data.sparse_buckets` (or `dsb`, `dataSparseBuckets`): The number of buckets that contained few data points compared to the\nexpected number of data points.\n - `forecasts.memory.avg` (or `fmavg`, `forecastsMemoryAvg`): The average memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.max` (or `fmmax`, `forecastsMemoryMax`): The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.min` (or `fmmin`, `forecastsMemoryMin`): The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.total` (or `fmt`, `forecastsMemoryTotal`): The total memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.records.avg` (or `fravg`, `forecastsRecordsAvg`): The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.max` (or `frmax`, `forecastsRecordsMax`): The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.min` (or `frmin`, `forecastsRecordsMin`): The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.total` (or `frt`, `forecastsRecordsTotal`): The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.time.avg` (or `ftavg`, `forecastsTimeAvg`): The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.max` (or `ftmax`, `forecastsTimeMax`): The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.min` (or `ftmin`, `forecastsTimeMin`): The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.total` (or `ftt`, `forecastsTimeTotal`): The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.total` (or `ft`, `forecastsTotal`): The number of individual forecasts currently available for the job.\n - `id`: Identifier for the anomaly detection job.\n - `model.bucket_allocation_failures` (or `mbaf`, `modelBucketAllocationFailures`): The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.\n - `model.by_fields` (or `mbf`, `modelByFields`): The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.\n - `model.bytes` (or `mb`, `modelBytes`): The number of bytes of memory used by the models. This is the maximum value\nsince the last time the model was persisted. If the job is closed, this\nvalue indicates the latest size.\n - `model.bytes_exceeded` (or `mbe`, `modelBytesExceeded`): The number of bytes over the high limit for memory usage at the last\nallocation failure.\n - `model.categorization_status` (or `mcs`, `modelCategorizationStatus`): The status of categorization for the job: `ok` or `warn`. If `ok`,\ncategorization is performing acceptably well (or not being used at all). If\n`warn`, categorization is detecting a distribution of categories that\nsuggests the input data is inappropriate for categorization. Problems could\nbe that there is only one category, more than 90% of categories are rare,\nthe number of categories is greater than 50% of the number of categorized\ndocuments, there are no frequently matched categories, or more than 50% of\ncategories are dead.\n - `model.categorized_doc_count` (or `mcdc`, `modelCategorizedDocCount`): The number of documents that have had a field categorized.\n - `model.dead_category_count` (or `mdcc`, `modelDeadCategoryCount`): The number of categories created by categorization that will never be\nassigned again because another category’s definition makes it a superset of\nthe dead category. Dead categories are a side effect of the way\ncategorization has no prior training.\n - `model.failed_category_count` (or `mdcc`, `modelFailedCategoryCount`): The number of times that categorization wanted to create a new category but\ncouldn’t because the job had hit its model memory limit. This count does\nnot track which specific categories failed to be created. Therefore, you\ncannot use this value to determine the number of unique categories that\nwere missed.\n - `model.frequent_category_count` (or `mfcc`, `modelFrequentCategoryCount`): The number of categories that match more than 1% of categorized documents.\n - `model.log_time` (or `mlt`, `modelLogTime`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_limit` (or `mml`, `modelMemoryLimit`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_status` (or `mms`, `modelMemoryStatus`): The status of the mathematical models: `ok`, `soft_limit`, or `hard_limit`.\nIf `ok`, the models stayed below the configured value. If `soft_limit`, the\nmodels used more than 60% of the configured memory limit and older unused\nmodels will be pruned to free up space. Additionally, in categorization jobs\nno further category examples will be stored. If `hard_limit`, the models\nused more space than the configured memory limit. As a result, not all\nincoming data was processed.\n - `model.over_fields` (or `mof`, `modelOverFields`): The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.partition_fields` (or `mpf`, `modelPartitionFields`): The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.rare_category_count` (or `mrcc`, `modelRareCategoryCount`): The number of categories that match just one categorized document.\n - `model.timestamp` (or `mt`, `modelTimestamp`): The timestamp of the last record when the model stats were gathered.\n - `model.total_category_count` (or `mtcc`, `modelTotalCategoryCount`): The number of categories created by categorization.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that runs the job. This information is\navailable only for open jobs.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that runs the job. This information is\navailable only for open jobs.\n - `node.name` (or `nn`, `nodeName`): The name of the node that runs the job. This information is available only\nfor open jobs.\n - `opened_time` (or `ot`): For open jobs only, the elapsed time for which the job has been open.\n - `state` (or `s`): The status of the anomaly detection job: `closed`, `closing`, `failed`,\n`opened`, or `opening`. If `closed`, the job finished successfully with its\nmodel state persisted. The job must be opened before it can accept further\ndata. If `closing`, the job close action is in progress and has not yet\ncompleted. A closing job cannot accept further data. If `failed`, the job\ndid not finish successfully due to an error. This situation can occur due\nto invalid input data, a fatal error occurring during the analysis, or an\nexternal interaction such as the process being killed by the Linux out of\nmemory (OOM) killer. If the job had irrevocably failed, it must be force\nclosed and then deleted. If the datafeed can be corrected, the job can be\nclosed and then re-opened. If `opened`, the job is available to receive and\nprocess data. If `opening`, the job open action is in progress and has not\nyet completed.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatAnomalyDetectorColumns' style: form - in: query name: s description: "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.\n - `buckets.count` (or `bc`, `bucketsCount`): The number of bucket results produced by the job.\n - `buckets.time.exp_avg` (or `btea`, `bucketsTimeExpAvg`): Exponential moving average of all bucket processing times, in milliseconds.\n - `buckets.time.exp_avg_hour` (or `bteah`, `bucketsTimeExpAvgHour`): Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.\n - `buckets.time.max` (or `btmax`, `bucketsTimeMax`): Maximum among all bucket processing times, in milliseconds.\n - `buckets.time.min` (or `btmin`, `bucketsTimeMin`): Minimum among all bucket processing times, in milliseconds.\n - `buckets.time.total` (or `btt`, `bucketsTimeTotal`): Sum of all bucket processing times, in milliseconds.\n - `data.buckets` (or `db`, `dataBuckets`): The number of buckets processed.\n - `data.earliest_record` (or `der`, `dataEarliestRecord`): The timestamp of the earliest chronologically input document.\n - `data.empty_buckets` (or `deb`, `dataEmptyBuckets`): The number of buckets which did not contain any data.\n - `data.input_bytes` (or `dib`, `dataInputBytes`): The number of bytes of input data posted to the anomaly detection job.\n - `data.input_fields` (or `dif`, `dataInputFields`): The total number of fields in input documents posted to the anomaly\ndetection job. This count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the\nrequired fields from the documents it retrieves before posting them to the job.\n - `data.input_records` (or `dir`, `dataInputRecords`): The number of input documents posted to the anomaly detection job.\n - `data.invalid_dates` (or `did`, `dataInvalidDates`): The number of input documents with either a missing date field or a date\nthat could not be parsed.\n - `data.last` (or `dl`, `dataLast`): The timestamp at which data was last analyzed, according to server time.\n - `data.last_empty_bucket` (or `dleb`, `dataLastEmptyBucket`): The timestamp of the last bucket that did not contain any data.\n - `data.last_sparse_bucket` (or `dlsb`, `dataLastSparseBucket`): The timestamp of the last bucket that was considered sparse.\n - `data.latest_record` (or `dlr`, `dataLatestRecord`): The timestamp of the latest chronologically input document.\n - `data.missing_fields` (or `dmf`, `dataMissingFields`): The number of input documents that are missing a field that the anomaly\ndetection job is configured to analyze. Input documents with missing fields\nare still processed because it is possible that not all fields are missing.\n - `data.out_of_order_timestamps` (or `doot`, `dataOutOfOrderTimestamps`): The number of input documents that have a timestamp chronologically\npreceding the start of the current anomaly detection bucket offset by the\nlatency window. This information is applicable only when you provide data\nto the anomaly detection job by using the post data API. These out of order\ndocuments are discarded, since jobs require time series data to be in\nascending chronological order.\n - `data.processed_fields` (or `dpf`, `dataProcessedFields`): The total number of fields in all the documents that have been processed by\nthe anomaly detection job. Only fields that are specified in the detector\nconfiguration object contribute to this count. The timestamp is not\nincluded in this count.\n - `data.processed_records` (or `dpr`, `dataProcessedRecords`): The number of input documents that have been processed by the anomaly\ndetection job. This value includes documents with missing fields, since\nthey are nonetheless analyzed. If you use datafeeds and have aggregations\nin your search query, the processed record count is the number of\naggregation results processed, not the number of Elasticsearch documents.\n - `data.sparse_buckets` (or `dsb`, `dataSparseBuckets`): The number of buckets that contained few data points compared to the\nexpected number of data points.\n - `forecasts.memory.avg` (or `fmavg`, `forecastsMemoryAvg`): The average memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.max` (or `fmmax`, `forecastsMemoryMax`): The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.min` (or `fmmin`, `forecastsMemoryMin`): The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.total` (or `fmt`, `forecastsMemoryTotal`): The total memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.records.avg` (or `fravg`, `forecastsRecordsAvg`): The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.max` (or `frmax`, `forecastsRecordsMax`): The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.min` (or `frmin`, `forecastsRecordsMin`): The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.total` (or `frt`, `forecastsRecordsTotal`): The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.time.avg` (or `ftavg`, `forecastsTimeAvg`): The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.max` (or `ftmax`, `forecastsTimeMax`): The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.min` (or `ftmin`, `forecastsTimeMin`): The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.total` (or `ftt`, `forecastsTimeTotal`): The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.total` (or `ft`, `forecastsTotal`): The number of individual forecasts currently available for the job.\n - `id`: Identifier for the anomaly detection job.\n - `model.bucket_allocation_failures` (or `mbaf`, `modelBucketAllocationFailures`): The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.\n - `model.by_fields` (or `mbf`, `modelByFields`): The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.\n - `model.bytes` (or `mb`, `modelBytes`): The number of bytes of memory used by the models. This is the maximum value\nsince the last time the model was persisted. If the job is closed, this\nvalue indicates the latest size.\n - `model.bytes_exceeded` (or `mbe`, `modelBytesExceeded`): The number of bytes over the high limit for memory usage at the last\nallocation failure.\n - `model.categorization_status` (or `mcs`, `modelCategorizationStatus`): The status of categorization for the job: `ok` or `warn`. If `ok`,\ncategorization is performing acceptably well (or not being used at all). If\n`warn`, categorization is detecting a distribution of categories that\nsuggests the input data is inappropriate for categorization. Problems could\nbe that there is only one category, more than 90% of categories are rare,\nthe number of categories is greater than 50% of the number of categorized\ndocuments, there are no frequently matched categories, or more than 50% of\ncategories are dead.\n - `model.categorized_doc_count` (or `mcdc`, `modelCategorizedDocCount`): The number of documents that have had a field categorized.\n - `model.dead_category_count` (or `mdcc`, `modelDeadCategoryCount`): The number of categories created by categorization that will never be\nassigned again because another category’s definition makes it a superset of\nthe dead category. Dead categories are a side effect of the way\ncategorization has no prior training.\n - `model.failed_category_count` (or `mdcc`, `modelFailedCategoryCount`): The number of times that categorization wanted to create a new category but\ncouldn’t because the job had hit its model memory limit. This count does\nnot track which specific categories failed to be created. Therefore, you\ncannot use this value to determine the number of unique categories that\nwere missed.\n - `model.frequent_category_count` (or `mfcc`, `modelFrequentCategoryCount`): The number of categories that match more than 1% of categorized documents.\n - `model.log_time` (or `mlt`, `modelLogTime`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_limit` (or `mml`, `modelMemoryLimit`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_status` (or `mms`, `modelMemoryStatus`): The status of the mathematical models: `ok`, `soft_limit`, or `hard_limit`.\nIf `ok`, the models stayed below the configured value. If `soft_limit`, the\nmodels used more than 60% of the configured memory limit and older unused\nmodels will be pruned to free up space. Additionally, in categorization jobs\nno further category examples will be stored. If `hard_limit`, the models\nused more space than the configured memory limit. As a result, not all\nincoming data was processed.\n - `model.over_fields` (or `mof`, `modelOverFields`): The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.partition_fields` (or `mpf`, `modelPartitionFields`): The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.rare_category_count` (or `mrcc`, `modelRareCategoryCount`): The number of categories that match just one categorized document.\n - `model.timestamp` (or `mt`, `modelTimestamp`): The timestamp of the last record when the model stats were gathered.\n - `model.total_category_count` (or `mtcc`, `modelTotalCategoryCount`): The number of categories created by categorization.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that runs the job. This information is\navailable only for open jobs.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that runs the job. This information is\navailable only for open jobs.\n - `node.name` (or `nn`, `nodeName`): The name of the node that runs the job. This information is available only\nfor open jobs.\n - `opened_time` (or `ot`): For open jobs only, the elapsed time for which the job has been open.\n - `state` (or `s`): The status of the anomaly detection job: `closed`, `closing`, `failed`,\n`opened`, or `opening`. If `closed`, the job finished successfully with its\nmodel state persisted. The job must be opened before it can accept further\ndata. If `closing`, the job close action is in progress and has not yet\ncompleted. A closing job cannot accept further data. If `failed`, the job\ndid not finish successfully due to an error. This situation can occur due\nto invalid input data, a fatal error occurring during the analysis, or an\nexternal interaction such as the process being killed by the Linux out of\nmemory (OOM) killer. If the job had irrevocably failed, it must be force\nclosed and then deleted. If the datafeed can be corrected, the job can be\nclosed and then re-opened. If `opened`, the job is available to receive and\nprocess data. If `opening`, the job open action is in progress and has not\nyet completed.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatAnomalyDetectorColumns' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.ml_jobs.JobsRecord' examples: CatJobsResponseExample1: description: A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`. value: "[\n {\n \"id\": \"high_sum_total_sales\",\n \"s\": \"closed\",\n \"dpr\": \"14022\",\n \"mb\": \"1.5mb\"\n },\n {\n \"id\": \"low_request_rate\",\n \"s\": \"closed\",\n \"dpr\": \"1216\",\n \"mb\": \"40.5kb\"\n },\n {\n \"id\": \"response_code_rates\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"132.7kb\"\n },\n {\n \"id\": \"url_scanning\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"501.6kb\"\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/ml/anomaly_detectors/{job_id}\n
\n " x-req-auth: - 'Cluster privileges: `monitor_ml` ' x-api: ml_jobs.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json ' - lang: Python source: "resp = client.cat.ml_jobs(\n h=\"id,s,dpr,mb\",\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.mlJobs({\n h: \"id,s,dpr,mb\",\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.ml_jobs(\n h: \"id,s,dpr,mb\",\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->mlJobs([\n \"h\" => \"id,s,dpr,mb\",\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json"' - lang: Java source: 'client.cat().mlJobs(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/ml/trained_models: get: tags: - Cat summary: Get trained models description: 'Get configuration and usage information about inference trained models. 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 trained models statistics API.' operationId: cat-ml-trained-models parameters: - in: query name: allow_no_match description: 'Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.' deprecated: false schema: type: boolean style: form - in: query name: h description: "A comma-separated list of column names to display.\n\nSupported values include:\n - `create_time` (or `ct`): The time when the trained model was created.\n - `created_by` (or `c`, `createdBy`): Information on the creator of the trained model.\n - `data_frame_analytics_id` (or `df`, `dataFrameAnalytics`, `dfid`): Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.\n - `description` (or `d`): The description of the trained model.\n - `heap_size` (or `hs`, `modelHeapSize`): The estimated heap size to keep the trained model in memory.\n - `id`: Identifier for the trained model.\n - `ingest.count` (or `ic`, `ingestCount`): The total number of documents that are processed by the model.\n - `ingest.current` (or `icurr`, `ingestCurrent`): The total number of document that are currently being handled by the\ntrained model.\n - `ingest.failed` (or `if`, `ingestFailed`): The total number of failed ingest attempts with the trained model.\n - `ingest.pipelines` (or `ip`, `ingestPipelines`): The total number of ingest pipelines that are referencing the trained\nmodel.\n - `ingest.time` (or `it`, `ingestTime`): The total time that is spent processing documents with the trained model.\n - `license` (or `l`): The license level of the trained model.\n - `operations` (or `o`, `modelOperations`): The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.\n - `version` (or `v`): The Elasticsearch version number in which the trained model was created.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTrainedModelsColumns' style: form - in: query name: s description: "A comma-separated list of column names or aliases used to sort the response.\n\nSupported values include:\n - `create_time` (or `ct`): The time when the trained model was created.\n - `created_by` (or `c`, `createdBy`): Information on the creator of the trained model.\n - `data_frame_analytics_id` (or `df`, `dataFrameAnalytics`, `dfid`): Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.\n - `description` (or `d`): The description of the trained model.\n - `heap_size` (or `hs`, `modelHeapSize`): The estimated heap size to keep the trained model in memory.\n - `id`: Identifier for the trained model.\n - `ingest.count` (or `ic`, `ingestCount`): The total number of documents that are processed by the model.\n - `ingest.current` (or `icurr`, `ingestCurrent`): The total number of document that are currently being handled by the\ntrained model.\n - `ingest.failed` (or `if`, `ingestFailed`): The total number of failed ingest attempts with the trained model.\n - `ingest.pipelines` (or `ip`, `ingestPipelines`): The total number of ingest pipelines that are referencing the trained\nmodel.\n - `ingest.time` (or `it`, `ingestTime`): The total time that is spent processing documents with the trained model.\n - `license` (or `l`): The license level of the trained model.\n - `operations` (or `o`, `modelOperations`): The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.\n - `version` (or `v`): The Elasticsearch version number in which the trained model was created.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTrainedModelsColumns' style: form - in: query name: from description: Skips the specified number of transforms. deprecated: false schema: type: number style: form - in: query name: size description: The maximum number of transforms to display. deprecated: false schema: type: number style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.ml_trained_models.TrainedModelsRecord' examples: CatTrainedModelsResponseExample1: description: A successful response from `GET _cat/ml/trained_models?v=true&format=json`. value: "[\n {\n \"id\": \"ddddd-1580216177138\",\n \"heap_size\": \"0b\",\n \"operations\": \"196\",\n \"create_time\": \"2025-03-25T00:01:38.662Z\",\n \"type\": \"pytorch\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n },\n {\n \"id\": \"lang_ident_model_1\",\n \"heap_size\": \"1mb\",\n \"operations\": \"39629\",\n \"create_time\": \"2019-12-05T12:28:34.594Z\",\n \"type\": \"lang_ident\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/ml/trained_models\n
\n " x-req-auth: - 'Cluster privileges: `monitor_ml` ' x-api: ml_trained_models.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/ml/trained_models?v=true&format=json ' - lang: Python source: "resp = client.cat.ml_trained_models(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.mlTrainedModels({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.ml_trained_models(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->mlTrainedModels([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/trained_models?v=true&format=json"' - lang: Java source: 'client.cat().mlTrainedModels(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/ml/trained_models/{model_id}: get: tags: - Cat summary: Get trained models description: 'Get configuration and usage information about inference trained models. 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 trained models statistics API.' operationId: cat-ml-trained-models-1 parameters: - in: path name: model_id description: A unique identifier for the trained model. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Id' style: simple - in: query name: allow_no_match description: 'Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches.' deprecated: false schema: type: boolean style: form - in: query name: h description: "A comma-separated list of column names to display.\n\nSupported values include:\n - `create_time` (or `ct`): The time when the trained model was created.\n - `created_by` (or `c`, `createdBy`): Information on the creator of the trained model.\n - `data_frame_analytics_id` (or `df`, `dataFrameAnalytics`, `dfid`): Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.\n - `description` (or `d`): The description of the trained model.\n - `heap_size` (or `hs`, `modelHeapSize`): The estimated heap size to keep the trained model in memory.\n - `id`: Identifier for the trained model.\n - `ingest.count` (or `ic`, `ingestCount`): The total number of documents that are processed by the model.\n - `ingest.current` (or `icurr`, `ingestCurrent`): The total number of document that are currently being handled by the\ntrained model.\n - `ingest.failed` (or `if`, `ingestFailed`): The total number of failed ingest attempts with the trained model.\n - `ingest.pipelines` (or `ip`, `ingestPipelines`): The total number of ingest pipelines that are referencing the trained\nmodel.\n - `ingest.time` (or `it`, `ingestTime`): The total time that is spent processing documents with the trained model.\n - `license` (or `l`): The license level of the trained model.\n - `operations` (or `o`, `modelOperations`): The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.\n - `version` (or `v`): The Elasticsearch version number in which the trained model was created.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTrainedModelsColumns' style: form - in: query name: s description: "A comma-separated list of column names or aliases used to sort the response.\n\nSupported values include:\n - `create_time` (or `ct`): The time when the trained model was created.\n - `created_by` (or `c`, `createdBy`): Information on the creator of the trained model.\n - `data_frame_analytics_id` (or `df`, `dataFrameAnalytics`, `dfid`): Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.\n - `description` (or `d`): The description of the trained model.\n - `heap_size` (or `hs`, `modelHeapSize`): The estimated heap size to keep the trained model in memory.\n - `id`: Identifier for the trained model.\n - `ingest.count` (or `ic`, `ingestCount`): The total number of documents that are processed by the model.\n - `ingest.current` (or `icurr`, `ingestCurrent`): The total number of document that are currently being handled by the\ntrained model.\n - `ingest.failed` (or `if`, `ingestFailed`): The total number of failed ingest attempts with the trained model.\n - `ingest.pipelines` (or `ip`, `ingestPipelines`): The total number of ingest pipelines that are referencing the trained\nmodel.\n - `ingest.time` (or `it`, `ingestTime`): The total time that is spent processing documents with the trained model.\n - `license` (or `l`): The license level of the trained model.\n - `operations` (or `o`, `modelOperations`): The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.\n - `version` (or `v`): The Elasticsearch version number in which the trained model was created.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTrainedModelsColumns' style: form - in: query name: from description: Skips the specified number of transforms. deprecated: false schema: type: number style: form - in: query name: size description: The maximum number of transforms to display. deprecated: false schema: type: number style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.ml_trained_models.TrainedModelsRecord' examples: CatTrainedModelsResponseExample1: description: A successful response from `GET _cat/ml/trained_models?v=true&format=json`. value: "[\n {\n \"id\": \"ddddd-1580216177138\",\n \"heap_size\": \"0b\",\n \"operations\": \"196\",\n \"create_time\": \"2025-03-25T00:01:38.662Z\",\n \"type\": \"pytorch\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n },\n {\n \"id\": \"lang_ident_model_1\",\n \"heap_size\": \"1mb\",\n \"operations\": \"39629\",\n \"create_time\": \"2019-12-05T12:28:34.594Z\",\n \"type\": \"lang_ident\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/ml/trained_models/{model_id}\n
\n " x-req-auth: - 'Cluster privileges: `monitor_ml` ' x-api: ml_trained_models.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/ml/trained_models?v=true&format=json ' - lang: Python source: "resp = client.cat.ml_trained_models(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.mlTrainedModels({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.ml_trained_models(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->mlTrainedModels([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/trained_models?v=true&format=json"' - lang: Java source: 'client.cat().mlTrainedModels(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/nodeattrs: get: tags: - Cat summary: Get node attribute information description: 'Get information about custom node attributes. 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.' operationId: cat-nodeattrs parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `node`: The node name.\n - `id` (or `id`, `nodeId`): The unique node ID.\n - `pid` (or `p`): The process ID.\n - `host` (or `h`): The host name.\n - `ip` (or `i`): The IP address.\n - `port` (or `po`): The bound transport port.\n - `attr` (or `attr.name`): The attribute description.\n - `value` (or `attr.value`): The attribute value.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatNodeattrsColumns' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.nodeattrs.NodeAttributesRecord' examples: CatNodeAttributesResponseExample1: summary: Default columns description: 'A successful response from `GET /_cat/nodeattrs?v=true&format=json`. The `node`, `host`, and `ip` columns provide basic information about each node. The `attr` and `value` columns return custom node attributes, one per line. ' value: "[\n {\n \"node\": \"node-0\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"attr\": \"testattr\",\n \"value\": \"test\"\n }\n]" CatNodeAttributesResponseExample2: summary: Explicit columns description: 'A successful response from `GET /_cat/nodeattrs?v=true&h=name,pid,attr,value`. It returns the `name`, `pid`, `attr`, and `value` columns. ' value: "[\n {\n \"name\": \"node-0\",\n \"pid\": \"19566\",\n \"attr\": \"testattr\",\n \"value\": \"test\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/nodeattrs\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: nodeattrs.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/nodeattrs?v=true&format=json ' - lang: Python source: "resp = client.cat.nodeattrs(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.nodeattrs({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.nodeattrs(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->nodeattrs([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/nodeattrs?v=true&format=json"' - lang: Java source: 'client.cat().nodeattrs(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/nodes: get: tags: - Cat summary: Get node information description: 'Get information about the nodes in a 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 info API.' operationId: cat-nodes parameters: - in: query name: full_id description: If `true`, return the full node ID. If `false`, return the shortened node ID. deprecated: false schema: type: boolean style: form - in: query name: include_unloaded_segments description: If true, the response includes information from segments that are not loaded into memory. deprecated: false schema: type: boolean style: form - in: query name: h description: "A comma-separated list of columns names to display.\nIt supports simple wildcards.\n\nSupported values include:\n - `build` (or `b`): The Elasticsearch build hash. For example: `5c03844`.\n - `completion.size` (or `cs`, `completionSize`): The size of completion. For example: `0b`.\n - `cpu`: The percentage of recent system CPU used.\n - `disk.avail` (or `d`, `disk`, `diskAvail`): The available disk space. For example: `198.4gb`.\n - `disk.total` (or `dt`, `diskTotal`): The total disk space. For example: `458.3gb`.\n - `disk.used` (or `du`, `diskUsed`): The used disk space. For example: `259.8gb`.\n - `disk.used_percent` (or `dup`, `diskUsedPercent`): The percentage of disk space used.\n - `fielddata.evictions` (or `fe`, `fielddataEvictions`): The number of fielddata cache evictions.\n - `fielddata.memory_size` (or `fm`, `fielddataMemory`): The fielddata cache memory used. For example: `0b`.\n - `file_desc.current` (or `fdc`, `fileDescriptorCurrent`): The number of file descriptors used.\n - `file_desc.max` (or `fdm`, `fileDescriptorMax`): The maximum number of file descriptors.\n - `file_desc.percent` (or `fdp`, `fileDescriptorPercent`): The percentage of file descriptors used.\n - `flush.total` (or `ft`, `flushTotal`): The number of flushes.\n - `flush.total_time` (or `ftt`, `flushTotalTime`): The amount of time spent in flush.\n - `get.current` (or `gc`, `getCurrent`): The number of current get operations.\n - `get.exists_time` (or `geti`, `getExistsTime`): The time spent in successful get operations. For example: `14ms`.\n - `get.exists_total` (or `geto`, `getExistsTotal`): The number of successful get operations.\n - `get.missing_time` (or `gmti`, `getMissingTime`): The time spent in failed get operations. For example: `0s`.\n - `get.missing_total` (or `gmto`, `getMissingTotal`): The number of failed get operations.\n - `get.time` (or `gti`, `getTime`): The amount of time spent in get operations. For example: `14ms`.\n - `get.total` (or `gto`, `getTotal`): The number of get operations.\n - `heap.current` (or `hc`, `heapCurrent`): The used heap size. For example: `311.2mb`.\n - `heap.max` (or `hm`, `heapMax`): The total heap size. For example: `4gb`.\n - `heap.percent` (or `hp`, `heapPercent`): The used percentage of total allocated Elasticsearch JVM heap.\nThis value reflects only the Elasticsearch process running within the operating system and is the most direct indicator of its JVM, heap, or memory resource performance.\n - `http_address` (or `http`): The bound HTTP address.\n - `id` (or `nodeId`): The identifier for the node.\n - `indexing.delete_current` (or `idc`, `indexingDeleteCurrent`): The number of current deletion operations.\n - `indexing.delete_time` (or `idti`, `indexingDeleteTime`): The time spent in deletion operations. For example: `2ms`.\n - `indexing.delete_total` (or `idto`, `indexingDeleteTotal`): The number of deletion operations.\n - `indexing.index_current` (or `iic`, `indexingIndexCurrent`): The number of current indexing operations.\n - `indexing.index_failed` (or `iif`, `indexingIndexFailed`): The number of failed indexing operations.\n - `indexing.index_failed_due_to_version_conflict` (or `iifvc`, `indexingIndexFailedDueToVersionConflict`): The number of indexing operations that failed due to version conflict.\n - `indexing.index_time` (or `iiti`, `indexingIndexTime`): The time spent in indexing operations. For example: `134ms`.\n - `indexing.index_total` (or `iito`, `indexingIndexTotal`): The number of indexing operations.\n - `ip` (or `i`): The IP address.\n - `jdk` (or `j`): The Java version. For example: `1.8.0`.\n - `load_1m` (or `l`): The most recent load average. For example: `0.22`.\n - `load_5m` (or `l`): The load average for the last five minutes. For example: `0.78`.\n - `load_15m` (or `l`): The load average for the last fifteen minutes. For example: `1.24`.\n - `available_processors` (or `ap`): The number of available processors (logical CPU cores available to the JVM).\n - `mappings.total_count` (or `mtc`, `mappingsTotalCount`): The number of mappings, including runtime and object fields.\n - `mappings.total_estimated_overhead_in_bytes` (or `mteo`, `mappingsTotalEstimatedOverheadInBytes`): The estimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field.\n - `master` (or `m`): Indicates whether the node is the elected master node.\nReturned values include `*` (elected master) and `-` (not elected master).\n - `merges.current` (or `mc`, `mergesCurrent`): The number of current merge operations.\n - `merges.current_docs` (or `mcd`, `mergesCurrentDocs`): The number of current merging documents.\n - `merges.current_size` (or `mcs`, `mergesCurrentSize`): The size of current merges. For example: `0b`.\n - `merges.total` (or `mt`, `mergesTotal`): The number of completed merge operations.\n - `merges.total_docs` (or `mtd`, `mergesTotalDocs`): The number of merged documents.\n - `merges.total_size` (or `mts`, `mergesTotalSize`): The total size of merges. For example: `0b`.\n - `merges.total_time` (or `mtt`, `mergesTotalTime`): The time spent merging documents. For example: `0s`.\n - `name` (or `n`): The node name.\n - `node.role` (or `r`, `role`, `nodeRole`): The roles of the node.\nReturned values include `c` (cold node), `d` (data node), `f` (frozen node), `h` (hot node), `i` (ingest node), `l` (machine learning node), `m` (master-eligible node), `r` (remote cluster client node), `s` (content node), `t` (transform node), `v` (voting-only node), `w` (warm node), and `-` (coordinating node only).\nFor example, `dim` indicates a master-eligible data and ingest node.\n - `pid` (or `p`): The process identifier.\n - `port` (or `po`): The bound transport port number.\n - `query_cache.memory_size` (or `qcm`, `queryCacheMemory`): The used query cache memory. For example: `0b`.\n - `query_cache.evictions` (or `qce`, `queryCacheEvictions`): The number of query cache evictions.\n - `query_cache.hit_count` (or `qchc`, `queryCacheHitCount`): The query cache hit count.\n - `query_cache.miss_count` (or `qcmc`, `queryCacheMissCount`): The query cache miss count.\n - `ram.current` (or `rc`, `ramCurrent`): The used total memory. For example: `513.4mb`.\n - `ram.max` (or `rm`, `ramMax`): The total memory. For example: `2.9gb`.\n - `ram.percent` (or `rp`, `ramPercent`): The used percentage of the total operating system memory.\nThis reflects all processes running on the operating system instead of only Elasticsearch and is not guaranteed to correlate to its performance.\n - `refresh.total` (or `rto`, `refreshTotal`): The number of refresh operations.\n - `refresh.time` (or `rti`, `refreshTime`): The time spent in refresh operations. For example: `91ms`.\n - `request_cache.memory_size` (or `rcm`, `requestCacheMemory`): The used request cache memory. For example: `0b`.\n - `request_cache.evictions` (or `rce`, `requestCacheEvictions`): The number of request cache evictions.\n - `request_cache.hit_count` (or `rchc`, `requestCacheHitCount`): The request cache hit count.\n - `request_cache.miss_count` (or `rcmc`, `requestCacheMissCount`): The request cache miss count.\n - `script.compilations` (or `scrcc`, `scriptCompilations`): The number of total script compilations.\n - `script.cache_evictions` (or `scrce`, `scriptCacheEvictions`): The number of total compiled scripts evicted from cache.\n - `search.fetch_current` (or `sfc`, `searchFetchCurrent`): The number of current fetch phase operations.\n - `search.fetch_time` (or `sfti`, `searchFetchTime`): The time spent in fetch phase. For example: `37ms`.\n - `search.fetch_total` (or `sfto`, `searchFetchTotal`): The number of fetch operations.\n - `search.open_contexts` (or `so`, `searchOpenContexts`): The number of open search contexts.\n - `search.query_current` (or `sqc`, `searchQueryCurrent`): The number of current query phase operations.\n - `search.query_time` (or `sqti`, `searchQueryTime`): The time spent in query phase. For example: `43ms`.\n - `search.query_total` (or `sqto`, `searchQueryTotal`): The number of query operations.\n - `search.scroll_current` (or `scc`, `searchScrollCurrent`): The number of open scroll contexts.\n - `search.scroll_time` (or `scti`, `searchScrollTime`): The amount of time scroll contexts were held open. For example: `2m`.\n - `search.scroll_total` (or `scto`, `searchScrollTotal`): The number of completed scroll contexts.\n - `segments.count` (or `sc`, `segmentsCount`): The number of segments.\n - `segments.fixed_bitset_memory` (or `sfbm`, `fixedBitsetMemory`): The memory used by fixed bit sets for nested object field types and type filters for types referred in join fields.\nFor example: `1.0kb`.\n - `segments.index_writer_memory` (or `siwm`, `segmentsIndexWriterMemory`): The memory used by the index writer. For example: `18mb`.\n - `segments.memory` (or `sm`, `segmentsMemory`): The memory used by segments. For example: `1.4kb`.\n - `segments.version_map_memory` (or `svmm`, `segmentsVersionMapMemory`): The memory used by the version map. For example: `1.0kb`.\n - `shard_stats.total_count` (or `sstc`, `shards`, `shardStatsTotalCount`): The number of shards assigned.\n - `suggest.current` (or `suc`, `suggestCurrent`): The number of current suggest operations.\n - `suggest.time` (or `suti`, `suggestTime`): The time spent in suggest operations.\n - `suggest.total` (or `suto`, `suggestTotal`): The number of suggest operations.\n - `uptime` (or `u`): The amount of node uptime. For example: `17.3m`.\n - `version` (or `v`): The Elasticsearch version. For example: `9.0.0`.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatNodeColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.nodes.NodesRecord' examples: CatNodesResponseExample1: summary: Default columns description: 'A successful response from `GET /_cat/nodes?v=true&format=json`. The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node. The `node.role`, `master`, and `name` columns provide information useful for monitoring an entire cluster, particularly large ones. ' value: "[\n {\n \"ip\": \"127.0.0.1\",\n \"heap.percent\": \"65\",\n \"ram.percent\": \"99\",\n \"cpu\": \"42\",\n \"load_1m\": \"3.07\",\n \"load_5m\": null,\n \"load_15m\": null,\n \"node.role\": \"cdfhilmrstw\",\n \"master\": \"*\",\n \"name\": \"mJw06l1\"\n }\n]" CatNodesResponseExample2: summary: Explicit columns description: 'A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns. ' value: "[\n {\n \"id\": \"veJR\",\n \"ip\": \"127.0.0.1\",\n \"port\": \"59938\",\n \"v\": \"9.0.0\",\n \"m\": \"*\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/nodes\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: nodes.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json ' - lang: Python source: "resp = client.cat.nodes(\n v=True,\n h=\"id,ip,port,v,m\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.nodes({\n v: \"true\",\n h: \"id,ip,port,v,m\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.nodes(\n v: \"true\",\n h: \"id,ip,port,v,m\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->nodes([\n \"v\" => \"true\",\n \"h\" => \"id,ip,port,v,m\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/nodes?v=true&h=id,ip,port,v,m&format=json"' - lang: Java source: 'client.cat().nodes(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/pending_tasks: get: tags: - Cat summary: Get pending task information description: 'Get information about cluster-level changes that have not yet taken effect. 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 pending cluster tasks API.' operationId: cat-pending-tasks parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `insertOrder` (or `o`): The task insertion order.\n - `timeInQueue` (or `t`): How long the task has been in the queue.\n - `priority` (or `p`): The task priority.\n - `source` (or `s`): The task source.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatPendingTasksColumns' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.pending_tasks.PendingTasksRecord' examples: CatPendingTasksResponseExample1: description: 'A successful response from `GET /_cat/pending_tasks?v=true&h=insertOrder,timeInQueue,priority,source&format=json`. ' value: "[\n { \"insertOrder\": \"1685\", \"timeInQueue\": \"855ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1686\", \"timeInQueue\": \"843ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1693\", \"timeInQueue\": \"753ms\", \"priority\": \"HIGH\", \"source\": \"refresh-mapping [foo][[t]]\"},\n { \"insertOrder\": \"1688\", \"timeInQueue\": \"816ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1689\", \"timeInQueue\": \"802ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1690\", \"timeInQueue\": \"787ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1691\", \"timeInQueue\": \"773ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"}\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/pending_tasks\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: pending_tasks.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/pending_tasks?v=true&h=insertOrder,timeInQueue,priority,source&format=json ' - lang: Python source: "resp = client.cat.pending_tasks(\n v=True,\n h=\"insertOrder,timeInQueue,priority,source\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.pendingTasks({\n v: \"true\",\n h: \"insertOrder,timeInQueue,priority,source\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.pending_tasks(\n v: \"true\",\n h: \"insertOrder,timeInQueue,priority,source\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->pendingTasks([\n \"v\" => \"true\",\n \"h\" => \"insertOrder,timeInQueue,priority,source\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/pending_tasks?v=true&h=insertOrder,timeInQueue,priority,source&format=json"' - lang: Java source: 'client.cat().pendingTasks(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/plugins: get: tags: - Cat summary: Get plugin information description: 'Get a list of plugins running on each node of a 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 info API.' operationId: cat-plugins parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `id`: The unique node ID.\n - `name` (or `n`): The node name.\n - `component` (or `c`): The component.\n - `version` (or `v`): The component version.\n - `description` (or `d`): The plugin details.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatPluginsColumns' 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: include_bootstrap description: Include bootstrap plugins in the response deprecated: false schema: type: boolean 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.plugins.PluginsRecord' examples: CatPluginsResponseExample1: description: 'A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`. ' value: "[\n { \"name\": \"U7321H6\", \"component\": \"analysis-icu\", \"version\": \"8.17.0\", \"description\": \"The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-kuromoji\", \"verison\": \"8.17.0\", description: \"The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.\"},\n {\"name\" \"U7321H6\", \"component\": \"analysis-nori\", \"version\": \"8.17.0\", \"description\": \"The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-phonetic\", \"verison\": \"8.17.0\", \"description\": \"The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-smartcn\", \"verison\": \"8.17.0\", \"description\": \"Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-stempel\", \"verison\": \"8.17.0\", \"description\": \"The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-ukrainian\", \"verison\": \"8.17.0\", \"description\": \"The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-azure-classic\", \"verison\": \"8.17.0\", \"description\": \"The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-ec2\", \"verison\": \"8.17.0\", \"description\": \"The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-gce\", \"verison\": \"8.17.0\", \"description\": \"The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-annotated-text\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-murmur3\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-size\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Size plugin allows document to record their uncompressed size at index time.\"},\n {\"name\": \"U7321H6\", \"component\": \"store-smb\", \"verison\": \"8.17.0\", \"description\": \"The Store SMB plugin adds support for SMB stores.\"}\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/plugins\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: plugins.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json ' - lang: Python source: "resp = client.cat.plugins(\n v=True,\n s=\"component\",\n h=\"name,component,version,description\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.plugins({\n v: \"true\",\n s: \"component\",\n h: \"name,component,version,description\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.plugins(\n v: \"true\",\n s: \"component\",\n h: \"name,component,version,description\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->plugins([\n \"v\" => \"true\",\n \"s\" => \"component\",\n \"h\" => \"name,component,version,description\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/plugins?v=true&s=component&h=name,component,version,description&format=json"' - lang: Java source: 'client.cat().plugins(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/recovery: get: tags: - Cat summary: Get shard recovery information description: 'Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. 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 index recovery API.' operationId: cat-recovery parameters: - in: query name: active_only description: If `true`, the response only includes ongoing shard recoveries. deprecated: false schema: type: boolean style: form - in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. deprecated: false schema: type: boolean style: form - in: query name: index description: Comma-separated list or wildcard expression of index names to limit the returned information deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: form - in: query name: h description: "A comma-separated list of columns names to display.\nIt supports simple wildcards.\n\nSupported values include:\n - `index` (or `i`, `idx`): The index name.\n - `shard` (or `s`, `sh`): The shard name.\n - `start_time` (or `start`): The recovery start time.\n - `start_time_millis` (or `start_millis`): The recovery start time in epoch milliseconds.\n - `stop_time` (or `stop`): The recovery stop time.\n - `stop_time_millis` (or `stop_millis`): The recovery stop time in epoch milliseconds.\n - `time` (or `t`, `ti`): The recovery time.\n - `type` (or `ty`): The recovery type.\n - `stage` (or `st`): The recovery stage.\n - `source_host` (or `shost`): The source host.\n - `source_node` (or `snode`): The source node name.\n - `target_host` (or `thost`): The target host.\n - `target_node` (or `tnode`): The target node name.\n - `repository` (or `rep`): The repository.\n - `snapshot` (or `snap`): The snapshot.\n - `files` (or `f`): The number of files to recover.\n - `files_recovered` (or `fr`): The files recovered.\n - `files_percent` (or `fp`): The percent of files recovered.\n - `files_total` (or `tf`): The total number of files.\n - `bytes` (or `b`): The number of bytes to recover.\n - `bytes_recovered` (or `br`): The bytes recovered.\n - `bytes_percent` (or `bp`): The percent of bytes recovered.\n - `bytes_total` (or `tb`): The total number of bytes.\n - `translog_ops` (or `to`): The number of translog ops to recover.\n - `translog_ops_recovered` (or `tor`): The translog ops recovered.\n - `translog_ops_percent` (or `top`): The percent of translog ops recovered.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatRecoveryColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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.recovery.RecoveryRecord' examples: CatRecoveryResponseExample1: summary: No ongoing recoveries description: 'A successful response from `GET _cat/recovery?v=true&format=json`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start. ' value: "[\n {\n \"index\": \"my-index-000001 \",\n \"shard\": \"0\",\n \"time\": \"13ms\",\n \"type\": \"store\",\n \"stage\": \"done\",\n \"source_host\": \"n/a\",\n \"source_node\": \"n/a\",\n \"target_host\": \"127.0.0.1\",\n \"target_node\": \"node-0\",\n \"repository\": \"n/a\",\n \"snapshot\": \"n/a\",\n \"files\": \"0\",\n \"files_recovered\": \"0\",\n \"files_percent\": \"100.0%\",\n \"files_total\": \"13\",\n \"bytes\": \"0b\",\n \"bytes_recovered\": \"0b\",\n \"bytes_percent\": \"100.0%\",\n \"bytes_total\": \"9928b\",\n \"translog_ops\": \"0\",\n \"translog_ops_recovered\": \"0\",\n \"translog_ops_percent\": \"100.0%\"\n }\n]" CatRecoveryResponseExample2: summary: A live shard recovery description: 'A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements. ' value: "[\n {\n \"i\": \"my-index-000001\",\n \"s\": \"0\",\n \"t\": \"1252ms\",\n \"ty\": \"peer\",\n \"st\": \"done\",\n \"shost\": \"192.168.1.1\",\n \"thost\": \"192.168.1.1\",\n \"f\": \"0\",\n \"fp\": \"100.0%\",\n \"b\": \"0b\",\n \"bp\": \"100.0%\",\n }\n]" CatRecoveryResponseExample3: summary: A snapshot recovery description: 'A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery. ' value: "[\n {\n \"i\": \"my-index-000001\",\n \"s\": \"0\",\n \"t\": \"1978ms\",\n \"ty\": \"snapshot\",\n \"st\": \"done\",\n \"rep\": \"my-repo\",\n \"snap\": \"snap-1\",\n \"f\": \"79\",\n \"fp\": \"8.0%\",\n \"b\": \"12086\",\n \"bp\": \"9.0%\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/recovery\n
\n " x-req-auth: - 'Index privileges: `monitor` ' - 'Cluster privileges: `monitor` ' x-api: recovery.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/recovery?v=true&format=json ' - lang: Python source: "resp = client.cat.recovery(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.recovery({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.recovery(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->recovery([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/recovery?v=true&format=json"' - lang: Java source: 'client.cat().recovery(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/recovery/{index}: get: tags: - Cat summary: Get shard recovery information description: 'Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. 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 index recovery API.' operationId: cat-recovery-1 parameters: - in: path name: index description: 'A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: active_only description: If `true`, the response only includes ongoing shard recoveries. deprecated: false schema: type: boolean style: form - in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. deprecated: false schema: type: boolean style: form - in: query name: index description: Comma-separated list or wildcard expression of index names to limit the returned information deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: form - in: query name: h description: "A comma-separated list of columns names to display.\nIt supports simple wildcards.\n\nSupported values include:\n - `index` (or `i`, `idx`): The index name.\n - `shard` (or `s`, `sh`): The shard name.\n - `start_time` (or `start`): The recovery start time.\n - `start_time_millis` (or `start_millis`): The recovery start time in epoch milliseconds.\n - `stop_time` (or `stop`): The recovery stop time.\n - `stop_time_millis` (or `stop_millis`): The recovery stop time in epoch milliseconds.\n - `time` (or `t`, `ti`): The recovery time.\n - `type` (or `ty`): The recovery type.\n - `stage` (or `st`): The recovery stage.\n - `source_host` (or `shost`): The source host.\n - `source_node` (or `snode`): The source node name.\n - `target_host` (or `thost`): The target host.\n - `target_node` (or `tnode`): The target node name.\n - `repository` (or `rep`): The repository.\n - `snapshot` (or `snap`): The snapshot.\n - `files` (or `f`): The number of files to recover.\n - `files_recovered` (or `fr`): The files recovered.\n - `files_percent` (or `fp`): The percent of files recovered.\n - `files_total` (or `tf`): The total number of files.\n - `bytes` (or `b`): The number of bytes to recover.\n - `bytes_recovered` (or `br`): The bytes recovered.\n - `bytes_percent` (or `bp`): The percent of bytes recovered.\n - `bytes_total` (or `tb`): The total number of bytes.\n - `translog_ops` (or `to`): The number of translog ops to recover.\n - `translog_ops_recovered` (or `tor`): The translog ops recovered.\n - `translog_ops_percent` (or `top`): The percent of translog ops recovered.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatRecoveryColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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.recovery.RecoveryRecord' examples: CatRecoveryResponseExample1: summary: No ongoing recoveries description: 'A successful response from `GET _cat/recovery?v=true&format=json`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start. ' value: "[\n {\n \"index\": \"my-index-000001 \",\n \"shard\": \"0\",\n \"time\": \"13ms\",\n \"type\": \"store\",\n \"stage\": \"done\",\n \"source_host\": \"n/a\",\n \"source_node\": \"n/a\",\n \"target_host\": \"127.0.0.1\",\n \"target_node\": \"node-0\",\n \"repository\": \"n/a\",\n \"snapshot\": \"n/a\",\n \"files\": \"0\",\n \"files_recovered\": \"0\",\n \"files_percent\": \"100.0%\",\n \"files_total\": \"13\",\n \"bytes\": \"0b\",\n \"bytes_recovered\": \"0b\",\n \"bytes_percent\": \"100.0%\",\n \"bytes_total\": \"9928b\",\n \"translog_ops\": \"0\",\n \"translog_ops_recovered\": \"0\",\n \"translog_ops_percent\": \"100.0%\"\n }\n]" CatRecoveryResponseExample2: summary: A live shard recovery description: 'A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements. ' value: "[\n {\n \"i\": \"my-index-000001\",\n \"s\": \"0\",\n \"t\": \"1252ms\",\n \"ty\": \"peer\",\n \"st\": \"done\",\n \"shost\": \"192.168.1.1\",\n \"thost\": \"192.168.1.1\",\n \"f\": \"0\",\n \"fp\": \"100.0%\",\n \"b\": \"0b\",\n \"bp\": \"100.0%\",\n }\n]" CatRecoveryResponseExample3: summary: A snapshot recovery description: 'A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery. ' value: "[\n {\n \"i\": \"my-index-000001\",\n \"s\": \"0\",\n \"t\": \"1978ms\",\n \"ty\": \"snapshot\",\n \"st\": \"done\",\n \"rep\": \"my-repo\",\n \"snap\": \"snap-1\",\n \"f\": \"79\",\n \"fp\": \"8.0%\",\n \"b\": \"12086\",\n \"bp\": \"9.0%\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/recovery/{index}\n
\n " x-req-auth: - 'Index privileges: `monitor` ' - 'Cluster privileges: `monitor` ' x-api: recovery.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/recovery?v=true&format=json ' - lang: Python source: "resp = client.cat.recovery(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.recovery({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.recovery(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->recovery([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/recovery?v=true&format=json"' - lang: Java source: 'client.cat().recovery(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/repositories: get: tags: - Cat summary: Get snapshot repository information description: 'Get a list of snapshot repositories for a 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 get snapshot repository API.' operationId: cat-repositories parameters: - in: query name: h description: List of columns to appear in the response. Supports simple wildcards. deprecated: false schema: $ref: '#/components/schemas/_types.Names' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.repositories.RepositoriesRecord' examples: CatRepositoriesResponseExample1: description: 'A successful response from `GET /_cat/repositories?v=true&format=json`. ' value: "[\n {\n \"id\": \"repo1\",\n \"type\": \"fs\"\n },\n {\n \"id\": \"repo2\",\n \"type\": \"s3\"\n }\n]" x-state: Generally available; Added in 2.1.0 x-variations: - "
\n GET\n /_cat/repositories\n
\n " x-req-auth: - 'Cluster privileges: `monitor_snapshot` ' x-api: repositories.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/repositories?v=true&format=json ' - lang: Python source: "resp = client.cat.repositories(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.repositories({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.repositories(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->repositories([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/repositories?v=true&format=json"' - lang: Java source: 'client.cat().repositories(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/segments: get: tags: - Cat summary: Get segment information description: 'Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. 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 index segments API.' operationId: cat-segments parameters: - in: query name: h description: "A comma-separated list of columns names to display.\nIt supports simple wildcards.\n\nSupported values include:\n - `index` (or `i`, `idx`): The name of the index.\n - `shard` (or `s`, `sh`): The name of the shard.\n - `prirep` (or `p`, `pr`, `primaryOrReplica`): The shard type. Returned values are 'primary' or 'replica'.\n - `ip`: IP address of the segment’s shard, such as '127.0.1.1'.\n - `segment`: The name of the segment, such as '_0'. The segment name is derived from the segment generation and used internally to create file names in the directory of the shard.\n - `generation`: Generation number, such as '0'. Elasticsearch increments this generation number for each segment written. Elasticsearch then uses this number to derive the segment name.\n - `docs.count`: The number of documents as reported by Lucene. This excludes deleted documents and counts any [nested documents](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/nested) separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.\n - `docs.deleted`: The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the [automatic merge process](https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge) if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.\n - `size`: The disk space used by the segment, such as '50kb'.\n - `size.memory`: The bytes of segment data stored in memory for efficient search, such as '1264'. A value of '-1' indicates Elasticsearch was unable to compute this number.\n - `committed`: If 'true', the segments is synced to disk. Segments that are synced can survive a hard reboot. If 'false', the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.\n - `searchable`: If 'true', the segment is searchable. If 'false', the segment has most likely been written to disk but needs a [refresh](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh) to be searchable.\n - `version`: The version of Lucene used to write the segment.\n - `compound`: If 'true', the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.\n - `id`: The ID of the node, such as 'k0zy'.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatSegmentsColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form - in: query name: expand_wildcards description: "Type of index that wildcard expressions can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as open,hidden.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n" deprecated: false schema: $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: allow_no_indices description: 'If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.' deprecated: false schema: type: boolean style: form - in: query name: ignore_throttled description: If true, concrete, expanded or aliased indices are ignored when frozen. deprecated: false schema: type: boolean style: form - in: query name: ignore_unavailable description: If true, missing or closed indices are not included in the response. deprecated: false schema: type: boolean style: form - in: query name: allow_closed description: 'If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices' deprecated: false schema: type: boolean style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.segments.SegmentsRecord' examples: CatSegmentsResponseExample1: description: 'A successful response from `GET /_cat/segments?v=true&format=json`. ' value: "[\n {\n \"index\": \"test\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"ip\": \"127.0.0.1\",\n \"segment\": \"_0\",\n \"generation\": \"0\",\n \"docs.count\": \"1\",\n \"docs.deleted\": \"0\",\n \"size\": \"3kb\",\n \"size.memory\": \"0\",\n \"committed\": \"false\",\n \"searchable\": \"true\",\n \"version\": \"9.12.0\",\n \"compound\": \"true\"\n },\n {\n \"index\": \"test1\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"ip\": \"127.0.0.1\",\n \"segment\": \"_0\",\n \"generation\": \"0\",\n \"docs.count\": \"1\",\n \"docs.deleted\": \"0\",\n \"size\": \"3kb\",\n \"size.memory\": \"0\",\n \"committed\": \"false\",\n \"searchable\": \"true\",\n \"version\": \"9.12.0\",\n \"compound\": \"true\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/segments\n
\n " x-req-auth: - 'Index privileges: `monitor` ' - 'Cluster privileges: `monitor` ' x-api: segments.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/segments?v=true&format=json ' - lang: Python source: "resp = client.cat.segments(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.segments({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.segments(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->segments([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/segments?v=true&format=json"' - lang: Java source: 'client.cat().segments(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/segments/{index}: get: tags: - Cat summary: Get segment information description: 'Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. 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 index segments API.' operationId: cat-segments-1 parameters: - in: path name: index description: 'A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: h description: "A comma-separated list of columns names to display.\nIt supports simple wildcards.\n\nSupported values include:\n - `index` (or `i`, `idx`): The name of the index.\n - `shard` (or `s`, `sh`): The name of the shard.\n - `prirep` (or `p`, `pr`, `primaryOrReplica`): The shard type. Returned values are 'primary' or 'replica'.\n - `ip`: IP address of the segment’s shard, such as '127.0.1.1'.\n - `segment`: The name of the segment, such as '_0'. The segment name is derived from the segment generation and used internally to create file names in the directory of the shard.\n - `generation`: Generation number, such as '0'. Elasticsearch increments this generation number for each segment written. Elasticsearch then uses this number to derive the segment name.\n - `docs.count`: The number of documents as reported by Lucene. This excludes deleted documents and counts any [nested documents](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/nested) separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.\n - `docs.deleted`: The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the [automatic merge process](https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge) if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.\n - `size`: The disk space used by the segment, such as '50kb'.\n - `size.memory`: The bytes of segment data stored in memory for efficient search, such as '1264'. A value of '-1' indicates Elasticsearch was unable to compute this number.\n - `committed`: If 'true', the segments is synced to disk. Segments that are synced can survive a hard reboot. If 'false', the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.\n - `searchable`: If 'true', the segment is searchable. If 'false', the segment has most likely been written to disk but needs a [refresh](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh) to be searchable.\n - `version`: The version of Lucene used to write the segment.\n - `compound`: If 'true', the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.\n - `id`: The ID of the node, such as 'k0zy'.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatSegmentsColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form - in: query name: expand_wildcards description: "Type of index that wildcard expressions can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as open,hidden.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n" deprecated: false schema: $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: allow_no_indices description: 'If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.' deprecated: false schema: type: boolean style: form - in: query name: ignore_throttled description: If true, concrete, expanded or aliased indices are ignored when frozen. deprecated: false schema: type: boolean style: form - in: query name: ignore_unavailable description: If true, missing or closed indices are not included in the response. deprecated: false schema: type: boolean style: form - in: query name: allow_closed description: 'If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices' deprecated: false schema: type: boolean style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.segments.SegmentsRecord' examples: CatSegmentsResponseExample1: description: 'A successful response from `GET /_cat/segments?v=true&format=json`. ' value: "[\n {\n \"index\": \"test\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"ip\": \"127.0.0.1\",\n \"segment\": \"_0\",\n \"generation\": \"0\",\n \"docs.count\": \"1\",\n \"docs.deleted\": \"0\",\n \"size\": \"3kb\",\n \"size.memory\": \"0\",\n \"committed\": \"false\",\n \"searchable\": \"true\",\n \"version\": \"9.12.0\",\n \"compound\": \"true\"\n },\n {\n \"index\": \"test1\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"ip\": \"127.0.0.1\",\n \"segment\": \"_0\",\n \"generation\": \"0\",\n \"docs.count\": \"1\",\n \"docs.deleted\": \"0\",\n \"size\": \"3kb\",\n \"size.memory\": \"0\",\n \"committed\": \"false\",\n \"searchable\": \"true\",\n \"version\": \"9.12.0\",\n \"compound\": \"true\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/segments/{index}\n
\n " x-req-auth: - 'Index privileges: `monitor` ' - 'Cluster privileges: `monitor` ' x-api: segments.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/segments?v=true&format=json ' - lang: Python source: "resp = client.cat.segments(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.segments({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.segments(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->segments([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/segments?v=true&format=json"' - lang: Java source: 'client.cat().segments(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/shards: get: tags: - Cat summary: Get shard information description: 'Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.' operationId: cat-shards parameters: - in: query name: h description: "List of columns to appear in the response. Supports simple wildcards.\n\nSupported values include:\n - `completion.size` (or `cs`, `completionSize`): Size of completion. For example: `0b`.\n - `dataset.size`: Disk space used by the shard’s dataset, which may or may not be the size on\ndisk, but includes space used by the shard on object storage. Reported as a size value for example: `5kb`.\n - `dense_vector.value_count` (or `dvc`, `denseVectorCount`): Number of indexed dense vectors.\n - `docs` (or `d`, `dc`): Number of documents in shard, for example: `25`.\n - `fielddata.evictions` (or `fe`, `fielddataEvictions`): Fielddata cache evictions, for example: `0`.\n - `fielddata.memory_size` (or `fm`, `fielddataMemory`): Used fielddata cache memory, for example: `0b`.\n - `flush.total` (or `ft`, `flushTotal`): Number of flushes, for example: `1`.\n - `flush.total_time` (or `ftt`, `flushTotalTime`): Time spent in flush, for example: `1`.\n - `get.current` (or `gc`, `getCurrent`): Number of current get operations, for example: `0`.\n - `get.exists_time` (or `geti`, `getExistsTime`): Time spent in successful gets, for example: `14ms`.\n - `get.exists_total` (or `geto`, `getExistsTotal`): Number of successful get operations, for example: `2`.\n - `get.missing_time` (or `gmti`, `getMissingTime`): Time spent in failed gets, for example: `0s`.\n - `get.missing_total` (or `gmto`, `getMissingTotal`): Number of failed get operations, for example: `1`.\n - `get.time` (or `gti`, `getTime`): Time spent in get, for example: `14ms`.\n - `get.total` (or `gto`, `getTotal`): Number of get operations, for example: `2`.\n - `id`: ID of the node, for example: `k0zy`.\n - `index` (or `i`, `idx`): Name of the index.\n - `indexing.delete_current` (or `idc`, `indexingDeleteCurrent`): Number of current deletion operations, for example: `0`.\n - `indexing.delete_time` (or `idti`, `indexingDeleteTime`): Time spent in deletions, for example: `2ms`.\n - `indexing.delete_total` (or `idto`, `indexingDeleteTotal`): Number of deletion operations, for example: `2`.\n - `indexing.index_current` (or `iic`, `indexingIndexCurrent`): Number of current indexing operations, for example: `0`.\n - `indexing.index_failed_due_to_version_conflict` (or `iifvc`, `indexingIndexFailedDueToVersionConflict`): Number of failed indexing operations due to version conflict, for example: `0`.\n - `indexing.index_failed` (or `iif`, `indexingIndexFailed`): Number of failed indexing operations, for example: `0`.\n - `indexing.index_time` (or `iiti`, `indexingIndexTime`): Time spent in indexing, such as for example: `134ms`.\n - `indexing.index_total` (or `iito`, `indexingIndexTotal`): Number of indexing operations, for example: `1`.\n - `ip`: IP address of the node, for example: `127.0.1.1`.\n - `merges.current` (or `mc`, `mergesCurrent`): Number of current merge operations, for example: `0`.\n - `merges.current_docs` (or `mcd`, `mergesCurrentDocs`): Number of current merging documents, for example: `0`.\n - `merges.current_size` (or `mcs`, `mergesCurrentSize`): Size of current merges, for example: `0b`.\n - `merges.total` (or `mt`, `mergesTotal`): Number of completed merge operations, for example: `0`.\n - `merges.total_docs` (or `mtd`, `mergesTotalDocs`): Number of merged documents, for example: `0`.\n - `merges.total_size` (or `mts`, `mergesTotalSize`): Size of current merges, for example: `0b`.\n - `merges.total_time` (or `mtt`, `mergesTotalTime`): Time spent merging documents, for example: `0s`.\n - `node` (or `n`): Node name, for example: `I8hydUG`.\n - `prirep` (or `p`, `pr`, `primaryOrReplica`): Shard type. Returned values are `primary` or `replica`.\n - `query_cache.evictions` (or `qce`, `queryCacheEvictions`): Query cache evictions, for example: `0`.\n - `query_cache.memory_size` (or `qcm`, `queryCacheMemory`): Used query cache memory, for example: `0b`.\n - `recoverysource.type` (or `rs`): Type of recovery source.\n - `refresh.time` (or `rti`, `refreshTime`): Time spent in refreshes, for example: `91ms`.\n - `refresh.total` (or `rto`, `refreshTotal`): Number of refreshes, for example: `16`.\n - `search.fetch_current` (or `sfc`, `searchFetchCurrent`): Current fetch phase operations, for example: `0`.\n - `search.fetch_time` (or `sfti`, `searchFetchTime`): Time spent in fetch phase, for example: `37ms`.\n - `search.fetch_total` (or `sfto`, `searchFetchTotal`): Number of fetch operations, for example: `7`.\n - `search.open_contexts` (or `so`, `searchOpenContexts`): Open search contexts, for example: `0`.\n - `search.query_current` (or `sqc`, `searchQueryCurrent`): Current query phase operations, for example: `0`.\n - `search.query_time` (or `sqti`, `searchQueryTime`): Time spent in query phase, for example: `43ms`.\n - `search.query_total` (or `sqto`, `searchQueryTotal`): Number of query operations, for example: `9`.\n - `search.scroll_current` (or `scc`, `searchScrollCurrent`): Open scroll contexts, for example: `2`.\n - `search.scroll_time` (or `scti`, `searchScrollTime`): Time scroll contexts held open, for example: `2m`.\n - `search.scroll_total` (or `scto`, `searchScrollTotal`): Completed scroll contexts, for example: `1`.\n - `segments.count` (or `sc`, `segmentsCount`): Number of segments, for example: `4`.\n - `segments.fixed_bitset_memory` (or `sfbm`, `fixedBitsetMemory`): Memory used by fixed bit sets for nested object field types and type filters for types referred in join fields, for example: `1.0kb`.\n - `segments.index_writer_memory` (or `siwm`, `segmentsIndexWriterMemory`): Memory used by index writer, for example: `18mb`.\n - `segments.memory` (or `sm`, `segmentsMemory`): Memory used by segments, for example: `1.4kb`.\n - `segments.version_map_memory` (or `svmm`, `segmentsVersionMapMemory`): Memory used by version map, for example: `1.0kb`.\n - `seq_no.global_checkpoint` (or `sqg`, `globalCheckpoint`): Global checkpoint.\n - `seq_no.local_checkpoint` (or `sql`, `localCheckpoint`): Local checkpoint.\n - `seq_no.max` (or `sqm`, `maxSeqNo`): Maximum sequence number.\n - `shard` (or `s`, `sh`): Name of the shard.\n - `dsparse_vector.value_count` (or `svc`, `sparseVectorCount`): Number of indexed [sparse vectors](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/sparse-vector).\n - `state` (or `st`): State of the shard. Returned values are:\n* `INITIALIZING`: The shard is recovering from a peer shard or gateway.\n* `RELOCATING`: The shard is relocating.\n* `STARTED`: The shard has started.\n* `UNASSIGNED`: The shard is not assigned to any node.\n - `store` (or `sto`): Disk space used by the shard, for example: `5kb`.\n - `suggest.current` (or `suc`, `suggestCurrent`): Number of current suggest operations, for example: `0`.\n - `suggest.time` (or `suti`, `suggestTime`): Time spent in suggest, for example: `0`.\n - `suggest.total` (or `suto`, `suggestTotal`): Number of suggest operations, for example: `0`.\n - `sync_id`: Sync ID of the shard.\n - `unassigned.at` (or `ua`): Time at which the shard became unassigned in [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/List_of_UTC_offsets).\n - `unassigned.details` (or `ud`): Details about why the shard became unassigned. This does not explain why the shard is currently unassigned. To understand why a shard\nis not assigned, use the [Cluster allocation explain](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain) API.\n - `unassigned.for` (or `uf`): Time at which the shard was requested to be unassigned in [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/List_of_UTC_offsets).\n - `unassigned.reason` (or `ur`): Indicates the reason for the last change to the state of this unassigned shard. This does not explain why the shard is currently unassigned.\nTo understand why a shard is not assigned, use the [Cluster allocation explain](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain) API. Returned values include:\n\n* `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard.\n* `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery.\n* `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index.\n* `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index.\n* `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the Cluster reroute API.\n* `INDEX_CLOSED`: Unassigned because the index was closed.\n* `INDEX_CREATED`: Unassigned as a result of an API creation of an index.\n* `INDEX_REOPENED`: Unassigned as a result of opening a closed index.\n* `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the Cluster reroute API.\n* `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.\n* `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster.\n* `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the Node shutdown API.\n* `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed.\n* `REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled.\n* `REINITIALIZED`: When a shard moves from started back to initializing.\n* `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.\n* `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatShardColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.shards.ShardsRecord' examples: CatShardsResponseExample1: summary: A single data stream or index description: 'A successful response from `GET _cat/shards?format=json`. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n }\n]" CatShardsResponseExample2: summary: A wildcard pattern description: 'A successful response from `GET _cat/shards/my-index-*?format=json`. It returns information for any data streams or indices beginning with `my-index-`. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n }\n]" CatShardsResponseExample3: summary: A relocating shard description: 'A successful response from `GET _cat/shards?format=json`. The `RELOCATING` value in the `state` column indicates the index shard is relocating. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"RELOCATING\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA -> -> 192.168.56.30 bGG90GE\"\n }\n]" CatShardsResponseExample4: summary: Shard states description: 'A successful response from `GET _cat/shards?format=json`. Before a shard is available for use, it goes through an `INITIALIZING` state. You can use the cat shards API to see which shards are initializing. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"INITIALIZING\",\n \"docs\": \"0\",\n \"store\": \"14.3mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.30\",\n \"node\": \"bGG90GE\"\n }\n]" CatShardsResponseExample5: summary: Reasons for unassigned shards description: 'A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.10 H5dfFeA\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.30 bGG90GE\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.20 I8hydUG\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"UNASSIGNED\",\n \"unassigned.reason\": \"ALLOCATION_FAILED\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/shards\n
\n " x-req-auth: - 'Index privileges: `monitor` ' - 'Cluster privileges: `monitor` ' x-api: shards.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/shards?format=json ' - lang: Python source: "resp = client.cat.shards(\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.shards({\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.shards(\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->shards([\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/shards?format=json"' - lang: Java source: 'client.cat().shards(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/shards/{index}: get: tags: - Cat summary: Get shard information description: 'Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.' operationId: cat-shards-1 parameters: - in: path name: index description: 'A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: h description: "List of columns to appear in the response. Supports simple wildcards.\n\nSupported values include:\n - `completion.size` (or `cs`, `completionSize`): Size of completion. For example: `0b`.\n - `dataset.size`: Disk space used by the shard’s dataset, which may or may not be the size on\ndisk, but includes space used by the shard on object storage. Reported as a size value for example: `5kb`.\n - `dense_vector.value_count` (or `dvc`, `denseVectorCount`): Number of indexed dense vectors.\n - `docs` (or `d`, `dc`): Number of documents in shard, for example: `25`.\n - `fielddata.evictions` (or `fe`, `fielddataEvictions`): Fielddata cache evictions, for example: `0`.\n - `fielddata.memory_size` (or `fm`, `fielddataMemory`): Used fielddata cache memory, for example: `0b`.\n - `flush.total` (or `ft`, `flushTotal`): Number of flushes, for example: `1`.\n - `flush.total_time` (or `ftt`, `flushTotalTime`): Time spent in flush, for example: `1`.\n - `get.current` (or `gc`, `getCurrent`): Number of current get operations, for example: `0`.\n - `get.exists_time` (or `geti`, `getExistsTime`): Time spent in successful gets, for example: `14ms`.\n - `get.exists_total` (or `geto`, `getExistsTotal`): Number of successful get operations, for example: `2`.\n - `get.missing_time` (or `gmti`, `getMissingTime`): Time spent in failed gets, for example: `0s`.\n - `get.missing_total` (or `gmto`, `getMissingTotal`): Number of failed get operations, for example: `1`.\n - `get.time` (or `gti`, `getTime`): Time spent in get, for example: `14ms`.\n - `get.total` (or `gto`, `getTotal`): Number of get operations, for example: `2`.\n - `id`: ID of the node, for example: `k0zy`.\n - `index` (or `i`, `idx`): Name of the index.\n - `indexing.delete_current` (or `idc`, `indexingDeleteCurrent`): Number of current deletion operations, for example: `0`.\n - `indexing.delete_time` (or `idti`, `indexingDeleteTime`): Time spent in deletions, for example: `2ms`.\n - `indexing.delete_total` (or `idto`, `indexingDeleteTotal`): Number of deletion operations, for example: `2`.\n - `indexing.index_current` (or `iic`, `indexingIndexCurrent`): Number of current indexing operations, for example: `0`.\n - `indexing.index_failed_due_to_version_conflict` (or `iifvc`, `indexingIndexFailedDueToVersionConflict`): Number of failed indexing operations due to version conflict, for example: `0`.\n - `indexing.index_failed` (or `iif`, `indexingIndexFailed`): Number of failed indexing operations, for example: `0`.\n - `indexing.index_time` (or `iiti`, `indexingIndexTime`): Time spent in indexing, such as for example: `134ms`.\n - `indexing.index_total` (or `iito`, `indexingIndexTotal`): Number of indexing operations, for example: `1`.\n - `ip`: IP address of the node, for example: `127.0.1.1`.\n - `merges.current` (or `mc`, `mergesCurrent`): Number of current merge operations, for example: `0`.\n - `merges.current_docs` (or `mcd`, `mergesCurrentDocs`): Number of current merging documents, for example: `0`.\n - `merges.current_size` (or `mcs`, `mergesCurrentSize`): Size of current merges, for example: `0b`.\n - `merges.total` (or `mt`, `mergesTotal`): Number of completed merge operations, for example: `0`.\n - `merges.total_docs` (or `mtd`, `mergesTotalDocs`): Number of merged documents, for example: `0`.\n - `merges.total_size` (or `mts`, `mergesTotalSize`): Size of current merges, for example: `0b`.\n - `merges.total_time` (or `mtt`, `mergesTotalTime`): Time spent merging documents, for example: `0s`.\n - `node` (or `n`): Node name, for example: `I8hydUG`.\n - `prirep` (or `p`, `pr`, `primaryOrReplica`): Shard type. Returned values are `primary` or `replica`.\n - `query_cache.evictions` (or `qce`, `queryCacheEvictions`): Query cache evictions, for example: `0`.\n - `query_cache.memory_size` (or `qcm`, `queryCacheMemory`): Used query cache memory, for example: `0b`.\n - `recoverysource.type` (or `rs`): Type of recovery source.\n - `refresh.time` (or `rti`, `refreshTime`): Time spent in refreshes, for example: `91ms`.\n - `refresh.total` (or `rto`, `refreshTotal`): Number of refreshes, for example: `16`.\n - `search.fetch_current` (or `sfc`, `searchFetchCurrent`): Current fetch phase operations, for example: `0`.\n - `search.fetch_time` (or `sfti`, `searchFetchTime`): Time spent in fetch phase, for example: `37ms`.\n - `search.fetch_total` (or `sfto`, `searchFetchTotal`): Number of fetch operations, for example: `7`.\n - `search.open_contexts` (or `so`, `searchOpenContexts`): Open search contexts, for example: `0`.\n - `search.query_current` (or `sqc`, `searchQueryCurrent`): Current query phase operations, for example: `0`.\n - `search.query_time` (or `sqti`, `searchQueryTime`): Time spent in query phase, for example: `43ms`.\n - `search.query_total` (or `sqto`, `searchQueryTotal`): Number of query operations, for example: `9`.\n - `search.scroll_current` (or `scc`, `searchScrollCurrent`): Open scroll contexts, for example: `2`.\n - `search.scroll_time` (or `scti`, `searchScrollTime`): Time scroll contexts held open, for example: `2m`.\n - `search.scroll_total` (or `scto`, `searchScrollTotal`): Completed scroll contexts, for example: `1`.\n - `segments.count` (or `sc`, `segmentsCount`): Number of segments, for example: `4`.\n - `segments.fixed_bitset_memory` (or `sfbm`, `fixedBitsetMemory`): Memory used by fixed bit sets for nested object field types and type filters for types referred in join fields, for example: `1.0kb`.\n - `segments.index_writer_memory` (or `siwm`, `segmentsIndexWriterMemory`): Memory used by index writer, for example: `18mb`.\n - `segments.memory` (or `sm`, `segmentsMemory`): Memory used by segments, for example: `1.4kb`.\n - `segments.version_map_memory` (or `svmm`, `segmentsVersionMapMemory`): Memory used by version map, for example: `1.0kb`.\n - `seq_no.global_checkpoint` (or `sqg`, `globalCheckpoint`): Global checkpoint.\n - `seq_no.local_checkpoint` (or `sql`, `localCheckpoint`): Local checkpoint.\n - `seq_no.max` (or `sqm`, `maxSeqNo`): Maximum sequence number.\n - `shard` (or `s`, `sh`): Name of the shard.\n - `dsparse_vector.value_count` (or `svc`, `sparseVectorCount`): Number of indexed [sparse vectors](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/sparse-vector).\n - `state` (or `st`): State of the shard. Returned values are:\n* `INITIALIZING`: The shard is recovering from a peer shard or gateway.\n* `RELOCATING`: The shard is relocating.\n* `STARTED`: The shard has started.\n* `UNASSIGNED`: The shard is not assigned to any node.\n - `store` (or `sto`): Disk space used by the shard, for example: `5kb`.\n - `suggest.current` (or `suc`, `suggestCurrent`): Number of current suggest operations, for example: `0`.\n - `suggest.time` (or `suti`, `suggestTime`): Time spent in suggest, for example: `0`.\n - `suggest.total` (or `suto`, `suggestTotal`): Number of suggest operations, for example: `0`.\n - `sync_id`: Sync ID of the shard.\n - `unassigned.at` (or `ua`): Time at which the shard became unassigned in [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/List_of_UTC_offsets).\n - `unassigned.details` (or `ud`): Details about why the shard became unassigned. This does not explain why the shard is currently unassigned. To understand why a shard\nis not assigned, use the [Cluster allocation explain](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain) API.\n - `unassigned.for` (or `uf`): Time at which the shard was requested to be unassigned in [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/List_of_UTC_offsets).\n - `unassigned.reason` (or `ur`): Indicates the reason for the last change to the state of this unassigned shard. This does not explain why the shard is currently unassigned.\nTo understand why a shard is not assigned, use the [Cluster allocation explain](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain) API. Returned values include:\n\n* `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard.\n* `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery.\n* `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index.\n* `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index.\n* `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the Cluster reroute API.\n* `INDEX_CLOSED`: Unassigned because the index was closed.\n* `INDEX_CREATED`: Unassigned as a result of an API creation of an index.\n* `INDEX_REOPENED`: Unassigned as a result of opening a closed index.\n* `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the Cluster reroute API.\n* `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.\n* `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster.\n* `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the Node shutdown API.\n* `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed.\n* `REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled.\n* `REINITIALIZED`: When a shard moves from started back to initializing.\n* `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.\n* `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatShardColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.shards.ShardsRecord' examples: CatShardsResponseExample1: summary: A single data stream or index description: 'A successful response from `GET _cat/shards?format=json`. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n }\n]" CatShardsResponseExample2: summary: A wildcard pattern description: 'A successful response from `GET _cat/shards/my-index-*?format=json`. It returns information for any data streams or indices beginning with `my-index-`. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n }\n]" CatShardsResponseExample3: summary: A relocating shard description: 'A successful response from `GET _cat/shards?format=json`. The `RELOCATING` value in the `state` column indicates the index shard is relocating. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"RELOCATING\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA -> -> 192.168.56.30 bGG90GE\"\n }\n]" CatShardsResponseExample4: summary: Shard states description: 'A successful response from `GET _cat/shards?format=json`. Before a shard is available for use, it goes through an `INITIALIZING` state. You can use the cat shards API to see which shards are initializing. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"INITIALIZING\",\n \"docs\": \"0\",\n \"store\": \"14.3mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.30\",\n \"node\": \"bGG90GE\"\n }\n]" CatShardsResponseExample5: summary: Reasons for unassigned shards description: 'A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned. ' value: "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.10 H5dfFeA\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.30 bGG90GE\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.20 I8hydUG\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"UNASSIGNED\",\n \"unassigned.reason\": \"ALLOCATION_FAILED\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/shards/{index}\n
\n " x-req-auth: - 'Index privileges: `monitor` ' - 'Cluster privileges: `monitor` ' x-api: shards.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/shards?format=json ' - lang: Python source: "resp = client.cat.shards(\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.shards({\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.shards(\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->shards([\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/shards?format=json"' - lang: Java source: 'client.cat().shards(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/snapshots: get: tags: - Cat summary: Get snapshot information description: 'Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch 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 get snapshot API.' operationId: cat-snapshots parameters: - in: query name: ignore_unavailable description: If `true`, the response does not include information from unavailable snapshots. deprecated: false schema: type: boolean style: form - in: query name: h description: "A comma-separated list of columns names to display.\nIt supports simple wildcards.\n\nSupported values include:\n - `id` (or `snapshot`): The ID of the snapshot, such as 'snap1'.\n - `repository` (or `re`, `repo`): The name of the repository, such as 'repo1'.\n - `status` (or `s`): State of the snapshot process. Returned values are: 'FAILED': The snapshot process failed. 'INCOMPATIBLE': The snapshot process is incompatible with the current cluster version. 'IN_PROGRESS': The snapshot process started but has not completed. 'PARTIAL': The snapshot process completed with a partial success. 'SUCCESS': The snapshot process completed with a full success.\n - `start_epoch` (or `ste`, `startEpoch`): The [unix epoch time](https://en.wikipedia.org/wiki/Unix_time) at which the snapshot process started.\n - `start_time` (or `sti`, `startTime`): 'HH:MM:SS' time at which the snapshot process started.\n - `end_epoch` (or `ete`, `endEpoch`): The [unix epoch time](https://en.wikipedia.org/wiki/Unix_time) at which the snapshot process ended.\n - `end_time` (or `eti`, `endTime`): 'HH:MM:SS' time at which the snapshot process ended.\n - `duration` (or `dur`): The time it took the snapshot process to complete in [time units](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units).\n - `indices` (or `i`): The number of indices in the snapshot.\n - `successful_shards` (or `ss`): The number of successful shards in the snapshot.\n - `failed_shards` (or `fs`): The number of failed shards in the snapshot.\n - `total_shards` (or `ts`): The total number of shards in the snapshot.\n - `reason` (or `r`): The reason for any snapshot failures.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatSnapshotsColumns' 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: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.snapshots.SnapshotsRecord' examples: CatSnapshotsResponseExample1: description: 'A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`. ' value: "[\n {\n \"id\": \"snap1\",\n \"repository\": \"repo1\",\n \"status\": \"FAILED\",\n \"start_epoch\": \"1445616705\",\n \"start_time\": \"18:11:45\",\n \"end_epoch\": \"1445616978\",\n \"end_time\": \"18:16:18\",\n \"duration\": \"4.6m\",\n \"indices\": \"1\",\n \"successful_shards\": \"4\",\n \"failed_shards\": \"1\",\n \"total_shards\": \"5\"\n },\n {\n \"id\": \"snap2\",\n \"repository\": \"repo1\",\n \"status\": \"SUCCESS\",\n \"start_epoch\": \"1445634298\",\n \"start_time\": \"23:04:58\",\n \"end_epoch\": \"1445634672\",\n \"end_time\": \"23:11:12\",\n \"duration\": \"6.2m\",\n \"indices\": \"2\",\n \"successful_shards\": \"10\",\n \"failed_shards\": \"0\",\n \"total_shards\": \"10\"\n }\n]" x-state: Generally available; Added in 2.1.0 x-variations: - "
\n GET\n /_cat/snapshots\n
\n " x-req-auth: - 'Cluster privileges: `monitor_snapshot` ' x-api: snapshots.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/snapshots/repo1?v=true&s=id&format=json ' - lang: Python source: "resp = client.cat.snapshots(\n repository=\"repo1\",\n v=True,\n s=\"id\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.snapshots({\n repository: \"repo1\",\n v: \"true\",\n s: \"id\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.snapshots(\n repository: \"repo1\",\n v: \"true\",\n s: \"id\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->snapshots([\n \"repository\" => \"repo1\",\n \"v\" => \"true\",\n \"s\" => \"id\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/snapshots/repo1?v=true&s=id&format=json"' - lang: Java source: 'client.cat().snapshots(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/snapshots/{repository}: get: tags: - Cat summary: Get snapshot information description: 'Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch 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 get snapshot API.' operationId: cat-snapshots-1 parameters: - in: path name: repository description: 'A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, Elasticsearch returns an error.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple - in: query name: ignore_unavailable description: If `true`, the response does not include information from unavailable snapshots. deprecated: false schema: type: boolean style: form - in: query name: h description: "A comma-separated list of columns names to display.\nIt supports simple wildcards.\n\nSupported values include:\n - `id` (or `snapshot`): The ID of the snapshot, such as 'snap1'.\n - `repository` (or `re`, `repo`): The name of the repository, such as 'repo1'.\n - `status` (or `s`): State of the snapshot process. Returned values are: 'FAILED': The snapshot process failed. 'INCOMPATIBLE': The snapshot process is incompatible with the current cluster version. 'IN_PROGRESS': The snapshot process started but has not completed. 'PARTIAL': The snapshot process completed with a partial success. 'SUCCESS': The snapshot process completed with a full success.\n - `start_epoch` (or `ste`, `startEpoch`): The [unix epoch time](https://en.wikipedia.org/wiki/Unix_time) at which the snapshot process started.\n - `start_time` (or `sti`, `startTime`): 'HH:MM:SS' time at which the snapshot process started.\n - `end_epoch` (or `ete`, `endEpoch`): The [unix epoch time](https://en.wikipedia.org/wiki/Unix_time) at which the snapshot process ended.\n - `end_time` (or `eti`, `endTime`): 'HH:MM:SS' time at which the snapshot process ended.\n - `duration` (or `dur`): The time it took the snapshot process to complete in [time units](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units).\n - `indices` (or `i`): The number of indices in the snapshot.\n - `successful_shards` (or `ss`): The number of successful shards in the snapshot.\n - `failed_shards` (or `fs`): The number of failed shards in the snapshot.\n - `total_shards` (or `ts`): The total number of shards in the snapshot.\n - `reason` (or `r`): The reason for any snapshot failures.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatSnapshotsColumns' 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: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.snapshots.SnapshotsRecord' examples: CatSnapshotsResponseExample1: description: 'A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`. ' value: "[\n {\n \"id\": \"snap1\",\n \"repository\": \"repo1\",\n \"status\": \"FAILED\",\n \"start_epoch\": \"1445616705\",\n \"start_time\": \"18:11:45\",\n \"end_epoch\": \"1445616978\",\n \"end_time\": \"18:16:18\",\n \"duration\": \"4.6m\",\n \"indices\": \"1\",\n \"successful_shards\": \"4\",\n \"failed_shards\": \"1\",\n \"total_shards\": \"5\"\n },\n {\n \"id\": \"snap2\",\n \"repository\": \"repo1\",\n \"status\": \"SUCCESS\",\n \"start_epoch\": \"1445634298\",\n \"start_time\": \"23:04:58\",\n \"end_epoch\": \"1445634672\",\n \"end_time\": \"23:11:12\",\n \"duration\": \"6.2m\",\n \"indices\": \"2\",\n \"successful_shards\": \"10\",\n \"failed_shards\": \"0\",\n \"total_shards\": \"10\"\n }\n]" x-state: Generally available; Added in 2.1.0 x-variations: - "
\n GET\n /_cat/snapshots/{repository}\n
\n " x-req-auth: - 'Cluster privileges: `monitor_snapshot` ' x-api: snapshots.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/snapshots/repo1?v=true&s=id&format=json ' - lang: Python source: "resp = client.cat.snapshots(\n repository=\"repo1\",\n v=True,\n s=\"id\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.snapshots({\n repository: \"repo1\",\n v: \"true\",\n s: \"id\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.snapshots(\n repository: \"repo1\",\n v: \"true\",\n s: \"id\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->snapshots([\n \"repository\" => \"repo1\",\n \"v\" => \"true\",\n \"s\" => \"id\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/snapshots/repo1?v=true&s=id&format=json"' - lang: Java source: 'client.cat().snapshots(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/tasks: get: tags: - Cat summary: Get task information description: 'Get information about tasks currently running 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 task management API.' operationId: cat-tasks parameters: - in: query name: actions description: The task action names, which are used to limit the response. deprecated: false schema: type: array items: type: string style: form - in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. deprecated: false schema: type: boolean style: form - in: query name: nodes description: Unique node identifiers, which are used to limit the response. deprecated: false schema: type: array items: type: string style: form - in: query name: parent_task_id description: The parent task identifier, which is used to limit the response. deprecated: false schema: type: string style: form - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `id`: The ID of the task with the node.\n - `action` (or `ac`): The task action.\n - `task_id` (or `ti`): The unique task ID.\n - `parent_task_id` (or `pti`): The parent task ID.\n - `type` (or `ty`): The task type.\n - `start_time` (or `start`): The start time in milliseconds.\n - `timestamp` (or `ts`, `hms`, `hhmmss`): The start time in HH:MM:SS.\n - `running_time_ns` (or `time`): The running time in nanoseconds.\n - `running_time` (or `time`): The running time.\n - `node_id` (or `ni`): The unique node ID.\n - `ip` (or `i`): The IP address.\n - `port` (or `po`): The bound transport port.\n - `node` (or `n`): The node name.\n - `version` (or `v`): The Elasticsearch version.\n - `x_opaque_id` (or `x`): The X-Opaque-ID header.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTasksColumns' 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: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form - in: query name: wait_for_completion description: If `true`, the request blocks until the task has completed. deprecated: false schema: type: boolean style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.tasks.TasksRecord' examples: CatTasksResponseExample1: description: A successful response from `GET _cat/tasks?v=true&format=json`. value: "[\n {\n \"action\": \"cluster:monitor/tasks/lists[n]\",\n \"task_id\": \"oTUltX4IQMOUUVeiohTt8A:124\",\n \"parent_task_id\": \"oTUltX4IQMOUUVeiohTt8A:123\",\n \"type\": \"direct\",\n \"start_time\": \"1458585884904\",\n \"timestamp\": \"01:48:24\",\n \"running_time\": \"44.1micros\",\n \"ip\": \"127.0.0.1:9300\",\n \"node\": \"oTUltX4IQMOUUVeiohTt8A\"\n },\n {\n \"action\": \"cluster:monitor/tasks/lists\",\n \"task_id\": \"oTUltX4IQMOUUVeiohTt8A:123\",\n \"parent_task_id\": \"-\",\n \"type\": \"transport\",\n \"start_time\": \"1458585884904\",\n \"timestamp\": \"01:48:24\",\n \"running_time\": \"186.2micros\",\n \"ip\": \"127.0.0.1:9300\",\n \"node\": \"oTUltX4IQMOUUVeiohTt8A\"\n }\n]" x-state: Technical preview; Added in 5.0.0 x-variations: - "
\n GET\n /_cat/tasks\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: tasks.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/tasks?v=true&format=json ' - lang: Python source: "resp = client.cat.tasks(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.tasks({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.tasks(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->tasks([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/tasks?v=true&format=json"' - lang: Java source: 'client.cat().tasks(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/templates: get: tags: - Cat summary: Get index template information description: 'Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. 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 index template API.' operationId: cat-templates parameters: - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `name` (or `n`): The template name.\n - `index_patterns` (or `t`): The template index patterns.\n - `order` (or `o`, `p`): The template application order or priority number.\n - `version` (or `v`): The version.\n - `composed_of` (or `c`): The component templates comprising the index template.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTemplatesColumns' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.templates.TemplatesRecord' examples: CatTemplatesResponseExample1: description: 'A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`. ' value: "[\n {\n \"name\": \"my-template-0\",\n \"index_patterns\": \"[te*]\",\n \"order\": \"500\",\n \"version\": null,\n \"composed_of\": \"[]\"\n },\n {\n \"name\": \"my-template-1\",\n \"index_patterns\": \"[tea*]\",\n \"order\": \"501\",\n \"version\": null,\n \"composed_of\": \"[]\"\n },\n {\n \"name\": \"my-template-2\",\n \"index_patterns\": \"[teak*]\",\n \"order\": \"502\",\n \"version\": \"7\",\n \"composed_of\": \"[]\"\n }\n]" x-state: Generally available; Added in 5.2.0 x-variations: - "
\n GET\n /_cat/templates\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: templates.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/templates/my-template-*?v=true&s=name&format=json ' - lang: Python source: "resp = client.cat.templates(\n name=\"my-template-*\",\n v=True,\n s=\"name\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.templates({\n name: \"my-template-*\",\n v: \"true\",\n s: \"name\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.templates(\n name: \"my-template-*\",\n v: \"true\",\n s: \"name\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->templates([\n \"name\" => \"my-template-*\",\n \"v\" => \"true\",\n \"s\" => \"name\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/templates/my-template-*?v=true&s=name&format=json"' - lang: Java source: 'client.cat().templates(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/templates/{name}: get: tags: - Cat summary: Get index template information description: 'Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. 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 index template API.' operationId: cat-templates-1 parameters: - in: path name: name description: 'The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple - in: query name: h description: "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `name` (or `n`): The template name.\n - `index_patterns` (or `t`): The template index patterns.\n - `order` (or `o`, `p`): The template application order or priority number.\n - `version` (or `v`): The version.\n - `composed_of` (or `c`): The component templates comprising the index template.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTemplatesColumns' 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: type: boolean style: form - in: query name: master_timeout description: Period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.templates.TemplatesRecord' examples: CatTemplatesResponseExample1: description: 'A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`. ' value: "[\n {\n \"name\": \"my-template-0\",\n \"index_patterns\": \"[te*]\",\n \"order\": \"500\",\n \"version\": null,\n \"composed_of\": \"[]\"\n },\n {\n \"name\": \"my-template-1\",\n \"index_patterns\": \"[tea*]\",\n \"order\": \"501\",\n \"version\": null,\n \"composed_of\": \"[]\"\n },\n {\n \"name\": \"my-template-2\",\n \"index_patterns\": \"[teak*]\",\n \"order\": \"502\",\n \"version\": \"7\",\n \"composed_of\": \"[]\"\n }\n]" x-state: Generally available; Added in 5.2.0 x-variations: - "
\n GET\n /_cat/templates/{name}\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: templates.cat x-category: info x-codeSamples: - lang: Console source: 'GET _cat/templates/my-template-*?v=true&s=name&format=json ' - lang: Python source: "resp = client.cat.templates(\n name=\"my-template-*\",\n v=True,\n s=\"name\",\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.templates({\n name: \"my-template-*\",\n v: \"true\",\n s: \"name\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.templates(\n name: \"my-template-*\",\n v: \"true\",\n s: \"name\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->templates([\n \"name\" => \"my-template-*\",\n \"v\" => \"true\",\n \"s\" => \"name\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/templates/my-template-*?v=true&s=name&format=json"' - lang: Java source: 'client.cat().templates(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/thread_pool: get: tags: - Cat summary: Get thread pool statistics description: 'Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. 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.' operationId: cat-thread-pool parameters: - in: query name: h description: "List of columns to appear in the response. Supports simple wildcards.\n\nSupported values include:\n - `active` (or `a`): Number of active threads in the current thread pool.\n - `completed` (or `c`): Number of tasks completed by the thread pool executor.\n - `core` (or `cr`): Configured core number of active threads allowed in the current thread pool.\n - `ephemeral_id` (or `eid`): Ephemeral node ID.\n - `host` (or `h`): Hostname for the current node.\n - `ip` (or `i`): IP address for the current node.\n - `keep_alive` (or `k`): Configured keep alive time for threads.\n - `largest` (or `l`): Highest number of active threads in the current thread pool.\n - `max` (or `mx`): Configured maximum number of active threads allowed in the current thread pool.\n - `name`: Name of the thread pool, such as `analyze` or `generic`.\n - `node_id` (or `id`): ID of the node, such as `k0zy`.\n - `node_name`: Node name, such as `I8hydUG`.\n - `pid` (or `p`): Process ID of the running node.\n - `pool_size` (or `psz`): Number of threads in the current thread pool.\n - `port` (or `po`): Bound transport port for the current node.\n - `queue` (or `q`): Number of tasks in the queue for the current thread pool.\n - `queue_size` (or `qs`): Maximum number of tasks permitted in the queue for the current thread pool.\n - `rejected` (or `r`): Number of tasks rejected by the thread pool executor.\n - `size` (or `sz`): Configured fixed number of active threads allowed in the current thread pool.\n - `type` (or `t`): Type of thread pool. Returned values are `fixed`, `fixed_auto_queue_size`, `direct`, or `scaling`.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatThreadPoolColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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: type: boolean style: form - in: query name: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.thread_pool.ThreadPoolRecord' examples: CatThreadPoolResponseExample1: summary: Default columns description: 'A successful response from `GET /_cat/thread_pool?format=json`. ' value: "[\n {\n \"node_name\": \"node-0\",\n \"name\": \"analyze\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"fetch_shard_started\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"fetch_shard_store\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"flush\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"write\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n }\n]" CatThreadPoolResponseExample2: summary: Explicit columns description: 'A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool. ' value: "[\n {\n \"id\": \"0EWUhXeBQtaVGlexUeVwMg\",\n \"name\": \"generic\",\n \"active\": \"0\",\n \"rejected\": \"0\",\n \"completed\": \"70\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/thread_pool\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: thread_pool.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/thread_pool?format=json ' - lang: Python source: "resp = client.cat.thread_pool(\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.threadPool({\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.thread_pool(\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->threadPool([\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/thread_pool?format=json"' - lang: Java source: 'client.cat().threadPool(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/thread_pool/{thread_pool_patterns}: get: tags: - Cat summary: Get thread pool statistics description: 'Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. 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.' operationId: cat-thread-pool-1 parameters: - in: path name: thread_pool_patterns description: 'A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple - in: query name: h description: "List of columns to appear in the response. Supports simple wildcards.\n\nSupported values include:\n - `active` (or `a`): Number of active threads in the current thread pool.\n - `completed` (or `c`): Number of tasks completed by the thread pool executor.\n - `core` (or `cr`): Configured core number of active threads allowed in the current thread pool.\n - `ephemeral_id` (or `eid`): Ephemeral node ID.\n - `host` (or `h`): Hostname for the current node.\n - `ip` (or `i`): IP address for the current node.\n - `keep_alive` (or `k`): Configured keep alive time for threads.\n - `largest` (or `l`): Highest number of active threads in the current thread pool.\n - `max` (or `mx`): Configured maximum number of active threads allowed in the current thread pool.\n - `name`: Name of the thread pool, such as `analyze` or `generic`.\n - `node_id` (or `id`): ID of the node, such as `k0zy`.\n - `node_name`: Node name, such as `I8hydUG`.\n - `pid` (or `p`): Process ID of the running node.\n - `pool_size` (or `psz`): Number of threads in the current thread pool.\n - `port` (or `po`): Bound transport port for the current node.\n - `queue` (or `q`): Number of tasks in the queue for the current thread pool.\n - `queue_size` (or `qs`): Maximum number of tasks permitted in the queue for the current thread pool.\n - `rejected` (or `r`): Number of tasks rejected by the thread pool executor.\n - `size` (or `sz`): Configured fixed number of active threads allowed in the current thread pool.\n - `type` (or `t`): Type of thread pool. Returned values are `fixed`, `fixed_auto_queue_size`, `direct`, or `scaling`.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatThreadPoolColumns' style: form - in: query name: s description: 'A comma-separated list of column names or aliases that determines the sort order. 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: type: boolean style: form - in: query name: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.thread_pool.ThreadPoolRecord' examples: CatThreadPoolResponseExample1: summary: Default columns description: 'A successful response from `GET /_cat/thread_pool?format=json`. ' value: "[\n {\n \"node_name\": \"node-0\",\n \"name\": \"analyze\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"fetch_shard_started\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"fetch_shard_store\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"flush\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"write\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n }\n]" CatThreadPoolResponseExample2: summary: Explicit columns description: 'A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool. ' value: "[\n {\n \"id\": \"0EWUhXeBQtaVGlexUeVwMg\",\n \"name\": \"generic\",\n \"active\": \"0\",\n \"rejected\": \"0\",\n \"completed\": \"70\"\n }\n]" x-state: Generally available x-variations: - "
\n GET\n /_cat/thread_pool/{thread_pool_patterns}\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: thread_pool.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/thread_pool?format=json ' - lang: Python source: "resp = client.cat.thread_pool(\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.threadPool({\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.thread_pool(\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->threadPool([\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/thread_pool?format=json"' - lang: Java source: 'client.cat().threadPool(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/transforms: get: tags: - Cat summary: Get transform information description: 'Get configuration and usage information about transforms. 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 transform statistics API.' operationId: cat-transforms parameters: - in: query name: allow_no_match description: 'Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches.' deprecated: false schema: type: boolean style: form - in: query name: from description: Skips the specified number of transforms. deprecated: false schema: type: number style: form - in: query name: h description: "Comma-separated list of column names to display.\n\nSupported values include:\n - `changes_last_detection_time` (or `cldt`): The timestamp when changes were last detected in the source indices.\n - `checkpoint` (or `cp`): The sequence number for the checkpoint.\n - `checkpoint_duration_time_exp_avg` (or `cdtea`, `checkpointTimeExpAvg`): Exponential moving average of the duration of the checkpoint, in\nmilliseconds.\n - `checkpoint_progress` (or `c`, `checkpointProgress`): The progress of the next checkpoint that is currently in progress.\n - `create_time` (or `ct`, `createTime`): The time the transform was created.\n - `delete_time` (or `dtime`): The amount of time spent deleting, in milliseconds.\n - `description` (or `d`): The description of the transform.\n - `dest_index` (or `di`, `destIndex`): The destination index for the transform. The mappings of the destination\nindex are deduced based on the source fields when possible. If alternate\nmappings are required, use the Create index API prior to starting the\ntransform.\n - `documents_deleted` (or `docd`): The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.\n - `documents_indexed` (or `doci`): The number of documents that have been indexed into the destination index\nfor the transform.\n - `docs_per_second` (or `dps`): Specifies a limit on the number of input documents per second. This setting\nthrottles the transform by adding a wait time between search requests. The\ndefault value is `null`, which disables throttling.\n - `documents_processed` (or `docp`): The number of documents that have been processed from the source index of\nthe transform.\n - `frequency` (or `f`): The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is `1s` and the maximum is `1h`. The default\nvalue is `1m`.\n - `id`: Identifier for the transform.\n - `index_failure` (or `if`): The number of indexing failures.\n - `index_time` (or `itime`): The amount of time spent indexing, in milliseconds.\n - `index_total` (or `it`): The number of index operations.\n - `indexed_documents_exp_avg` (or `idea`): Exponential moving average of the number of new documents that have been\nindexed.\n - `last_search_time` (or `lst`, `lastSearchTime`): The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.\n - `max_page_search_size` (or `mpsz`): Defines the initial page size to use for the composite aggregation for each\ncheckpoint. If circuit breaker exceptions occur, the page size is\ndynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500`.\n - `pages_processed` (or `pp`): The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.\n - `pipeline` (or `p`): The unique identifier for an ingest pipeline.\n - `processed_documents_exp_avg` (or `pdea`): Exponential moving average of the number of documents that have been\nprocessed.\n - `processing_time` (or `pt`): The amount of time spent processing results, in milliseconds.\n - `reason` (or `r`): If a transform has a `failed` state, this property provides details about\nthe reason for the failure.\n - `search_failure` (or `sf`): The number of search failures.\n - `search_time` (or `stime`): The amount of time spent searching, in milliseconds.\n - `search_total` (or `st`): The number of search operations on the source index for the transform.\n - `source_index` (or `si`, `sourceIndex`): The source indices for the transform. It can be a single index, an index\npattern (for example, `\"my-index-*\"`), an array of indices (for example,\n`[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns\n(for example, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use\nthe syntax `\"remote_name:index_name\"`. If any indices are in remote\nclusters then the master node and at least one transform node must have the\n`remote_cluster_client` node role.\n - `state` (or `s`): The status of the transform, which can be one of the following values:\n\n* `aborting`: The transform is aborting.\n* `failed`: The transform failed. For more information about the failure,\ncheck the reason field.\n* `indexing`: The transform is actively processing data and creating new\ndocuments.\n* `started`: The transform is running but not actively indexing data.\n* `stopped`: The transform is stopped.\n* `stopping`: The transform is stopping.\n - `transform_type` (or `tt`): Indicates the type of transform: `batch` or `continuous`.\n - `trigger_count` (or `tc`): The number of times the transform has been triggered by the scheduler. For\nexample, the scheduler triggers the transform indexer to check for updates\nor ingest new data at an interval specified in the `frequency` property.\n - `version` (or `v`): The version of Elasticsearch that existed on the node when the transform\nwas created.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTransformColumns' style: form - in: query name: s description: "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `changes_last_detection_time` (or `cldt`): The timestamp when changes were last detected in the source indices.\n - `checkpoint` (or `cp`): The sequence number for the checkpoint.\n - `checkpoint_duration_time_exp_avg` (or `cdtea`, `checkpointTimeExpAvg`): Exponential moving average of the duration of the checkpoint, in\nmilliseconds.\n - `checkpoint_progress` (or `c`, `checkpointProgress`): The progress of the next checkpoint that is currently in progress.\n - `create_time` (or `ct`, `createTime`): The time the transform was created.\n - `delete_time` (or `dtime`): The amount of time spent deleting, in milliseconds.\n - `description` (or `d`): The description of the transform.\n - `dest_index` (or `di`, `destIndex`): The destination index for the transform. The mappings of the destination\nindex are deduced based on the source fields when possible. If alternate\nmappings are required, use the Create index API prior to starting the\ntransform.\n - `documents_deleted` (or `docd`): The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.\n - `documents_indexed` (or `doci`): The number of documents that have been indexed into the destination index\nfor the transform.\n - `docs_per_second` (or `dps`): Specifies a limit on the number of input documents per second. This setting\nthrottles the transform by adding a wait time between search requests. The\ndefault value is `null`, which disables throttling.\n - `documents_processed` (or `docp`): The number of documents that have been processed from the source index of\nthe transform.\n - `frequency` (or `f`): The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is `1s` and the maximum is `1h`. The default\nvalue is `1m`.\n - `id`: Identifier for the transform.\n - `index_failure` (or `if`): The number of indexing failures.\n - `index_time` (or `itime`): The amount of time spent indexing, in milliseconds.\n - `index_total` (or `it`): The number of index operations.\n - `indexed_documents_exp_avg` (or `idea`): Exponential moving average of the number of new documents that have been\nindexed.\n - `last_search_time` (or `lst`, `lastSearchTime`): The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.\n - `max_page_search_size` (or `mpsz`): Defines the initial page size to use for the composite aggregation for each\ncheckpoint. If circuit breaker exceptions occur, the page size is\ndynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500`.\n - `pages_processed` (or `pp`): The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.\n - `pipeline` (or `p`): The unique identifier for an ingest pipeline.\n - `processed_documents_exp_avg` (or `pdea`): Exponential moving average of the number of documents that have been\nprocessed.\n - `processing_time` (or `pt`): The amount of time spent processing results, in milliseconds.\n - `reason` (or `r`): If a transform has a `failed` state, this property provides details about\nthe reason for the failure.\n - `search_failure` (or `sf`): The number of search failures.\n - `search_time` (or `stime`): The amount of time spent searching, in milliseconds.\n - `search_total` (or `st`): The number of search operations on the source index for the transform.\n - `source_index` (or `si`, `sourceIndex`): The source indices for the transform. It can be a single index, an index\npattern (for example, `\"my-index-*\"`), an array of indices (for example,\n`[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns\n(for example, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use\nthe syntax `\"remote_name:index_name\"`. If any indices are in remote\nclusters then the master node and at least one transform node must have the\n`remote_cluster_client` node role.\n - `state` (or `s`): The status of the transform, which can be one of the following values:\n\n* `aborting`: The transform is aborting.\n* `failed`: The transform failed. For more information about the failure,\ncheck the reason field.\n* `indexing`: The transform is actively processing data and creating new\ndocuments.\n* `started`: The transform is running but not actively indexing data.\n* `stopped`: The transform is stopped.\n* `stopping`: The transform is stopping.\n - `transform_type` (or `tt`): Indicates the type of transform: `batch` or `continuous`.\n - `trigger_count` (or `tc`): The number of times the transform has been triggered by the scheduler. For\nexample, the scheduler triggers the transform indexer to check for updates\nor ingest new data at an interval specified in the `frequency` property.\n - `version` (or `v`): The version of Elasticsearch that existed on the node when the transform\nwas created.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTransformColumns' style: form - in: query name: size description: The maximum number of transforms to obtain. deprecated: false schema: type: number style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.transforms.TransformsRecord' examples: CatTransformsResponseExample1: description: A successful response from `GET /_cat/transforms?v=true&format=json`. value: "[\n {\n \"id\" : \"ecommerce_transform\",\n \"state\" : \"started\",\n \"checkpoint\" : \"1\",\n \"documents_processed\" : \"705\",\n \"checkpoint_progress\" : \"100.00\",\n \"changes_last_detection_time\" : null\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/transforms\n
\n " x-req-auth: - 'Cluster privileges: `monitor_transform` ' x-api: transforms.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/transforms?v=true&format=json ' - lang: Python source: "resp = client.cat.transforms(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.transforms({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.transforms(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->transforms([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/transforms?v=true&format=json"' - lang: Java source: 'client.cat().transforms(); ' x-metaTags: - content: Elasticsearch name: product_name /_cat/transforms/{transform_id}: get: tags: - Cat summary: Get transform information description: 'Get configuration and usage information about transforms. 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 transform statistics API.' operationId: cat-transforms-1 parameters: - in: path name: transform_id description: 'A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Id' style: simple - in: query name: allow_no_match description: 'Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches.' deprecated: false schema: type: boolean style: form - in: query name: from description: Skips the specified number of transforms. deprecated: false schema: type: number style: form - in: query name: h description: "Comma-separated list of column names to display.\n\nSupported values include:\n - `changes_last_detection_time` (or `cldt`): The timestamp when changes were last detected in the source indices.\n - `checkpoint` (or `cp`): The sequence number for the checkpoint.\n - `checkpoint_duration_time_exp_avg` (or `cdtea`, `checkpointTimeExpAvg`): Exponential moving average of the duration of the checkpoint, in\nmilliseconds.\n - `checkpoint_progress` (or `c`, `checkpointProgress`): The progress of the next checkpoint that is currently in progress.\n - `create_time` (or `ct`, `createTime`): The time the transform was created.\n - `delete_time` (or `dtime`): The amount of time spent deleting, in milliseconds.\n - `description` (or `d`): The description of the transform.\n - `dest_index` (or `di`, `destIndex`): The destination index for the transform. The mappings of the destination\nindex are deduced based on the source fields when possible. If alternate\nmappings are required, use the Create index API prior to starting the\ntransform.\n - `documents_deleted` (or `docd`): The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.\n - `documents_indexed` (or `doci`): The number of documents that have been indexed into the destination index\nfor the transform.\n - `docs_per_second` (or `dps`): Specifies a limit on the number of input documents per second. This setting\nthrottles the transform by adding a wait time between search requests. The\ndefault value is `null`, which disables throttling.\n - `documents_processed` (or `docp`): The number of documents that have been processed from the source index of\nthe transform.\n - `frequency` (or `f`): The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is `1s` and the maximum is `1h`. The default\nvalue is `1m`.\n - `id`: Identifier for the transform.\n - `index_failure` (or `if`): The number of indexing failures.\n - `index_time` (or `itime`): The amount of time spent indexing, in milliseconds.\n - `index_total` (or `it`): The number of index operations.\n - `indexed_documents_exp_avg` (or `idea`): Exponential moving average of the number of new documents that have been\nindexed.\n - `last_search_time` (or `lst`, `lastSearchTime`): The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.\n - `max_page_search_size` (or `mpsz`): Defines the initial page size to use for the composite aggregation for each\ncheckpoint. If circuit breaker exceptions occur, the page size is\ndynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500`.\n - `pages_processed` (or `pp`): The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.\n - `pipeline` (or `p`): The unique identifier for an ingest pipeline.\n - `processed_documents_exp_avg` (or `pdea`): Exponential moving average of the number of documents that have been\nprocessed.\n - `processing_time` (or `pt`): The amount of time spent processing results, in milliseconds.\n - `reason` (or `r`): If a transform has a `failed` state, this property provides details about\nthe reason for the failure.\n - `search_failure` (or `sf`): The number of search failures.\n - `search_time` (or `stime`): The amount of time spent searching, in milliseconds.\n - `search_total` (or `st`): The number of search operations on the source index for the transform.\n - `source_index` (or `si`, `sourceIndex`): The source indices for the transform. It can be a single index, an index\npattern (for example, `\"my-index-*\"`), an array of indices (for example,\n`[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns\n(for example, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use\nthe syntax `\"remote_name:index_name\"`. If any indices are in remote\nclusters then the master node and at least one transform node must have the\n`remote_cluster_client` node role.\n - `state` (or `s`): The status of the transform, which can be one of the following values:\n\n* `aborting`: The transform is aborting.\n* `failed`: The transform failed. For more information about the failure,\ncheck the reason field.\n* `indexing`: The transform is actively processing data and creating new\ndocuments.\n* `started`: The transform is running but not actively indexing data.\n* `stopped`: The transform is stopped.\n* `stopping`: The transform is stopping.\n - `transform_type` (or `tt`): Indicates the type of transform: `batch` or `continuous`.\n - `trigger_count` (or `tc`): The number of times the transform has been triggered by the scheduler. For\nexample, the scheduler triggers the transform indexer to check for updates\nor ingest new data at an interval specified in the `frequency` property.\n - `version` (or `v`): The version of Elasticsearch that existed on the node when the transform\nwas created.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTransformColumns' style: form - in: query name: s description: "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `changes_last_detection_time` (or `cldt`): The timestamp when changes were last detected in the source indices.\n - `checkpoint` (or `cp`): The sequence number for the checkpoint.\n - `checkpoint_duration_time_exp_avg` (or `cdtea`, `checkpointTimeExpAvg`): Exponential moving average of the duration of the checkpoint, in\nmilliseconds.\n - `checkpoint_progress` (or `c`, `checkpointProgress`): The progress of the next checkpoint that is currently in progress.\n - `create_time` (or `ct`, `createTime`): The time the transform was created.\n - `delete_time` (or `dtime`): The amount of time spent deleting, in milliseconds.\n - `description` (or `d`): The description of the transform.\n - `dest_index` (or `di`, `destIndex`): The destination index for the transform. The mappings of the destination\nindex are deduced based on the source fields when possible. If alternate\nmappings are required, use the Create index API prior to starting the\ntransform.\n - `documents_deleted` (or `docd`): The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.\n - `documents_indexed` (or `doci`): The number of documents that have been indexed into the destination index\nfor the transform.\n - `docs_per_second` (or `dps`): Specifies a limit on the number of input documents per second. This setting\nthrottles the transform by adding a wait time between search requests. The\ndefault value is `null`, which disables throttling.\n - `documents_processed` (or `docp`): The number of documents that have been processed from the source index of\nthe transform.\n - `frequency` (or `f`): The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is `1s` and the maximum is `1h`. The default\nvalue is `1m`.\n - `id`: Identifier for the transform.\n - `index_failure` (or `if`): The number of indexing failures.\n - `index_time` (or `itime`): The amount of time spent indexing, in milliseconds.\n - `index_total` (or `it`): The number of index operations.\n - `indexed_documents_exp_avg` (or `idea`): Exponential moving average of the number of new documents that have been\nindexed.\n - `last_search_time` (or `lst`, `lastSearchTime`): The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.\n - `max_page_search_size` (or `mpsz`): Defines the initial page size to use for the composite aggregation for each\ncheckpoint. If circuit breaker exceptions occur, the page size is\ndynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500`.\n - `pages_processed` (or `pp`): The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.\n - `pipeline` (or `p`): The unique identifier for an ingest pipeline.\n - `processed_documents_exp_avg` (or `pdea`): Exponential moving average of the number of documents that have been\nprocessed.\n - `processing_time` (or `pt`): The amount of time spent processing results, in milliseconds.\n - `reason` (or `r`): If a transform has a `failed` state, this property provides details about\nthe reason for the failure.\n - `search_failure` (or `sf`): The number of search failures.\n - `search_time` (or `stime`): The amount of time spent searching, in milliseconds.\n - `search_total` (or `st`): The number of search operations on the source index for the transform.\n - `source_index` (or `si`, `sourceIndex`): The source indices for the transform. It can be a single index, an index\npattern (for example, `\"my-index-*\"`), an array of indices (for example,\n`[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns\n(for example, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use\nthe syntax `\"remote_name:index_name\"`. If any indices are in remote\nclusters then the master node and at least one transform node must have the\n`remote_cluster_client` node role.\n - `state` (or `s`): The status of the transform, which can be one of the following values:\n\n* `aborting`: The transform is aborting.\n* `failed`: The transform failed. For more information about the failure,\ncheck the reason field.\n* `indexing`: The transform is actively processing data and creating new\ndocuments.\n* `started`: The transform is running but not actively indexing data.\n* `stopped`: The transform is stopped.\n* `stopping`: The transform is stopping.\n - `transform_type` (or `tt`): Indicates the type of transform: `batch` or `continuous`.\n - `trigger_count` (or `tc`): The number of times the transform has been triggered by the scheduler. For\nexample, the scheduler triggers the transform indexer to check for updates\nor ingest new data at an interval specified in the `frequency` property.\n - `version` (or `v`): The version of Elasticsearch that existed on the node when the transform\nwas created.\n\n" deprecated: false schema: $ref: '#/components/schemas/cat._types.CatTransformColumns' style: form - in: query name: size description: The maximum number of transforms to obtain. deprecated: false schema: type: number style: form responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/cat.transforms.TransformsRecord' examples: CatTransformsResponseExample1: description: A successful response from `GET /_cat/transforms?v=true&format=json`. value: "[\n {\n \"id\" : \"ecommerce_transform\",\n \"state\" : \"started\",\n \"checkpoint\" : \"1\",\n \"documents_processed\" : \"705\",\n \"checkpoint_progress\" : \"100.00\",\n \"changes_last_detection_time\" : null\n }\n]" x-state: Generally available; Added in 7.7.0 x-variations: - "
\n GET\n /_cat/transforms/{transform_id}\n
\n " x-req-auth: - 'Cluster privileges: `monitor_transform` ' x-api: transforms.cat x-category: info x-codeSamples: - lang: Console source: 'GET /_cat/transforms?v=true&format=json ' - lang: Python source: "resp = client.cat.transforms(\n v=True,\n format=\"json\",\n)" - lang: JavaScript source: "const response = await client.cat.transforms({\n v: \"true\",\n format: \"json\",\n});" - lang: Ruby source: "response = client.cat.transforms(\n v: \"true\",\n format: \"json\"\n)" - lang: PHP source: "$resp = $client->cat()->transforms([\n \"v\" => \"true\",\n \"format\" => \"json\",\n]);" - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/transforms?v=true&format=json"' - lang: Java source: 'client.cat().transforms(); ' x-metaTags: - content: Elasticsearch name: product_name components: schemas: cat._types.CatRecoveryColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatRecoveryColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatRecoveryColumn' cat._types.CatSegmentsColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatSegmentsColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatSegmentsColumn' cat.ml_datafeeds.DatafeedsRecord: type: object properties: id: description: The datafeed identifier. type: string state: description: The status of the datafeed. allOf: - $ref: '#/components/schemas/ml._types.DatafeedState' assignment_explanation: description: For started datafeeds only, contains messages relating to the selection of a node. type: string buckets.count: description: The number of buckets processed. type: string search.count: description: The number of searches run by the datafeed. type: string search.time: description: The total time the datafeed spent searching, in milliseconds. type: string search.bucket_avg: description: The average search time per bucket, in milliseconds. type: string search.exp_avg_hour: description: The exponential average search time per hour, in milliseconds. type: string node.id: description: 'The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.' type: string node.name: description: 'The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.' type: string node.ephemeral_id: description: 'The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.' type: string node.address: description: 'The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.' type: string cat.plugins.PluginsRecord: type: object properties: id: description: The unique node identifier. allOf: - $ref: '#/components/schemas/_types.NodeId' name: description: The node name. allOf: - $ref: '#/components/schemas/_types.Name' component: description: The component name. type: string version: description: The component version. allOf: - $ref: '#/components/schemas/_types.VersionString' description: description: The plugin details. type: string type: description: The plugin type. type: string cat._types.CatMasterColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatMasterColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatMasterColumn' cat._types.CatTransformColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatTransformColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatTransformColumn' cat._types.CatTasksColumn: anyOf: - type: string enum: - id - action - ac - task_id - ti - parent_task_id - pti - type - ty - start_time - start - timestamp - ts - hms - hhmmss - running_time_ns - time - running_time - time - node_id - ni - ip - i - port - po - node - n - version - v - x_opaque_id - x - type: string cat._types.CatCountColumn: anyOf: - type: string enum: - epoch - t - time - timestamp - ts - hms - hhmmss - count - dc - docs.count - docsCount - type: string _types.Ip: type: string ml._types.JobState: type: string enum: - closing - closed - opened - failed - opening cat._types.CatThreadPoolColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatThreadPoolColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatThreadPoolColumn' _types.Names: oneOf: - $ref: '#/components/schemas/_types.Name' - type: array items: $ref: '#/components/schemas/_types.Name' _types.Host: type: string cat._types.CatSnapshotsColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatSnapshotsColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatSnapshotsColumn' cat._types.CatComponentColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatComponentColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatComponentColumn' cat.shards.ShardsRecord: type: object properties: index: description: The index name. type: string shard: description: The shard name. type: string prirep: description: 'The shard type: `primary` or `replica`.' type: string state: description: 'The shard state. Returned values include: `INITIALIZING`: The shard is recovering from a peer shard or gateway. `RELOCATING`: The shard is relocating. `STARTED`: The shard has started. `UNASSIGNED`: The shard is not assigned to any node.' type: string docs: description: The number of documents in the shard. oneOf: - type: string - type: - string - 'null' store: description: The disk space used by the shard. oneOf: - type: string - type: - string - 'null' dataset: description: total size of dataset (including the cache for partially mounted indices) x-state: Generally available; Added in 8.11.0 oneOf: - type: string - type: - string - 'null' ip: description: The IP address of the node. oneOf: - type: string - type: - string - 'null' id: description: The unique identifier for the node. type: string node: description: The name of node. oneOf: - type: string - type: - string - 'null' sync_id: description: The sync identifier. type: string unassigned.reason: description: 'The reason for the last change to the state of an unassigned shard. It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. Returned values include: `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard. `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery. `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index. `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index. `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. `INDEX_CLOSED`: Unassigned because the index was closed. `INDEX_CREATED`: Unassigned as a result of an API creation of an index. `INDEX_REOPENED`: Unassigned as a result of opening a closed index. `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API. `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index. `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster. `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API. `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed. `REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled. `REINITIALIZED`: When a shard moves from started back to initializing. `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica. `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command.' type: string unassigned.at: description: The time at which the shard became unassigned in Coordinated Universal Time (UTC). type: string unassigned.for: description: The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC). type: string unassigned.details: description: 'Additional details as to why the shard became unassigned. It does not explain why the shard is not assigned; use the cluster allocation explain API for that information.' type: string recoverysource.type: description: The type of recovery source. type: string completion.size: description: The size of completion. type: string fielddata.memory_size: description: The used fielddata cache memory. type: string fielddata.evictions: description: The fielddata cache evictions. type: string query_cache.memory_size: description: The used query cache memory. type: string query_cache.evictions: description: The query cache evictions. type: string flush.total: description: The number of flushes. type: string flush.total_time: description: The time spent in flush. type: string get.current: description: The number of current get operations. type: string get.time: description: The time spent in get operations. type: string get.total: description: The number of get operations. type: string get.exists_time: description: The time spent in successful get operations. type: string get.exists_total: description: The number of successful get operations. type: string get.missing_time: description: The time spent in failed get operations. type: string get.missing_total: description: The number of failed get operations. type: string indexing.delete_current: description: The number of current deletion operations. type: string indexing.delete_time: description: The time spent in deletion operations. type: string indexing.delete_total: description: The number of delete operations. type: string indexing.index_current: description: The number of current indexing operations. type: string indexing.index_time: description: The time spent in indexing operations. type: string indexing.index_total: description: The number of indexing operations. type: string indexing.index_failed: description: The number of failed indexing operations. type: string merges.current: description: The number of current merge operations. type: string merges.current_docs: description: The number of current merging documents. type: string merges.current_size: description: The size of current merge operations. type: string merges.total: description: The number of completed merge operations. type: string merges.total_docs: description: The nuber of merged documents. type: string merges.total_size: description: The size of current merges. type: string merges.total_time: description: The time spent merging documents. type: string refresh.total: description: The total number of refreshes. type: string refresh.time: description: The time spent in refreshes. type: string refresh.external_total: description: The total nunber of external refreshes. type: string refresh.external_time: description: The time spent in external refreshes. type: string refresh.listeners: description: The number of pending refresh listeners. type: string search.fetch_current: description: The current fetch phase operations. type: string search.fetch_time: description: The time spent in fetch phase. type: string search.fetch_total: description: The total number of fetch operations. type: string search.open_contexts: description: The number of open search contexts. type: string search.query_current: description: The current query phase operations. type: string search.query_time: description: The time spent in query phase. type: string search.query_total: description: The total number of query phase operations. type: string search.scroll_current: description: The open scroll contexts. type: string search.scroll_time: description: The time scroll contexts were held open. type: string search.scroll_total: description: The number of completed scroll contexts. type: string segments.count: description: The number of segments. type: string segments.memory: description: The memory used by segments. type: string segments.index_writer_memory: description: The memory used by the index writer. type: string segments.version_map_memory: description: The memory used by the version map. type: string segments.fixed_bitset_memory: description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. type: string seq_no.max: description: The maximum sequence number. type: string seq_no.local_checkpoint: description: The local checkpoint. type: string seq_no.global_checkpoint: description: The global checkpoint. type: string warmer.current: description: The number of current warmer operations. type: string warmer.total: description: The total number of warmer operations. type: string warmer.total_time: description: The time spent in warmer operations. type: string path.data: description: The shard data path. type: string path.state: description: The shard state path. type: string bulk.total_operations: description: The number of bulk shard operations. type: string bulk.total_time: description: The time spent in shard bulk operations. type: string bulk.total_size_in_bytes: description: The total size in bytes of shard bulk operations. type: string bulk.avg_time: description: The average time spent in shard bulk operations. type: string bulk.avg_size_in_bytes: description: The average size in bytes of shard bulk operations. type: string cat._types.CatAliasesColumn: anyOf: - type: string enum: - alias - a - index - i - idx - filter - f - fi - routing.index - ri - routingIndex - routing.search - rs - routingSearch - is_write_index - w - isWriteIndex - type: string cat.transforms.TransformsRecord: type: object properties: id: description: The transform identifier. allOf: - $ref: '#/components/schemas/_types.Id' state: description: 'The status of the transform. Returned values include: `aborting`: The transform is aborting. `failed: The transform failed. For more information about the failure, check the `reason` field. `indexing`: The transform is actively processing data and creating new documents. `started`: The transform is running but not actively indexing data. `stopped`: The transform is stopped. `stopping`: The transform is stopping.' type: string checkpoint: description: The sequence number for the checkpoint. type: string documents_processed: description: The number of documents that have been processed from the source index of the transform. type: string checkpoint_progress: description: The progress of the next checkpoint that is currently in progress. oneOf: - type: string - type: - string - 'null' last_search_time: description: 'The timestamp of the last search in the source indices. This field is shown only if the transform is running.' oneOf: - type: string - type: - string - 'null' changes_last_detection_time: description: The timestamp when changes were last detected in the source indices. oneOf: - type: string - type: - string - 'null' create_time: description: The time the transform was created. type: string version: description: The version of Elasticsearch that existed on the node when the transform was created. allOf: - $ref: '#/components/schemas/_types.VersionString' source_index: description: The source indices for the transform. type: string dest_index: description: The destination index for the transform. type: string pipeline: description: The unique identifier for the ingest pipeline. type: string description: description: The description of the transform. type: string transform_type: description: 'The type of transform: `batch` or `continuous`.' type: string frequency: description: The interval between checks for changes in the source indices when the transform is running continuously. type: string max_page_search_size: description: The initial page size that is used for the composite aggregation for each checkpoint. type: string docs_per_second: description: The number of input documents per second. type: string reason: description: If a transform has a `failed` state, these details describe the reason for failure. type: string search_total: description: The total number of search operations on the source index for the transform. type: string search_failure: description: The total number of search failures. type: string search_time: description: The total amount of search time, in milliseconds. type: string index_total: description: The total number of index operations done by the transform. type: string index_failure: description: The total number of indexing failures. type: string index_time: description: The total time spent indexing documents, in milliseconds. type: string documents_indexed: description: The number of documents that have been indexed into the destination index for the transform. type: string delete_time: description: The total time spent deleting documents, in milliseconds. type: string documents_deleted: description: The number of documents deleted from the destination index due to the retention policy for the transform. type: string trigger_count: description: 'The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property.' type: string pages_processed: description: 'The number of search or bulk index operations processed. Documents are processed in batches instead of individually.' type: string processing_time: description: The total time spent processing results, in milliseconds. type: string checkpoint_duration_time_exp_avg: description: The exponential moving average of the duration of the checkpoint, in milliseconds. type: string indexed_documents_exp_avg: description: The exponential moving average of the number of new documents that have been indexed. type: string processed_documents_exp_avg: description: The exponential moving average of the number of documents that have been processed. type: string _types.EpochTimeUnitMillis: allOf: - $ref: '#/components/schemas/_types.UnitMillis' cat._types.CatFieldDataColumn: anyOf: - type: string enum: - id - host - h - ip - node - n - field - f - size - s - type: string cat._types.CatIndicesColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatIndicesColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatIndicesColumn' cat._types.CatPluginsColumn: anyOf: - type: string enum: - id - name - n - component - c - version - v - description - d - type: string _spec_utils.StringifiedEpochTimeUnitSeconds: description: '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 semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.' oneOf: - $ref: '#/components/schemas/_types.EpochTimeUnitSeconds' - type: string ml._types.MemoryStatus: type: string enum: - ok - soft_limit - hard_limit cat._types.CatDfaColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatDfaColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatDfaColumn' _types.ExpandWildcard: type: string enum: - all - open - closed - hidden - none cat._types.CatNodeColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatNodeColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatNodeColumn' cat._types.CatDatafeedColumn: type: string enum: - ae - assignment_explanation - bc - buckets.count - bucketsCount - id - na - node.address - nodeAddress - ne - node.ephemeral_id - nodeEphemeralId - ni - node.id - nodeId - nn - node.name - nodeName - sba - search.bucket_avg - searchBucketAvg - sc - search.count - searchCount - seah - search.exp_avg_hour - searchExpAvgHour - st - search.time - searchTime - s - state cat._types.CatThreadPoolColumn: anyOf: - type: string enum: - active - a - completed - c - core - cr - ephemeral_id - eid - host - h - ip - i - keep_alive - k - largest - l - max - mx - name - node_id - id - node_name - pid - p - pool_size - psz - port - po - queue - q - queue_size - qs - rejected - r - size - sz - type - t - type: string _types.ByteSize: oneOf: - type: number - type: string cat.aliases.AliasesRecord: type: object properties: alias: description: alias name type: string index: description: index alias points to allOf: - $ref: '#/components/schemas/_types.IndexName' filter: description: filter type: string routing.index: description: index routing type: string routing.search: description: search routing type: string is_write_index: description: write index type: string cat._types.CatCountColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatCountColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatCountColumn' cat.indices.IndicesRecord: type: object properties: health: description: current health status type: string status: description: open/close status type: string index: description: index name type: string uuid: description: index uuid type: string pri: description: number of primary shards type: string rep: description: number of replica shards type: string docs.count: description: 'The number of documents in the index, including hidden nested documents. For indices with `semantic_text` fields or other nested field types, this count includes the internal nested documents. To get the logical document count (excluding nested documents), use the `_count` API or `_cat/count` API instead.' oneOf: - type: string - type: - string - 'null' docs.deleted: description: deleted docs oneOf: - type: string - type: - string - 'null' creation.date: description: index creation date (millisecond value) type: string creation.date.string: description: index creation date (as string) type: string store.size: description: store size of primaries & replicas oneOf: - type: string - type: - string - 'null' pri.store.size: description: store size of primaries oneOf: - type: string - type: - string - 'null' dataset.size: description: total size of dataset (including the cache for partially mounted indices) x-state: Generally available; Added in 8.11.0 oneOf: - type: string - type: - string - 'null' completion.size: description: size of completion type: string pri.completion.size: description: size of completion type: string fielddata.memory_size: description: used fielddata cache type: string pri.fielddata.memory_size: description: used fielddata cache type: string fielddata.evictions: description: fielddata evictions type: string pri.fielddata.evictions: description: fielddata evictions type: string query_cache.memory_size: description: used query cache type: string pri.query_cache.memory_size: description: used query cache type: string query_cache.evictions: description: query cache evictions type: string pri.query_cache.evictions: description: query cache evictions type: string request_cache.memory_size: description: used request cache type: string pri.request_cache.memory_size: description: used request cache type: string request_cache.evictions: description: request cache evictions type: string pri.request_cache.evictions: description: request cache evictions type: string request_cache.hit_count: description: request cache hit count type: string pri.request_cache.hit_count: description: request cache hit count type: string request_cache.miss_count: description: request cache miss count type: string pri.request_cache.miss_count: description: request cache miss count type: string flush.total: description: number of flushes type: string pri.flush.total: description: number of flushes type: string flush.total_time: description: time spent in flush type: string pri.flush.total_time: description: time spent in flush type: string get.current: description: number of current get ops type: string pri.get.current: description: number of current get ops type: string get.time: description: time spent in get type: string pri.get.time: description: time spent in get type: string get.total: description: number of get ops type: string pri.get.total: description: number of get ops type: string get.exists_time: description: time spent in successful gets type: string pri.get.exists_time: description: time spent in successful gets type: string get.exists_total: description: number of successful gets type: string pri.get.exists_total: description: number of successful gets type: string get.missing_time: description: time spent in failed gets type: string pri.get.missing_time: description: time spent in failed gets type: string get.missing_total: description: number of failed gets type: string pri.get.missing_total: description: number of failed gets type: string indexing.delete_current: description: number of current deletions type: string pri.indexing.delete_current: description: number of current deletions type: string indexing.delete_time: description: time spent in deletions type: string pri.indexing.delete_time: description: time spent in deletions type: string indexing.delete_total: description: number of delete ops type: string pri.indexing.delete_total: description: number of delete ops type: string indexing.index_current: description: number of current indexing ops type: string pri.indexing.index_current: description: number of current indexing ops type: string indexing.index_time: description: time spent in indexing type: string pri.indexing.index_time: description: time spent in indexing type: string indexing.index_total: description: number of indexing ops type: string pri.indexing.index_total: description: number of indexing ops type: string indexing.index_failed: description: number of failed indexing ops type: string pri.indexing.index_failed: description: number of failed indexing ops type: string merges.current: description: number of current merges type: string pri.merges.current: description: number of current merges type: string merges.current_docs: description: number of current merging docs type: string pri.merges.current_docs: description: number of current merging docs type: string merges.current_size: description: size of current merges type: string pri.merges.current_size: description: size of current merges type: string merges.total: description: number of completed merge ops type: string pri.merges.total: description: number of completed merge ops type: string merges.total_docs: description: docs merged type: string pri.merges.total_docs: description: docs merged type: string merges.total_size: description: size merged type: string pri.merges.total_size: description: size merged type: string merges.total_time: description: time spent in merges type: string pri.merges.total_time: description: time spent in merges type: string refresh.total: description: total refreshes type: string pri.refresh.total: description: total refreshes type: string refresh.time: description: time spent in refreshes type: string pri.refresh.time: description: time spent in refreshes type: string refresh.external_total: description: total external refreshes type: string pri.refresh.external_total: description: total external refreshes type: string refresh.external_time: description: time spent in external refreshes type: string pri.refresh.external_time: description: time spent in external refreshes type: string refresh.listeners: description: number of pending refresh listeners type: string pri.refresh.listeners: description: number of pending refresh listeners type: string search.fetch_current: description: current fetch phase ops type: string pri.search.fetch_current: description: current fetch phase ops type: string search.fetch_time: description: time spent in fetch phase type: string pri.search.fetch_time: description: time spent in fetch phase type: string search.fetch_total: description: total fetch ops type: string pri.search.fetch_total: description: total fetch ops type: string search.open_contexts: description: open search contexts type: string pri.search.open_contexts: description: open search contexts type: string search.query_current: description: current query phase ops type: string pri.search.query_current: description: current query phase ops type: string search.query_time: description: time spent in query phase type: string pri.search.query_time: description: time spent in query phase type: string search.query_total: description: total query phase ops type: string pri.search.query_total: description: total query phase ops type: string search.scroll_current: description: open scroll contexts type: string pri.search.scroll_current: description: open scroll contexts type: string search.scroll_time: description: time scroll contexts held open type: string pri.search.scroll_time: description: time scroll contexts held open type: string search.scroll_total: description: completed scroll contexts type: string pri.search.scroll_total: description: completed scroll contexts type: string segments.count: description: number of segments type: string pri.segments.count: description: number of segments type: string segments.memory: description: memory used by segments type: string pri.segments.memory: description: memory used by segments type: string segments.index_writer_memory: description: memory used by index writer type: string pri.segments.index_writer_memory: description: memory used by index writer type: string segments.version_map_memory: description: memory used by version map type: string pri.segments.version_map_memory: description: memory used by version map type: string segments.fixed_bitset_memory: description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields type: string pri.segments.fixed_bitset_memory: description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields type: string warmer.current: description: current warmer ops type: string pri.warmer.current: description: current warmer ops type: string warmer.total: description: total warmer ops type: string pri.warmer.total: description: total warmer ops type: string warmer.total_time: description: time spent in warmers type: string pri.warmer.total_time: description: time spent in warmers type: string suggest.current: description: number of current suggest ops type: string pri.suggest.current: description: number of current suggest ops type: string suggest.time: description: time spend in suggest type: string pri.suggest.time: description: time spend in suggest type: string suggest.total: description: number of suggest ops type: string pri.suggest.total: description: number of suggest ops type: string memory.total: description: total used memory type: string pri.memory.total: description: total user memory type: string search.throttled: description: indicates if the index is search throttled type: string bulk.total_operations: description: number of bulk shard ops type: string pri.bulk.total_operations: description: number of bulk shard ops type: string bulk.total_time: description: time spend in shard bulk type: string pri.bulk.total_time: description: time spend in shard bulk type: string bulk.total_size_in_bytes: description: total size in bytes of shard bulk type: string pri.bulk.total_size_in_bytes: description: total size in bytes of shard bulk type: string bulk.avg_time: description: average time spend in shard bulk type: string pri.bulk.avg_time: description: average time spend in shard bulk type: string bulk.avg_size_in_bytes: description: average size in bytes of shard bulk type: string pri.bulk.avg_size_in_bytes: description: average size in bytes of shard bulk type: string cat.health.HealthRecord: type: object properties: epoch: description: seconds since 1970-01-01 00:00:00 allOf: - $ref: '#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds' timestamp: description: time in HH:MM:SS allOf: - $ref: '#/components/schemas/_types.TimeOfDay' cluster: description: cluster name type: string status: description: health status type: string node.total: description: total number of nodes type: string node.data: description: number of nodes that can store data type: string shards: description: total number of shards type: string pri: description: number of primary shards type: string relo: description: number of relocating nodes type: string init: description: number of initializing nodes type: string unassign.pri: description: number of unassigned primary shards type: string unassign: description: number of unassigned shards type: string pending_tasks: description: number of pending tasks type: string max_task_wait_time: description: wait time of longest task pending type: string active_shards_percent: description: active number of shards in percent type: string ml._types.DatafeedState: type: string enum: - started - stopped - starting - stopping cat._types.CatPluginsColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatPluginsColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatPluginsColumn' cat._types.CatHealthColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatHealthColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatHealthColumn' cat.count.CountRecord: type: object properties: epoch: description: seconds since 1970-01-01 00:00:00 allOf: - $ref: '#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds' timestamp: description: time in HH:MM:SS allOf: - $ref: '#/components/schemas/_types.TimeOfDay' count: description: the document count type: string cat.tasks.TasksRecord: type: object properties: id: description: The identifier of the task with the node. allOf: - $ref: '#/components/schemas/_types.Id' action: description: The task action. type: string task_id: description: The unique task identifier. allOf: - $ref: '#/components/schemas/_types.Id' parent_task_id: description: The parent task identifier. type: string type: description: The task type. type: string start_time: description: The start time in milliseconds. type: string timestamp: description: The start time in `HH:MM:SS` format. type: string running_time_ns: description: The running time in nanoseconds. type: string running_time: description: The running time. type: string node_id: description: The unique node identifier. allOf: - $ref: '#/components/schemas/_types.NodeId' ip: description: The IP address for the node. type: string port: description: The bound transport port for the node. type: string node: description: The node name. type: string version: description: The Elasticsearch version. allOf: - $ref: '#/components/schemas/_types.VersionString' x_opaque_id: description: The X-Opaque-ID header. type: string description: description: The task action description. type: string _types.Field: description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields. type: string _types.DateTime: description: '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 accepts both as input, but will generally output a string representation.' oneOf: - type: string - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' cat._types.CatMasterColumn: anyOf: - type: string enum: - id - host - h - ip - node - n - type: string cat._types.CatRecoveryColumn: anyOf: - type: string enum: - index - i - idx - shard - s - sh - start_time - start - start_time_millis - start_millis - stop_time - stop - stop_time_millis - stop_millis - time - t - ti - type - ty - stage - st - source_host - shost - source_node - snode - target_host - thost - target_node - tnode - repository - rep - snapshot - snap - files - f - files_recovered - fr - files_percent - fp - files_total - tf - bytes - b - bytes_recovered - br - bytes_percent - bp - bytes_total - tb - translog_ops - to - translog_ops_recovered - tor - translog_ops_percent - top - type: string _types.Duration: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units description: '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 indicate an unspecified value.' oneOf: - type: string - type: string enum: - '-1' - type: string enum: - '0' cat._types.CatAnomalyDetectorColumn: type: string enum: - assignment_explanation - ae - buckets.count - bc - bucketsCount - buckets.time.exp_avg - btea - bucketsTimeExpAvg - buckets.time.exp_avg_hour - bteah - bucketsTimeExpAvgHour - buckets.time.max - btmax - bucketsTimeMax - buckets.time.min - btmin - bucketsTimeMin - buckets.time.total - btt - bucketsTimeTotal - data.buckets - db - dataBuckets - data.earliest_record - der - dataEarliestRecord - data.empty_buckets - deb - dataEmptyBuckets - data.input_bytes - dib - dataInputBytes - data.input_fields - dif - dataInputFields - data.input_records - dir - dataInputRecords - data.invalid_dates - did - dataInvalidDates - data.last - dl - dataLast - data.last_empty_bucket - dleb - dataLastEmptyBucket - data.last_sparse_bucket - dlsb - dataLastSparseBucket - data.latest_record - dlr - dataLatestRecord - data.missing_fields - dmf - dataMissingFields - data.out_of_order_timestamps - doot - dataOutOfOrderTimestamps - data.processed_fields - dpf - dataProcessedFields - data.processed_records - dpr - dataProcessedRecords - data.sparse_buckets - dsb - dataSparseBuckets - forecasts.memory.avg - fmavg - forecastsMemoryAvg - forecasts.memory.max - fmmax - forecastsMemoryMax - forecasts.memory.min - fmmin - forecastsMemoryMin - forecasts.memory.total - fmt - forecastsMemoryTotal - forecasts.records.avg - fravg - forecastsRecordsAvg - forecasts.records.max - frmax - forecastsRecordsMax - forecasts.records.min - frmin - forecastsRecordsMin - forecasts.records.total - frt - forecastsRecordsTotal - forecasts.time.avg - ftavg - forecastsTimeAvg - forecasts.time.max - ftmax - forecastsTimeMax - forecasts.time.min - ftmin - forecastsTimeMin - forecasts.time.total - ftt - forecastsTimeTotal - forecasts.total - ft - forecastsTotal - id - model.bucket_allocation_failures - mbaf - modelBucketAllocationFailures - model.by_fields - mbf - modelByFields - model.bytes - mb - modelBytes - model.bytes_exceeded - mbe - modelBytesExceeded - model.categorization_status - mcs - modelCategorizationStatus - model.categorized_doc_count - mcdc - modelCategorizedDocCount - model.dead_category_count - mdcc - modelDeadCategoryCount - model.failed_category_count - mdcc - modelFailedCategoryCount - model.frequent_category_count - mfcc - modelFrequentCategoryCount - model.log_time - mlt - modelLogTime - model.memory_limit - mml - modelMemoryLimit - model.memory_status - mms - modelMemoryStatus - model.over_fields - mof - modelOverFields - model.partition_fields - mpf - modelPartitionFields - model.rare_category_count - mrcc - modelRareCategoryCount - model.timestamp - mt - modelTimestamp - model.total_category_count - mtcc - modelTotalCategoryCount - node.address - na - nodeAddress - node.ephemeral_id - ne - nodeEphemeralId - node.id - ni - nodeId - node.name - nn - nodeName - opened_time - ot - state - s cat.fielddata.FielddataRecord: type: object properties: id: description: node id type: string host: description: host name type: string ip: description: ip address type: string node: description: node name type: string field: description: field name type: string size: description: field data usage type: string _types.ExpandWildcards: oneOf: - $ref: '#/components/schemas/_types.ExpandWildcard' - type: array items: $ref: '#/components/schemas/_types.ExpandWildcard' cat.allocation.AllocationRecord: type: object properties: shards: description: Number of primary and replica shards assigned to the node. type: string shards.undesired: description: Amount of shards that are scheduled to be moved elsewhere in the cluster or -1 other than desired balance allocator is used oneOf: - type: string - type: - string - 'null' write_load.forecast: description: Sum of index write load forecasts oneOf: - $ref: '#/components/schemas/_spec_utils.Stringifieddouble' - type: - string - 'null' disk.indices.forecast: description: Sum of shard size forecasts oneOf: - $ref: '#/components/schemas/_types.ByteSize' - type: - string - 'null' disk.indices: description: 'Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.' oneOf: - $ref: '#/components/schemas/_types.ByteSize' - type: - string - 'null' disk.used: description: 'Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files.' oneOf: - $ref: '#/components/schemas/_types.ByteSize' - type: - string - 'null' disk.avail: description: 'Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.' oneOf: - $ref: '#/components/schemas/_types.ByteSize' - type: - string - 'null' disk.total: description: Total disk space for the node, including in-use and available space. oneOf: - $ref: '#/components/schemas/_types.ByteSize' - type: - string - 'null' disk.percent: description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`. oneOf: - $ref: '#/components/schemas/_types.Percentage' - type: - string - 'null' host: description: Network host for the node. Set using the `network.host` setting. oneOf: - $ref: '#/components/schemas/_types.Host' - type: - string - 'null' ip: description: IP address and port for the node. oneOf: - $ref: '#/components/schemas/_types.Ip' - type: - string - 'null' node: description: Name for the node. Set using the `node.name` setting. type: string node.role: description: Node roles oneOf: - type: string - type: - string - 'null' _types.TimeOfDay: description: Time of day, expressed as HH:MM:SS type: string _types.Id: type: string cat._types.CatNodeattrsColumn: anyOf: - type: string enum: - node - id - id - nodeId - pid - p - host - h - ip - i - port - po - attr - attr.name - value - attr.value - type: string cat.thread_pool.ThreadPoolRecord: type: object properties: node_name: description: The node name. type: string node_id: description: The persistent node identifier. allOf: - $ref: '#/components/schemas/_types.NodeId' ephemeral_node_id: description: The ephemeral node identifier. type: string pid: description: The process identifier. type: string host: description: The host name for the current node. type: string ip: description: The IP address for the current node. type: string port: description: The bound transport port for the current node. type: string name: description: The thread pool name. type: string type: description: 'The thread pool type. Returned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`.' type: string active: description: The number of active threads in the current thread pool. type: string pool_size: description: The number of threads in the current thread pool. type: string queue: description: The number of tasks currently in queue. type: string queue_size: description: The maximum number of tasks permitted in the queue. type: string rejected: description: The number of rejected tasks. type: string largest: description: The highest number of active threads in the current thread pool. type: string completed: description: The number of completed tasks. type: string core: description: The core number of active threads allowed in a scaling thread pool. oneOf: - type: string - type: - string - 'null' max: description: The maximum number of active threads allowed in a scaling thread pool. oneOf: - type: string - type: - string - 'null' size: description: The number of active threads allowed in a fixed thread pool. oneOf: - type: string - type: - string - 'null' keep_alive: description: The thread keep alive time. oneOf: - type: string - type: - string - 'null' cat._types.CatAliasesColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatAliasesColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatAliasesColumn' cat.repositories.RepositoriesRecord: type: object properties: id: description: The unique repository identifier. type: string type: description: The repository type. type: string cat._types.CatTemplatesColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatTemplatesColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatTemplatesColumn' _types.Percentage: oneOf: - type: string - type: number cat.snapshots.SnapshotsRecord: type: object properties: id: description: The unique identifier for the snapshot. type: string repository: description: The repository name. type: string status: description: 'The state of the snapshot process. Returned values include: `FAILED`: The snapshot process failed. `INCOMPATIBLE`: The snapshot process is incompatible with the current cluster version. `IN_PROGRESS`: The snapshot process started but has not completed. `PARTIAL`: The snapshot process completed with a partial success. `SUCCESS`: The snapshot process completed with a full success.' type: string start_epoch: description: The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started. allOf: - $ref: '#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds' start_time: description: The time (HH:MM:SS) at which the snapshot process started. allOf: - $ref: '#/components/schemas/watcher._types.ScheduleTimeOfDay' end_epoch: description: The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended. allOf: - $ref: '#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds' end_time: description: The time (HH:MM:SS) at which the snapshot process ended. allOf: - $ref: '#/components/schemas/_types.TimeOfDay' duration: description: The time it took the snapshot process to complete, in time units. allOf: - $ref: '#/components/schemas/_types.Duration' indices: description: The number of indices in the snapshot. type: string successful_shards: description: The number of successful shards in the snapshot. type: string failed_shards: description: The number of failed shards in the snapshot. type: string total_shards: description: The total number of shards in the snapshot. type: string reason: description: The reason for any snapshot failures. type: string cat.pending_tasks.PendingTasksRecord: type: object properties: insertOrder: description: The task insertion order. type: string timeInQueue: description: Indicates how long the task has been in queue. type: string priority: description: The task priority. type: string source: description: The task source. type: string cat._types.CatAnomalyDetectorColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatAnomalyDetectorColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatAnomalyDetectorColumn' cat.ml_data_frame_analytics.DataFrameAnalyticsRecord: type: object properties: id: description: The identifier for the job. allOf: - $ref: '#/components/schemas/_types.Id' type: description: The type of analysis that the job performs. type: string create_time: description: The time when the job was created. type: string version: description: The version of Elasticsearch when the job was created. allOf: - $ref: '#/components/schemas/_types.VersionString' source_index: description: The name of the source index. allOf: - $ref: '#/components/schemas/_types.IndexName' dest_index: description: The name of the destination index. allOf: - $ref: '#/components/schemas/_types.IndexName' description: description: A description of the job. type: string model_memory_limit: description: The approximate maximum amount of memory resources that are permitted for the job. type: string state: description: The current status of the job. type: string failure_reason: description: Messages about the reason why the job failed. type: string progress: description: The progress report for the job by phase. type: string assignment_explanation: description: Messages related to the selection of a node. type: string node.id: description: The unique identifier of the assigned node. allOf: - $ref: '#/components/schemas/_types.Id' node.name: description: The name of the assigned node. allOf: - $ref: '#/components/schemas/_types.Name' node.ephemeral_id: description: The ephemeral identifier of the assigned node. allOf: - $ref: '#/components/schemas/_types.Id' node.address: description: The network address of the assigned node. type: string cat._types.CatHealthColumn: anyOf: - type: string enum: - epoch - t - time - timestamp - ts - hms - hhmmss - cluster - cl - status - st - node.total - nt - nodeTotal - node.data - nd - nodeData - shards - t - sh - shards.total - shardsTotal - pri - p - shards.primary - shardsPrimary - relo - r - shards.relocating - shardsRelocating - init - i - shards.initializing - shardsInitializing - unassign - u - shards.unassigned - shardsUnassigned - unassign.pri - up - shards.unassigned.primary - shardsUnassignedPrimary - pending_tasks - pt - pendingTasks - max_task_wait_time - mtwt - maxTaskWaitTime - active_shards_percent - asp - activeShardsPercent - type: string _types.UnitMillis: description: Time unit for milliseconds type: number cat._types.CatShardColumn: anyOf: - type: string enum: - completion.size - cs - completionSize - dataset.size - dense_vector.value_count - dvc - denseVectorCount - docs - d - dc - fielddata.evictions - fe - fielddataEvictions - fielddata.memory_size - fm - fielddataMemory - flush.total - ft - flushTotal - flush.total_time - ftt - flushTotalTime - get.current - gc - getCurrent - get.exists_time - geti - getExistsTime - get.exists_total - geto - getExistsTotal - get.missing_time - gmti - getMissingTime - get.missing_total - gmto - getMissingTotal - get.time - gti - getTime - get.total - gto - getTotal - id - index - i - idx - indexing.delete_current - idc - indexingDeleteCurrent - indexing.delete_time - idti - indexingDeleteTime - indexing.delete_total - idto - indexingDeleteTotal - indexing.index_current - iic - indexingIndexCurrent - indexing.index_failed_due_to_version_conflict - iifvc - indexingIndexFailedDueToVersionConflict - indexing.index_failed - iif - indexingIndexFailed - indexing.index_time - iiti - indexingIndexTime - indexing.index_total - iito - indexingIndexTotal - ip - merges.current - mc - mergesCurrent - merges.current_docs - mcd - mergesCurrentDocs - merges.current_size - mcs - mergesCurrentSize - merges.total - mt - mergesTotal - merges.total_docs - mtd - mergesTotalDocs - merges.total_size - mts - mergesTotalSize - merges.total_time - mtt - mergesTotalTime - node - n - prirep - p - pr - primaryOrReplica - query_cache.evictions - qce - queryCacheEvictions - query_cache.memory_size - qcm - queryCacheMemory - recoverysource.type - rs - refresh.time - rti - refreshTime - refresh.total - rto - refreshTotal - search.fetch_current - sfc - searchFetchCurrent - search.fetch_time - sfti - searchFetchTime - search.fetch_total - sfto - searchFetchTotal - search.open_contexts - so - searchOpenContexts - search.query_current - sqc - searchQueryCurrent - search.query_time - sqti - searchQueryTime - search.query_total - sqto - searchQueryTotal - search.scroll_current - scc - searchScrollCurrent - search.scroll_time - scti - searchScrollTime - search.scroll_total - scto - searchScrollTotal - segments.count - sc - segmentsCount - segments.fixed_bitset_memory - sfbm - fixedBitsetMemory - segments.index_writer_memory - siwm - segmentsIndexWriterMemory - segments.memory - sm - segmentsMemory - segments.version_map_memory - svmm - segmentsVersionMapMemory - seq_no.global_checkpoint - sqg - globalCheckpoint - seq_no.local_checkpoint - sql - localCheckpoint - seq_no.max - sqm - maxSeqNo - shard - s - sh - dsparse_vector.value_count - svc - sparseVectorCount - state - st - store - sto - suggest.current - suc - suggestCurrent - suggest.time - suti - suggestTime - suggest.total - suto - suggestTotal - sync_id - unassigned.at - ua - unassigned.details - ud - unassigned.for - uf - unassigned.reason - ur - type: string cat._types.CatTrainedModelsColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatTrainedModelsColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatTrainedModelsColumn' _types.VersionString: type: string cat._types.CatFieldDataColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatFieldDataColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatFieldDataColumn' _types.EpochTimeUnitSeconds: allOf: - $ref: '#/components/schemas/_types.UnitSeconds' cat._types.CatSnapshotsColumn: anyOf: - type: string enum: - id - snapshot - repository - re - repo - status - s - start_epoch - ste - startEpoch - start_time - sti - startTime - end_epoch - ete - endEpoch - end_time - eti - endTime - duration - dur - indices - i - successful_shards - ss - failed_shards - fs - total_shards - ts - reason - r - type: string _types.IndexName: type: string cat._types.CatPendingTasksColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatPendingTasksColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatPendingTasksColumn' cat.master.MasterRecord: type: object properties: id: description: node id type: string host: description: host name type: string ip: description: ip address type: string node: description: node name type: string cat._types.CatShardColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatShardColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatShardColumn' _types.Fields: oneOf: - $ref: '#/components/schemas/_types.Field' - type: array items: $ref: '#/components/schemas/_types.Field' cat._types.CatAllocationColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatAllocationColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatAllocationColumn' cat._types.CatDatafeedColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatDatafeedColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatDatafeedColumn' cat.circuit_breaker.CircuitBreakerRecord: type: object properties: node_id: description: Persistent node ID allOf: - $ref: '#/components/schemas/_types.NodeId' node_name: description: Node name type: string breaker: description: Breaker name type: string limit: description: Limit size type: string limit_bytes: description: Limit size in bytes allOf: - $ref: '#/components/schemas/_types.ByteSize' estimated: description: Estimated size type: string estimated_bytes: description: Estimated size in bytes allOf: - $ref: '#/components/schemas/_types.ByteSize' tripped: description: Tripped count type: string overhead: description: Overhead type: string _types.UnitSeconds: description: Time unit for seconds type: number cat._types.CatAllocationColumn: anyOf: - type: string enum: - shards - s - shards.undesired - write_load.forecast - wlf - writeLoadForecast - disk.indices.forecast - dif - diskIndicesForecast - disk.indices - di - diskIndices - disk.used - du - diskUsed - disk.avail - da - diskAvail - disk.total - dt - diskTotal - disk.percent - dp - diskPercent - host - h - ip - node - n - node.role - r - role - nodeRole - type: string cat._types.CatDfaColumn: type: string enum: - assignment_explanation - ae - create_time - ct - createTime - description - d - dest_index - di - destIndex - failure_reason - fr - failureReason - id - model_memory_limit - mml - modelMemoryLimit - node.address - na - nodeAddress - node.ephemeral_id - ne - nodeEphemeralId - node.id - ni - nodeId - node.name - nn - nodeName - progress - p - source_index - si - sourceIndex - state - s - type - t - version - v cat._types.CatTemplatesColumn: anyOf: - type: string enum: - name - n - index_patterns - t - order - o - p - version - v - composed_of - c - type: string cat.nodes.NodesRecord: type: object properties: id: description: The unique node identifier. allOf: - $ref: '#/components/schemas/_types.Id' pid: description: The process identifier. type: string ip: description: The IP address. type: string port: description: The bound transport port. type: string http_address: description: The bound HTTP address. type: string version: description: The Elasticsearch version. allOf: - $ref: '#/components/schemas/_types.VersionString' flavor: description: The Elasticsearch distribution flavor. type: string type: description: The Elasticsearch distribution type. type: string build: description: The Elasticsearch build hash. type: string jdk: description: The Java version. type: string disk.total: description: The total disk space. allOf: - $ref: '#/components/schemas/_types.ByteSize' disk.used: description: The used disk space. allOf: - $ref: '#/components/schemas/_types.ByteSize' disk.avail: description: The available disk space. allOf: - $ref: '#/components/schemas/_types.ByteSize' disk.used_percent: description: The used disk space percentage. allOf: - $ref: '#/components/schemas/_types.Percentage' heap.current: description: The used heap. type: string heap.percent: description: The used heap ratio. allOf: - $ref: '#/components/schemas/_types.Percentage' heap.max: description: The maximum configured heap. type: string ram.current: description: The used machine memory. type: string ram.percent: description: The used machine memory ratio. allOf: - $ref: '#/components/schemas/_types.Percentage' ram.max: description: The total machine memory. type: string file_desc.current: description: The used file descriptors. type: string file_desc.percent: description: The used file descriptor ratio. allOf: - $ref: '#/components/schemas/_types.Percentage' file_desc.max: description: The maximum number of file descriptors. type: string cpu: description: The recent system CPU usage as a percentage. type: string load_1m: description: The load average for the most recent minute. type: string load_5m: description: The load average for the last five minutes. type: string load_15m: description: The load average for the last fifteen minutes. type: string available_processors: description: The number of available processors (logical CPU cores available to the JVM). type: string uptime: description: The node uptime. type: string node.role: description: 'The roles of the node. Returned values include `c`(cold node), `d`(data node), `f`(frozen node), `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (master eligible node), `r`(remote cluster client node), `s`(content node), `t`(transform node), `v`(voting-only node), `w`(warm node),and `-`(coordinating node only).' type: string master: description: 'Indicates whether the node is the elected master node. Returned values include `*`(elected master) and `-`(not elected master).' type: string name: description: The node name. allOf: - $ref: '#/components/schemas/_types.Name' completion.size: description: The size of completion. type: string fielddata.memory_size: description: The used fielddata cache. type: string fielddata.evictions: description: The fielddata evictions. type: string query_cache.memory_size: description: The used query cache. type: string query_cache.evictions: description: The query cache evictions. type: string query_cache.hit_count: description: The query cache hit counts. type: string query_cache.miss_count: description: The query cache miss counts. type: string request_cache.memory_size: description: The used request cache. type: string request_cache.evictions: description: The request cache evictions. type: string request_cache.hit_count: description: The request cache hit counts. type: string request_cache.miss_count: description: The request cache miss counts. type: string flush.total: description: The number of flushes. type: string flush.total_time: description: The time spent in flush. type: string get.current: description: The number of current get ops. type: string get.time: description: The time spent in get. type: string get.total: description: The number of get ops. type: string get.exists_time: description: The time spent in successful gets. type: string get.exists_total: description: The number of successful get operations. type: string get.missing_time: description: The time spent in failed gets. type: string get.missing_total: description: The number of failed gets. type: string indexing.delete_current: description: The number of current deletions. type: string indexing.delete_time: description: The time spent in deletions. type: string indexing.delete_total: description: The number of delete operations. type: string indexing.index_current: description: The number of current indexing operations. type: string indexing.index_time: description: The time spent in indexing. type: string indexing.index_total: description: The number of indexing operations. type: string indexing.index_failed: description: The number of failed indexing operations. type: string merges.current: description: The number of current merges. type: string merges.current_docs: description: The number of current merging docs. type: string merges.current_size: description: The size of current merges. type: string merges.total: description: The number of completed merge operations. type: string merges.total_docs: description: The docs merged. type: string merges.total_size: description: The size merged. type: string merges.total_time: description: The time spent in merges. type: string refresh.total: description: The total refreshes. type: string refresh.time: description: The time spent in refreshes. type: string refresh.external_total: description: The total external refreshes. type: string refresh.external_time: description: The time spent in external refreshes. type: string refresh.listeners: description: The number of pending refresh listeners. type: string script.compilations: description: The total script compilations. type: string script.cache_evictions: description: The total compiled scripts evicted from the cache. type: string script.compilation_limit_triggered: description: The script cache compilation limit triggered. type: string search.fetch_current: description: The current fetch phase operations. type: string search.fetch_time: description: The time spent in fetch phase. type: string search.fetch_total: description: The total fetch operations. type: string search.open_contexts: description: The open search contexts. type: string search.query_current: description: The current query phase operations. type: string search.query_time: description: The time spent in query phase. type: string search.query_total: description: The total query phase operations. type: string search.scroll_current: description: The open scroll contexts. type: string search.scroll_time: description: The time scroll contexts held open. type: string search.scroll_total: description: The completed scroll contexts. type: string segments.count: description: The number of segments. type: string segments.memory: description: The memory used by segments. type: string segments.index_writer_memory: description: The memory used by the index writer. type: string segments.version_map_memory: description: The memory used by the version map. type: string segments.fixed_bitset_memory: description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. type: string suggest.current: description: The number of current suggest operations. type: string suggest.time: description: The time spend in suggest. type: string suggest.total: description: The number of suggest operations. type: string bulk.total_operations: description: The number of bulk shard operations. type: string bulk.total_time: description: The time spend in shard bulk. type: string bulk.total_size_in_bytes: description: The total size in bytes of shard bulk. type: string bulk.avg_time: description: The average time spend in shard bulk. type: string bulk.avg_size_in_bytes: description: The average size in bytes of shard bulk. type: string cat._types.CatNodeattrsColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatNodeattrsColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatNodeattrsColumn' cat._types.CatTasksColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatTasksColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatTasksColumn' cat._types.CatNodeColumn: anyOf: - type: string enum: - build - b - completion.size - cs - completionSize - cpu - disk.avail - d - disk - diskAvail - disk.total - dt - diskTotal - disk.used - du - diskUsed - disk.used_percent - dup - diskUsedPercent - fielddata.evictions - fe - fielddataEvictions - fielddata.memory_size - fm - fielddataMemory - file_desc.current - fdc - fileDescriptorCurrent - file_desc.max - fdm - fileDescriptorMax - file_desc.percent - fdp - fileDescriptorPercent - flush.total - ft - flushTotal - flush.total_time - ftt - flushTotalTime - get.current - gc - getCurrent - get.exists_time - geti - getExistsTime - get.exists_total - geto - getExistsTotal - get.missing_time - gmti - getMissingTime - get.missing_total - gmto - getMissingTotal - get.time - gti - getTime - get.total - gto - getTotal - heap.current - hc - heapCurrent - heap.max - hm - heapMax - heap.percent - hp - heapPercent - http_address - http - id - nodeId - indexing.delete_current - idc - indexingDeleteCurrent - indexing.delete_time - idti - indexingDeleteTime - indexing.delete_total - idto - indexingDeleteTotal - indexing.index_current - iic - indexingIndexCurrent - indexing.index_failed - iif - indexingIndexFailed - indexing.index_failed_due_to_version_conflict - iifvc - indexingIndexFailedDueToVersionConflict - indexing.index_time - iiti - indexingIndexTime - indexing.index_total - iito - indexingIndexTotal - ip - i - jdk - j - load_1m - l - load_5m - l - load_15m - l - available_processors - ap - mappings.total_count - mtc - mappingsTotalCount - mappings.total_estimated_overhead_in_bytes - mteo - mappingsTotalEstimatedOverheadInBytes - master - m - merges.current - mc - mergesCurrent - merges.current_docs - mcd - mergesCurrentDocs - merges.current_size - mcs - mergesCurrentSize - merges.total - mt - mergesTotal - merges.total_docs - mtd - mergesTotalDocs - merges.total_size - mts - mergesTotalSize - merges.total_time - mtt - mergesTotalTime - name - n - node.role - r - role - nodeRole - pid - p - port - po - query_cache.memory_size - qcm - queryCacheMemory - query_cache.evictions - qce - queryCacheEvictions - query_cache.hit_count - qchc - queryCacheHitCount - query_cache.miss_count - qcmc - queryCacheMissCount - ram.current - rc - ramCurrent - ram.max - rm - ramMax - ram.percent - rp - ramPercent - refresh.total - rto - refreshTotal - refresh.time - rti - refreshTime - request_cache.memory_size - rcm - requestCacheMemory - request_cache.evictions - rce - requestCacheEvictions - request_cache.hit_count - rchc - requestCacheHitCount - request_cache.miss_count - rcmc - requestCacheMissCount - script.compilations - scrcc - scriptCompilations - script.cache_evictions - scrce - scriptCacheEvictions - search.fetch_current - sfc - searchFetchCurrent - search.fetch_time - sfti - searchFetchTime - search.fetch_total - sfto - searchFetchTotal - search.open_contexts - so - searchOpenContexts - search.query_current - sqc - searchQueryCurrent - search.query_time - sqti - searchQueryTime - search.query_total - sqto - searchQueryTotal - search.scroll_current - scc - searchScrollCurrent - search.scroll_time - scti - searchScrollTime - search.scroll_total - scto - searchScrollTotal - segments.count - sc - segmentsCount - segments.fixed_bitset_memory - sfbm - fixedBitsetMemory - segments.index_writer_memory - siwm - segmentsIndexWriterMemory - segments.memory - sm - segmentsMemory - segments.version_map_memory - svmm - segmentsVersionMapMemory - shard_stats.total_count - sstc - shards - shardStatsTotalCount - suggest.current - suc - suggestCurrent - suggest.time - suti - suggestTime - suggest.total - suto - suggestTotal - uptime - u - version - v - type: string cat._types.CatCircuitBreakerColumn: anyOf: - type: string enum: - node_id - id - node_name - nn - breaker - br - limit - l - limit_bytes - lb - estimated - e - estimated_bytes - eb - tripped - t - overhead - o - type: string _types.NodeId: type: string cat.component_templates.ComponentTemplate: type: object properties: name: type: string version: oneOf: - type: string - type: - string - 'null' alias_count: type: string mapping_count: type: string settings_count: type: string metadata_count: type: string included_in: type: string required: - name - version - alias_count - mapping_count - settings_count - metadata_count - included_in _types.HealthStatus: type: string enum: - green - GREEN - yellow - YELLOW - red - RED - unknown - unavailable ml._types.CategorizationStatus: type: string enum: - ok - warn _types.NodeIds: oneOf: - $ref: '#/components/schemas/_types.NodeId' - type: array items: $ref: '#/components/schemas/_types.NodeId' cat._types.CatTrainedModelsColumn: type: string enum: - create_time - ct - created_by - c - createdBy - data_frame_analytics_id - df - dataFrameAnalytics - dfid - description - d - heap_size - hs - modelHeapSize - id - ingest.count - ic - ingestCount - ingest.current - icurr - ingestCurrent - ingest.failed - if - ingestFailed - ingest.pipelines - ip - ingestPipelines - ingest.time - it - ingestTime - license - l - operations - o - modelOperations - version - v watcher._types.HourAndMinute: type: object properties: hour: type: array items: type: number minute: type: array items: type: number required: - hour - minute cat._types.CatPendingTasksColumn: anyOf: - type: string enum: - insertOrder - o - timeInQueue - t - priority - p - source - s - type: string cat.nodeattrs.NodeAttributesRecord: type: object properties: node: description: The node name. type: string id: description: The unique node identifier. type: string pid: description: The process identifier. type: string host: description: The host name. type: string ip: description: The IP address. type: string port: description: The bound transport port. type: string attr: description: The attribute name. type: string value: description: The attribute value. type: string cat.ml_jobs.JobsRecord: type: object properties: id: description: The anomaly detection job identifier. allOf: - $ref: '#/components/schemas/_types.Id' state: description: "The status of the anomaly detection job.\n\nSupported values include:\n - `closing`: The job close action is in progress and has not yet completed. A closing job cannot accept further data.\n - `closed`: The job finished successfully with its model state persisted. The job must be opened before it can accept further data.\n - `opened`: The job is available to receive and process data.\n - `failed`: The job did not finish successfully due to an error.\nThis situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer.\nIf the job had irrevocably failed, it must be force closed and then deleted.\nIf the datafeed can be corrected, the job can be closed and then re-opened.\n - `opening`: The job open action is in progress and has not yet completed.\n\n" allOf: - $ref: '#/components/schemas/ml._types.JobState' opened_time: description: For open jobs only, the amount of time the job has been opened. type: string assignment_explanation: description: For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job. type: string data.processed_records: description: 'The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the `processed_record_count` is the number of aggregation results processed, not the number of Elasticsearch documents.' type: string data.processed_fields: description: 'The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count.' type: string data.input_bytes: description: The number of bytes of input data posted to the anomaly detection job. allOf: - $ref: '#/components/schemas/_types.ByteSize' data.input_records: description: The number of input documents posted to the anomaly detection job. type: string data.input_fields: description: 'The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.' type: string data.invalid_dates: description: The number of input documents with either a missing date field or a date that could not be parsed. type: string data.missing_fields: description: 'The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high `missing_field_count` is often not an indication of data issues. It is not necessarily a cause for concern.' type: string data.out_of_order_timestamps: description: 'The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order.' type: string data.empty_buckets: description: 'The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your `bucket_span` or using functions that are tolerant to gaps in data such as mean, `non_null_sum` or `non_zero_count`.' type: string data.sparse_buckets: description: 'The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer `bucket_span`.' type: string data.buckets: description: The total number of buckets processed. type: string data.earliest_record: description: The timestamp of the earliest chronologically input document. type: string data.latest_record: description: The timestamp of the latest chronologically input document. type: string data.last: description: The timestamp at which data was last analyzed, according to server time. type: string data.last_empty_bucket: description: The timestamp of the last bucket that did not contain any data. type: string data.last_sparse_bucket: description: The timestamp of the last bucket that was considered sparse. type: string model.bytes: description: 'The number of bytes of memory used by the models. This is the maximum value since the last time the model was persisted. If the job is closed, this value indicates the latest size.' allOf: - $ref: '#/components/schemas/_types.ByteSize' model.memory_status: description: The status of the mathematical models. allOf: - $ref: '#/components/schemas/ml._types.MemoryStatus' model.bytes_exceeded: description: The number of bytes over the high limit for memory usage at the last allocation failure. allOf: - $ref: '#/components/schemas/_types.ByteSize' model.memory_limit: description: The upper limit for model memory usage, checked on increasing values. type: string model.by_fields: description: 'The number of `by` field values that were analyzed by the models. This value is cumulative for all detectors in the job.' type: string model.over_fields: description: 'The number of `over` field values that were analyzed by the models. This value is cumulative for all detectors in the job.' type: string model.partition_fields: description: 'The number of `partition` field values that were analyzed by the models. This value is cumulative for all detectors in the job.' type: string model.bucket_allocation_failures: description: 'The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a `hard_limit: memory_status` property value.' type: string model.categorization_status: description: The status of categorization for the job. allOf: - $ref: '#/components/schemas/ml._types.CategorizationStatus' model.categorized_doc_count: description: The number of documents that have had a field categorized. type: string model.total_category_count: description: The number of categories created by categorization. type: string model.frequent_category_count: description: The number of categories that match more than 1% of categorized documents. type: string model.rare_category_count: description: The number of categories that match just one categorized document. type: string model.dead_category_count: description: 'The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training.' type: string model.failed_category_count: description: 'The number of times that categorization wanted to create a new category but couldn’t because the job had hit its `model_memory_limit`. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed.' type: string model.log_time: description: The timestamp when the model stats were gathered, according to server time. type: string model.timestamp: description: The timestamp of the last record when the model stats were gathered. type: string forecasts.total: description: 'The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist.' type: string forecasts.memory.min: description: The minimum memory usage in bytes for forecasts related to the anomaly detection job. type: string forecasts.memory.max: description: The maximum memory usage in bytes for forecasts related to the anomaly detection job. type: string forecasts.memory.avg: description: The average memory usage in bytes for forecasts related to the anomaly detection job. type: string forecasts.memory.total: description: The total memory usage in bytes for forecasts related to the anomaly detection job. type: string forecasts.records.min: description: The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job. type: string forecasts.records.max: description: The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job. type: string forecasts.records.avg: description: The average number of `model_forecast` documents written for forecasts related to the anomaly detection job. type: string forecasts.records.total: description: The total number of `model_forecast` documents written for forecasts related to the anomaly detection job. type: string forecasts.time.min: description: The minimum runtime in milliseconds for forecasts related to the anomaly detection job. type: string forecasts.time.max: description: The maximum runtime in milliseconds for forecasts related to the anomaly detection job. type: string forecasts.time.avg: description: The average runtime in milliseconds for forecasts related to the anomaly detection job. type: string forecasts.time.total: description: The total runtime in milliseconds for forecasts related to the anomaly detection job. type: string node.id: description: The uniqe identifier of the assigned node. allOf: - $ref: '#/components/schemas/_types.NodeId' node.name: description: The name of the assigned node. type: string node.ephemeral_id: description: The ephemeral identifier of the assigned node. allOf: - $ref: '#/components/schemas/_types.NodeId' node.address: description: The network address of the assigned node. type: string buckets.count: description: The number of bucket results produced by the job. type: string buckets.time.total: description: The sum of all bucket processing times, in milliseconds. type: string buckets.time.min: description: The minimum of all bucket processing times, in milliseconds. type: string buckets.time.max: description: The maximum of all bucket processing times, in milliseconds. type: string buckets.time.exp_avg: description: The exponential moving average of all bucket processing times, in milliseconds. type: string buckets.time.exp_avg_hour: description: The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds. type: string _types.Indices: oneOf: - $ref: '#/components/schemas/_types.IndexName' - type: array items: $ref: '#/components/schemas/_types.IndexName' cat.segments.SegmentsRecord: type: object properties: index: description: The index name. allOf: - $ref: '#/components/schemas/_types.IndexName' shard: description: The shard name. type: string prirep: description: 'The shard type: `primary` or `replica`.' type: string ip: description: The IP address of the node where it lives. type: string id: description: The unique identifier of the node where it lives. allOf: - $ref: '#/components/schemas/_types.NodeId' segment: description: The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard. type: string generation: description: 'The segment generation number. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name.' type: string docs.count: description: 'The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.' type: string docs.deleted: description: 'The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.' type: string size: description: The segment size in bytes. allOf: - $ref: '#/components/schemas/_types.ByteSize' size.memory: description: 'The segment memory in bytes. A value of `-1` indicates Elasticsearch was unable to compute this number.' allOf: - $ref: '#/components/schemas/_types.ByteSize' committed: description: 'If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot. If `false`, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.' type: string searchable: description: 'If `true`, the segment is searchable. If `false`, the segment has most likely been written to disk but needs a refresh to be searchable.' type: string version: description: The version of Lucene used to write the segment. allOf: - $ref: '#/components/schemas/_types.VersionString' compound: description: 'If `true`, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.' type: string _types.Name: type: string watcher._types.ScheduleTimeOfDay: description: A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure. oneOf: - type: string - $ref: '#/components/schemas/watcher._types.HourAndMinute' cat._types.CatTransformColumn: type: string enum: - changes_last_detection_time - cldt - checkpoint - cp - checkpoint_duration_time_exp_avg - cdtea - checkpointTimeExpAvg - checkpoint_progress - c - checkpointProgress - create_time - ct - createTime - delete_time - dtime - description - d - dest_index - di - destIndex - documents_deleted - docd - documents_indexed - doci - docs_per_second - dps - documents_processed - docp - frequency - f - id - index_failure - if - index_time - itime - index_total - it - indexed_documents_exp_avg - idea - last_search_time - lst - lastSearchTime - max_page_search_size - mpsz - pages_processed - pp - pipeline - p - processed_documents_exp_avg - pdea - processing_time - pt - reason - r - search_failure - sf - search_time - stime - search_total - st - source_index - si - sourceIndex - state - s - transform_type - tt - trigger_count - tc - version - v cat.recovery.RecoveryRecord: type: object properties: index: description: The index name. allOf: - $ref: '#/components/schemas/_types.IndexName' shard: description: The shard name. type: string start_time: description: The recovery start time. allOf: - $ref: '#/components/schemas/_types.DateTime' start_time_millis: description: The recovery start time in epoch milliseconds. allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' stop_time: description: The recovery stop time. allOf: - $ref: '#/components/schemas/_types.DateTime' stop_time_millis: description: The recovery stop time in epoch milliseconds. allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' time: description: The recovery time. allOf: - $ref: '#/components/schemas/_types.Duration' type: description: The recovery type. type: string stage: description: The recovery stage. type: string source_host: description: The source host. type: string source_node: description: The source node name. type: string target_host: description: The target host. type: string target_node: description: The target node name. type: string repository: description: The repository name. type: string snapshot: description: The snapshot name. type: string files: description: The number of files to recover. type: string files_recovered: description: The files recovered. type: string files_percent: description: The ratio of files recovered. allOf: - $ref: '#/components/schemas/_types.Percentage' files_total: description: The total number of files. type: string bytes: description: The number of bytes to recover. type: string bytes_recovered: description: The bytes recovered. type: string bytes_percent: description: The ratio of bytes recovered. allOf: - $ref: '#/components/schemas/_types.Percentage' bytes_total: description: The total number of bytes. type: string translog_ops: description: The number of translog operations to recover. type: string translog_ops_recovered: description: The translog operations recovered. type: string translog_ops_percent: description: The ratio of translog operations recovered. allOf: - $ref: '#/components/schemas/_types.Percentage' cat._types.CatComponentColumn: anyOf: - type: string enum: - name - n - version - v - alias_count - a - mapping_count - m - settings_count - s - metadata_count - me - included_in - i - type: string cat.ml_trained_models.TrainedModelsRecord: type: object properties: id: description: The model identifier. allOf: - $ref: '#/components/schemas/_types.Id' created_by: description: Information about the creator of the model. type: string heap_size: description: The estimated heap size to keep the model in memory. allOf: - $ref: '#/components/schemas/_types.ByteSize' operations: description: 'The estimated number of operations to use the model. This number helps to measure the computational complexity of the model.' type: string license: description: The license level of the model. type: string create_time: description: The time the model was created. allOf: - $ref: '#/components/schemas/_types.DateTime' version: description: The version of Elasticsearch when the model was created. allOf: - $ref: '#/components/schemas/_types.VersionString' description: description: A description of the model. type: string ingest.pipelines: description: The number of pipelines that are referencing the model. type: string ingest.count: description: The total number of documents that are processed by the model. type: string ingest.time: description: The total time spent processing documents with thie model. type: string ingest.current: description: The total number of documents that are currently being handled by the model. type: string ingest.failed: description: The total number of failed ingest attempts with the model. type: string data_frame.id: description: 'The identifier for the data frame analytics job that created the model. Only displayed if the job is still available.' type: string data_frame.create_time: description: The time the data frame analytics job was created. type: string data_frame.source_index: description: The source index used to train in the data frame analysis. type: string data_frame.analysis: description: The analysis used by the data frame to build the model. type: string type: x-state: Generally available; Added in 8.0.0 type: string cat._types.CatSegmentsColumn: anyOf: - type: string enum: - index - i - idx - shard - s - sh - prirep - p - pr - primaryOrReplica - ip - segment - generation - docs.count - docs.deleted - size - size.memory - committed - searchable - version - compound - id - type: string cat.templates.TemplatesRecord: type: object properties: name: description: The template name. allOf: - $ref: '#/components/schemas/_types.Name' index_patterns: description: The template index patterns. type: string order: description: The template application order or priority number. type: string version: description: The template version. oneOf: - $ref: '#/components/schemas/_types.VersionString' - type: - string - 'null' composed_of: description: The component templates that comprise the index template. type: string _spec_utils.Stringifieddouble: description: '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 semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.' oneOf: - type: number - type: string cat._types.CatIndicesColumn: anyOf: - type: string enum: - health - h - status - s - index - i - idx - uuid - id - uuid - pri - p - shards.primary - shardsPrimary - rep - r - shards.replica - shardsReplica - docs.count - dc - docsCount - docs.deleted - dd - docsDeleted - creation.date - cd - creation.date.string - cds - store.size - ss - storeSize - pri.store.size - dataset.size - completion.size - cs - completionSize - pri.completion.size - fielddata.memory_size - fm - fielddataMemory - pri.fielddata.memory_size - fielddata.evictions - fe - fielddataEvictions - pri.fielddata.evictions - query_cache.memory_size - qcm - queryCacheMemory - pri.query_cache.memory_size - query_cache.evictions - qce - queryCacheEvictions - pri.query_cache.evictions - request_cache.memory_size - rcm - requestCacheMemory - pri.request_cache.memory_size - request_cache.evictions - rce - requestCacheEvictions - pri.request_cache.evictions - request_cache.hit_count - rchc - requestCacheHitCount - pri.request_cache.hit_count - request_cache.miss_count - rcmc - requestCacheMissCount - pri.request_cache.miss_count - flush.total - ft - flushTotal - pri.flush.total - flush.total_time - ftt - flushTotalTime - pri.flush.total_time - get.current - gc - getCurrent - pri.get.current - get.time - gti - getTime - pri.get.time - get.total - gto - getTotal - pri.get.total - get.exists_time - geti - getExistsTime - pri.get.exists_time - get.exists_total - geto - getExistsTotal - pri.get.exists_total - get.missing_time - gmti - getMissingTime - pri.get.missing_time - get.missing_total - gmto - getMissingTotal - pri.get.missing_total - indexing.delete_current - idc - indexingDeleteCurrent - pri.indexing.delete_current - indexing.delete_time - idti - indexingDeleteTime - pri.indexing.delete_time - indexing.delete_total - idto - indexingDeleteTotal - pri.indexing.delete_total - indexing.index_current - iic - indexingIndexCurrent - pri.indexing.index_current - indexing.index_time - iiti - indexingIndexTime - pri.indexing.index_time - indexing.index_total - iito - indexingIndexTotal - pri.indexing.index_total - indexing.index_failed - iif - indexingIndexFailed - pri.indexing.index_failed - indexing.index_failed_due_to_version_conflict - iifvc - indexingIndexFailedDueToVersionConflict - pri.indexing.index_failed_due_to_version_conflict - merges.current - mc - mergesCurrent - pri.merges.current - merges.current_docs - mcd - mergesCurrentDocs - pri.merges.current_docs - merges.current_size - mcs - mergesCurrentSize - pri.merges.current_size - merges.total - mt - mergesTotal - pri.merges.total - merges.total_docs - mtd - mergesTotalDocs - pri.merges.total_docs - merges.total_size - mts - mergesTotalSize - pri.merges.total_size - merges.total_time - mtt - mergesTotalTime - pri.merges.total_time - refresh.total - rto - refreshTotal - pri.refresh.total - refresh.time - rti - refreshTime - pri.refresh.time - refresh.external_total - rto - refreshTotal - pri.refresh.external_total - refresh.external_time - rti - refreshTime - pri.refresh.external_time - refresh.listeners - rli - refreshListeners - pri.refresh.listeners - search.fetch_current - sfc - searchFetchCurrent - pri.search.fetch_current - search.fetch_time - sfti - searchFetchTime - pri.search.fetch_time - search.fetch_total - sfto - searchFetchTotal - pri.search.fetch_total - search.open_contexts - so - searchOpenContexts - pri.search.open_contexts - search.query_current - sqc - searchQueryCurrent - pri.search.query_current - search.query_time - sqti - searchQueryTime - pri.search.query_time - search.query_total - sqto - searchQueryTotal - pri.search.query_total - search.scroll_current - scc - searchScrollCurrent - pri.search.scroll_current - search.scroll_time - scti - searchScrollTime - pri.search.scroll_time - search.scroll_total - scto - searchScrollTotal - pri.search.scroll_total - segments.count - sc - segmentsCount - pri.segments.count - segments.memory - sm - segmentsMemory - pri.segments.memory - segments.index_writer_memory - siwm - segmentsIndexWriterMemory - pri.segments.index_writer_memory - segments.version_map_memory - svmm - segmentsVersionMapMemory - pri.segments.version_map_memory - segments.fixed_bitset_memory - sfbm - fixedBitsetMemory - pri.segments.fixed_bitset_memory - warmer.current - wc - warmerCurrent - pri.warmer.current - warmer.total - wto - warmerTotal - pri.warmer.total - warmer.total_time - wtt - warmerTotalTime - pri.warmer.total_time - suggest.current - suc - suggestCurrent - pri.suggest.current - suggest.time - suti - suggestTime - pri.suggest.time - suggest.total - suto - suggestTotal - pri.suggest.total - memory.total - tm - memoryTotal - pri.memory.total - bulk.total_operations - bto - bulkTotalOperation - pri.bulk.total_operations - bulk.total_time - btti - bulkTotalTime - pri.bulk.total_time - bulk.total_size_in_bytes - btsi - bulkTotalSizeInBytes - pri.bulk.total_size_in_bytes - bulk.avg_time - bati - bulkAvgTime - pri.bulk.avg_time - bulk.avg_size_in_bytes - basi - bulkAvgSizeInBytes - pri.bulk.avg_size_in_bytes - dense_vector.value_count - dvc - denseVectorCount - pri.dense_vector.value_count - sparse_vector.value_count - svc - sparseVectorCount - pri.sparse_vector.value_count - type: string cat._types.CatCircuitBreakerColumns: oneOf: - $ref: '#/components/schemas/cat._types.CatCircuitBreakerColumn' - type: array items: $ref: '#/components/schemas/cat._types.CatCircuitBreakerColumn' securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: "Elasticsearch APIs support key-based authentication.\nYou must create an API key and use the encoded value in the request header.\nFor example:\n\n```\ncurl -X GET \"${ES_URL}/_cat/indices?v=true\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n```\n\nTo get API keys, use the `/_security/api_key` APIs." basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer description: 'Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API. For examples, refer to [Token-based authentication services](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)' x-tagGroups: - name: AI & Machine Learning tags: - analytics - graph - inference - ml - ml anomaly - ml data frame - ml trained model - query_rules - text_structure - name: Cluster Management tags: - ccr - cluster - connector - data stream - ilm - indices - rollup - script - search_application - searchable_snapshots - slm - snapshot - name: Data Processing tags: - enrich - fleet - ingest - logstash - synonyms - transform - name: Information & Monitoring tags: - cat - features - health_report - info - license - migration - tasks - watcher - xpack - name: Search & Document APIs tags: - document - eql - esql - search - sql - name: Security tags: - security