` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.\n\nLearn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide.\n\n## Required authorization\n\n* Index privileges: `read`\n",
"externalDocs": {
"description": "More about mapbox vector tiles",
"url": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-vector-tile-api.html"
},
"operationId": "search-mvt",
"parameters": [
{
"$ref": "#/components/parameters/search_mvt-index"
},
{
"$ref": "#/components/parameters/search_mvt-field"
},
{
"$ref": "#/components/parameters/search_mvt-zoom"
},
{
"$ref": "#/components/parameters/search_mvt-x"
},
{
"$ref": "#/components/parameters/search_mvt-y"
},
{
"$ref": "#/components/parameters/search_mvt-exact_bounds"
},
{
"$ref": "#/components/parameters/search_mvt-extent"
},
{
"$ref": "#/components/parameters/search_mvt-grid_agg"
},
{
"$ref": "#/components/parameters/search_mvt-grid_precision"
},
{
"$ref": "#/components/parameters/search_mvt-grid_type"
},
{
"$ref": "#/components/parameters/search_mvt-size"
},
{
"$ref": "#/components/parameters/search_mvt-track_total_hits"
},
{
"$ref": "#/components/parameters/search_mvt-with_labels"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/search_mvt"
},
"responses": {
"200": {
"$ref": "#/components/responses/search_mvt-200"
}
},
"x-state": "Generally available; Added in 7.15.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET museums/_mvt/location/13/4207/2692\n{\n \"grid_agg\": \"geotile\",\n \"grid_precision\": 2,\n \"fields\": [\n \"name\",\n \"price\"\n ],\n \"query\": {\n \"term\": {\n \"included\": true\n }\n },\n \"aggs\": {\n \"min_price\": {\n \"min\": {\n \"field\": \"price\"\n }\n },\n \"max_price\": {\n \"max\": {\n \"field\": \"price\"\n }\n },\n \"avg_price\": {\n \"avg\": {\n \"field\": \"price\"\n }\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.search_mvt(\n index=\"museums\",\n field=\"location\",\n zoom=\"13\",\n x=\"4207\",\n y=\"2692\",\n grid_agg=\"geotile\",\n grid_precision=2,\n fields=[\n \"name\",\n \"price\"\n ],\n query={\n \"term\": {\n \"included\": True\n }\n },\n aggs={\n \"min_price\": {\n \"min\": {\n \"field\": \"price\"\n }\n },\n \"max_price\": {\n \"max\": {\n \"field\": \"price\"\n }\n },\n \"avg_price\": {\n \"avg\": {\n \"field\": \"price\"\n }\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.searchMvt({\n index: \"museums\",\n field: \"location\",\n zoom: 13,\n x: 4207,\n y: 2692,\n grid_agg: \"geotile\",\n grid_precision: 2,\n fields: [\"name\", \"price\"],\n query: {\n term: {\n included: true,\n },\n },\n aggs: {\n min_price: {\n min: {\n field: \"price\",\n },\n },\n max_price: {\n max: {\n field: \"price\",\n },\n },\n avg_price: {\n avg: {\n field: \"price\",\n },\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.search_mvt(\n index: \"museums\",\n field: \"location\",\n zoom: \"13\",\n x: \"4207\",\n y: \"2692\",\n body: {\n \"grid_agg\": \"geotile\",\n \"grid_precision\": 2,\n \"fields\": [\n \"name\",\n \"price\"\n ],\n \"query\": {\n \"term\": {\n \"included\": true\n }\n },\n \"aggs\": {\n \"min_price\": {\n \"min\": {\n \"field\": \"price\"\n }\n },\n \"max_price\": {\n \"max\": {\n \"field\": \"price\"\n }\n },\n \"avg_price\": {\n \"avg\": {\n \"field\": \"price\"\n }\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->searchMvt([\n \"index\" => \"museums\",\n \"field\" => \"location\",\n \"zoom\" => \"13\",\n \"x\" => \"4207\",\n \"y\" => \"2692\",\n \"body\" => [\n \"grid_agg\" => \"geotile\",\n \"grid_precision\" => 2,\n \"fields\" => array(\n \"name\",\n \"price\",\n ),\n \"query\" => [\n \"term\" => [\n \"included\" => true,\n ],\n ],\n \"aggs\" => [\n \"min_price\" => [\n \"min\" => [\n \"field\" => \"price\",\n ],\n ],\n \"max_price\" => [\n \"max\" => [\n \"field\" => \"price\",\n ],\n ],\n \"avg_price\" => [\n \"avg\" => [\n \"field\" => \"price\",\n ],\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"grid_agg\":\"geotile\",\"grid_precision\":2,\"fields\":[\"name\",\"price\"],\"query\":{\"term\":{\"included\":true}},\"aggs\":{\"min_price\":{\"min\":{\"field\":\"price\"}},\"max_price\":{\"max\":{\"field\":\"price\"}},\"avg_price\":{\"avg\":{\"field\":\"price\"}}}}' \"$ELASTICSEARCH_URL/museums/_mvt/location/13/4207/2692\""
},
{
"lang": "Java",
"source": "client.searchMvt(s -> s\n .aggs(Map.of(\"max_price\", Aggregation.of(a -> a\n .max(m -> m\n .field(\"price\")\n )\n .aggregations(Map.of())\n .meta(Map.of())\n ),\"min_price\", Aggregation.of(ag -> ag\n .min(m -> m\n .field(\"price\")\n )\n .aggregations(Map.of())\n .meta(Map.of())\n ),\"avg_price\", Aggregation.of(agg -> agg\n .avg(av -> av\n .field(\"price\")\n )\n .aggregations(Map.of())\n .meta(Map.of())\n )))\n .field(\"location\")\n .fields(List.of(\"name\",\"price\"))\n .gridAgg(GridAggregationType.Geotile)\n .gridPrecision(2)\n .index(\"museums\")\n .query(q -> q\n .term(t -> t\n .field(\"included\")\n .value(FieldValue.of(true))\n )\n )\n .runtimeMappings(Map.of())\n .sort(List.of())\n .x(4207)\n .y(2692)\n .zoom(13)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/{index}/_search_shards": {
"post": {
"tags": [
"search"
],
"summary": "Get the search shards\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_search_shards\n
\n \n POST\n /_search_shards\n
\n \n GET\n /{index}/_search_shards\n
\n \n POST\n /{index}/_search_shards\n
\n \n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.\n\n## Required authorization\n\n* Index privileges: `view_index_metadata`\n",
"operationId": "search-shards",
"parameters": [
{
"$ref": "#/components/parameters/search_shards-index"
},
{
"$ref": "#/components/parameters/search_shards-allow_no_indices"
},
{
"$ref": "#/components/parameters/search_shards-expand_wildcards"
},
{
"$ref": "#/components/parameters/search_shards-ignore_unavailable"
},
{
"$ref": "#/components/parameters/search_shards-local"
},
{
"$ref": "#/components/parameters/search_shards-master_timeout"
},
{
"$ref": "#/components/parameters/search_shards-preference"
},
{
"$ref": "#/components/parameters/search_shards-routing"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/search_shards-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /my-index-000001/_search_shards\n"
},
{
"lang": "Python",
"source": "resp = client.search_shards(\n index=\"my-index-000001\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.searchShards({\n index: \"my-index-000001\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.search_shards(\n index: \"my-index-000001\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->searchShards([\n \"index\" => \"my-index-000001\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index-000001/_search_shards\""
},
{
"lang": "Java",
"source": "client.searchShards(s -> s\n .expandWildcards(List.of())\n .index(\"my-index-000001\")\n .routing(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/{index}/_search/template": {
"post": {
"tags": [
"search"
],
"summary": "Run a search with a search template\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_search/template\n
\n \n POST\n /_search/template\n
\n \n GET\n /{index}/_search/template\n
\n \n POST\n /{index}/_search/template\n
\n\n## Required authorization\n\n* Index privileges: `read`\n",
"externalDocs": {
"description": "More about searching templates",
"url": "https://www.elastic.co/docs/solutions/search/search-templates",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-template-api.html"
},
"operationId": "search-template",
"parameters": [
{
"$ref": "#/components/parameters/search_template-index"
},
{
"$ref": "#/components/parameters/search_template-allow_no_indices"
},
{
"$ref": "#/components/parameters/search_template-ccs_minimize_roundtrips"
},
{
"$ref": "#/components/parameters/search_template-expand_wildcards"
},
{
"$ref": "#/components/parameters/search_template-explain"
},
{
"$ref": "#/components/parameters/search_template-ignore_throttled"
},
{
"$ref": "#/components/parameters/search_template-ignore_unavailable"
},
{
"$ref": "#/components/parameters/search_template-preference"
},
{
"$ref": "#/components/parameters/search_template-profile"
},
{
"$ref": "#/components/parameters/search_template-routing"
},
{
"$ref": "#/components/parameters/search_template-scroll"
},
{
"$ref": "#/components/parameters/search_template-search_type"
},
{
"$ref": "#/components/parameters/search_template-rest_total_hits_as_int"
},
{
"$ref": "#/components/parameters/search_template-typed_keys"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/search_template"
},
"responses": {
"200": {
"$ref": "#/components/responses/search_template-200"
}
},
"x-state": "Generally available; Added in 2.0.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET my-index/_search/template\n{\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.search_template(\n index=\"my-index\",\n id=\"my-search-template\",\n params={\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.searchTemplate({\n index: \"my-index\",\n id: \"my-search-template\",\n params: {\n query_string: \"hello world\",\n from: 0,\n size: 10,\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.search_template(\n index: \"my-index\",\n body: {\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->searchTemplate([\n \"index\" => \"my-index\",\n \"body\" => [\n \"id\" => \"my-search-template\",\n \"params\" => [\n \"query_string\" => \"hello world\",\n \"from\" => 0,\n \"size\" => 10,\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"id\":\"my-search-template\",\"params\":{\"query_string\":\"hello world\",\"from\":0,\"size\":10}}' \"$ELASTICSEARCH_URL/my-index/_search/template\""
},
{
"lang": "Java",
"source": "client.searchTemplate(s -> s\n .expandWildcards(List.of())\n .id(\"my-search-template\")\n .index(\"my-index\")\n .params(Map.of(\"size\", JsonData.fromJson(\"10\"),\"from\", JsonData.fromJson(\"0\"),\"query_string\", JsonData.fromJson(\"\\\"hello world\\\"\")))\n .routing(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_searchable_snapshots/{node_id}/cache/stats": {
"get": {
"tags": [
"searchable_snapshots"
],
"summary": "Get cache statistics\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_searchable_snapshots/cache/stats\n
\n \n GET\n /_searchable_snapshots/{node_id}/cache/stats\n
\n \n\nGet statistics about the shared cache for partially mounted indices.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"externalDocs": {
"description": "More about searchable snapshots",
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-cache-stats.html"
},
"operationId": "searchable-snapshots-cache-stats",
"parameters": [
{
"$ref": "#/components/parameters/searchable_snapshots.cache_stats-node_id"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/searchable_snapshots.cache_stats-200"
}
},
"x-state": "Experimental; Added in 7.13.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_searchable_snapshots/cache/stats\n"
},
{
"lang": "Python",
"source": "resp = client.searchable_snapshots.cache_stats()"
},
{
"lang": "JavaScript",
"source": "const response = await client.searchableSnapshots.cacheStats();"
},
{
"lang": "Ruby",
"source": "response = client.searchable_snapshots.cache_stats"
},
{
"lang": "PHP",
"source": "$resp = $client->searchableSnapshots()->cacheStats();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_searchable_snapshots/cache/stats\""
},
{
"lang": "Java",
"source": "client.searchableSnapshots().cacheStats(c -> c\n .nodeId(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/{index}/_searchable_snapshots/cache/clear": {
"post": {
"tags": [
"searchable_snapshots"
],
"summary": "Clear the cache\n",
"description": "**All methods and paths for this operation:**\n\n\n POST\n /_searchable_snapshots/cache/clear\n
\n \n POST\n /{index}/_searchable_snapshots/cache/clear\n
\n \n\nClear indices and data streams from the shared cache for partially mounted indices.\n\n## Required authorization\n\n* Index privileges: `manage`\n* Cluster privileges: `manage`\n",
"externalDocs": {
"description": "More about searchable snapshots",
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-clear-cache.html"
},
"operationId": "searchable-snapshots-clear-cache",
"parameters": [
{
"$ref": "#/components/parameters/searchable_snapshots.clear_cache-index"
},
{
"$ref": "#/components/parameters/searchable_snapshots.clear_cache-expand_wildcards"
},
{
"$ref": "#/components/parameters/searchable_snapshots.clear_cache-allow_no_indices"
},
{
"$ref": "#/components/parameters/searchable_snapshots.clear_cache-ignore_unavailable"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/searchable_snapshots.clear_cache-200"
}
},
"x-state": "Experimental; Added in 7.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /my-index/_searchable_snapshots/cache/clear\n"
},
{
"lang": "Python",
"source": "resp = client.searchable_snapshots.clear_cache(\n index=\"my-index\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.searchableSnapshots.clearCache({\n index: \"my-index\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.searchable_snapshots.clear_cache(\n index: \"my-index\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->searchableSnapshots()->clearCache([\n \"index\" => \"my-index\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index/_searchable_snapshots/cache/clear\""
},
{
"lang": "Java",
"source": "client.searchableSnapshots().clearCache(c -> c\n .expandWildcards(List.of())\n .index(\"my-index\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/{snapshot}/_mount": {
"post": {
"tags": [
"searchable_snapshots"
],
"summary": "Mount a snapshot",
"description": "Mount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.\n\n## Required authorization\n\n* Index privileges: `manage`\n* Cluster privileges: `manage`\n",
"operationId": "searchable-snapshots-mount",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The name of the repository containing the snapshot of the index to mount.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "path",
"name": "snapshot",
"description": "The name of the snapshot of the index to mount.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_completion",
"description": "If true, the request blocks until the operation is complete.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "storage",
"description": "The mount option for the searchable snapshot index.\nFor further information on mount options, refer to: [Mount options](https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots#searchable-snapshot-mount-storage-options)\n\nSupported values include:\n - `full_copy`: Fully caches the snapshotted index’s shards in the Elasticsearch cluster.\n - `shared_cache`: Uses a local cache containing only recently searched parts of the snapshotted index’s data.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/searchable_snapshots.mount.StorageOption"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index": {
"description": "The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"renamed_index": {
"description": "The name of the index that will be created.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"index_settings": {
"description": "The settings that should be added to the index when it is mounted.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"ignore_index_settings": {
"description": "The names of settings that should be removed from the index when it is mounted.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"index"
]
},
"examples": {
"SearchableSnapshotsMountSnapshotRequestExample1": {
"description": "Run `POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true` to mount the index `my_docs` from an existing snapshot named `my_snapshot` stored in `my_repository` as a new index `docs`.\n",
"value": "{\n \"index\": \"my_docs\",\n \"renamed_index\": \"docs\",\n \"index_settings\": {\n \"index.number_of_replicas\": 0\n },\n \"ignore_index_settings\": [ \"index.refresh_interval\" ]\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"snapshot": {
"allOf": [
{
"$ref": "#/components/schemas/searchable_snapshots.mount.MountedSnapshot"
}
]
}
},
"required": [
"snapshot"
]
}
}
}
}
},
"x-state": "Generally available; Added in 7.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true\n{\n \"index\": \"my_docs\",\n \"renamed_index\": \"docs\",\n \"index_settings\": {\n \"index.number_of_replicas\": 0\n },\n \"ignore_index_settings\": [ \"index.refresh_interval\" ]\n}"
},
{
"lang": "Python",
"source": "resp = client.searchable_snapshots.mount(\n repository=\"my_repository\",\n snapshot=\"my_snapshot\",\n wait_for_completion=True,\n index=\"my_docs\",\n renamed_index=\"docs\",\n index_settings={\n \"index.number_of_replicas\": 0\n },\n ignore_index_settings=[\n \"index.refresh_interval\"\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.searchableSnapshots.mount({\n repository: \"my_repository\",\n snapshot: \"my_snapshot\",\n wait_for_completion: \"true\",\n index: \"my_docs\",\n renamed_index: \"docs\",\n index_settings: {\n \"index.number_of_replicas\": 0,\n },\n ignore_index_settings: [\"index.refresh_interval\"],\n});"
},
{
"lang": "Ruby",
"source": "response = client.searchable_snapshots.mount(\n repository: \"my_repository\",\n snapshot: \"my_snapshot\",\n wait_for_completion: \"true\",\n body: {\n \"index\": \"my_docs\",\n \"renamed_index\": \"docs\",\n \"index_settings\": {\n \"index.number_of_replicas\": 0\n },\n \"ignore_index_settings\": [\n \"index.refresh_interval\"\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->searchableSnapshots()->mount([\n \"repository\" => \"my_repository\",\n \"snapshot\" => \"my_snapshot\",\n \"wait_for_completion\" => \"true\",\n \"body\" => [\n \"index\" => \"my_docs\",\n \"renamed_index\" => \"docs\",\n \"index_settings\" => [\n \"index.number_of_replicas\" => 0,\n ],\n \"ignore_index_settings\" => array(\n \"index.refresh_interval\",\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"index\":\"my_docs\",\"renamed_index\":\"docs\",\"index_settings\":{\"index.number_of_replicas\":0},\"ignore_index_settings\":[\"index.refresh_interval\"]}' \"$ELASTICSEARCH_URL/_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true\""
},
{
"lang": "Java",
"source": "client.searchableSnapshots().mount(m -> m\n .ignoreIndexSettings(\"index.refresh_interval\")\n .index(\"my_docs\")\n .indexSettings(\"index.number_of_replicas\", JsonData.fromJson(\"0\"))\n .renamedIndex(\"docs\")\n .repository(\"my_repository\")\n .snapshot(\"my_snapshot\")\n .waitForCompletion(true)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/{index}/_searchable_snapshots/stats": {
"get": {
"tags": [
"searchable_snapshots"
],
"summary": "Get searchable snapshot statistics\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_searchable_snapshots/stats\n
\n \n GET\n /{index}/_searchable_snapshots/stats\n
\n\n## Required authorization\n\n* Index privileges: `manage`\n* Cluster privileges: `manage`\n",
"operationId": "searchable-snapshots-stats",
"parameters": [
{
"$ref": "#/components/parameters/searchable_snapshots.stats-index"
},
{
"$ref": "#/components/parameters/searchable_snapshots.stats-level"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/searchable_snapshots.stats-200"
}
},
"x-state": "Generally available; Added in 7.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /my-index/_searchable_snapshots/stats\n"
},
{
"lang": "Python",
"source": "resp = client.searchable_snapshots.stats(\n index=\"my-index\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.searchableSnapshots.stats({\n index: \"my-index\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.searchable_snapshots.stats(\n index: \"my-index\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->searchableSnapshots()->stats([\n \"index\" => \"my-index\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index/_searchable_snapshots/stats\""
},
{
"lang": "Java",
"source": "client.searchableSnapshots().stats(s -> s\n .index(\"my-index\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/profile/_activate": {
"post": {
"tags": [
"security"
],
"summary": "Activate a user profile",
"description": "Create or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields.\n\n## Required authorization\n\n* Cluster privileges: `manage_user_profile`\n",
"operationId": "security-activate-user-profile",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access_token": {
"description": "The user's Elasticsearch access token or JWT.\nBoth `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.",
"type": "string"
},
"grant_type": {
"description": "The type of grant.\n\nSupported values include:\n - `password`: In this type of grant, you must supply the user ID and password for which you want to create the API key.\n - `access_token`: In this type of grant, you must supply an access token that was created by the Elasticsearch token service.\nIf you are activating a user profile, you can alternatively supply a JWT (either a JWT `access_token` or a JWT `id_token`).\n\n",
"allOf": [
{
"$ref": "#/components/schemas/security._types.GrantType"
}
]
},
"password": {
"description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.",
"type": "string"
},
"username": {
"description": "The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.",
"type": "string"
}
},
"required": [
"grant_type"
]
},
"examples": {
"ActivateUserProfileRequestExample1": {
"description": "Run `POST /_security/profile/_activate` to activate a user profile.\n",
"value": "{\n \"grant_type\": \"password\",\n \"username\" : \"jacknich\",\n \"password\" : \"l0ng-r4nd0m-p@ssw0rd\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/security._types.UserProfileWithMetadata"
},
"examples": {
"ActivateUserProfileResponseExample1": {
"description": "A successful response from `POST /_security/profile/_activate`.",
"value": "{\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {},\n \"data\": {},\n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/profile/_activate\n{\n \"grant_type\": \"password\",\n \"username\" : \"jacknich\",\n \"password\" : \"l0ng-r4nd0m-p@ssw0rd\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.activate_user_profile(\n grant_type=\"password\",\n username=\"jacknich\",\n password=\"l0ng-r4nd0m-p@ssw0rd\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.activateUserProfile({\n grant_type: \"password\",\n username: \"jacknich\",\n password: \"l0ng-r4nd0m-p@ssw0rd\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.activate_user_profile(\n body: {\n \"grant_type\": \"password\",\n \"username\": \"jacknich\",\n \"password\": \"l0ng-r4nd0m-p@ssw0rd\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->activateUserProfile([\n \"body\" => [\n \"grant_type\" => \"password\",\n \"username\" => \"jacknich\",\n \"password\" => \"l0ng-r4nd0m-p@ssw0rd\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"grant_type\":\"password\",\"username\":\"jacknich\",\"password\":\"l0ng-r4nd0m-p@ssw0rd\"}' \"$ELASTICSEARCH_URL/_security/profile/_activate\""
},
{
"lang": "Java",
"source": "client.security().activateUserProfile(a -> a\n .grantType(GrantType.Password)\n .password(\"l0ng-r4nd0m-p@ssw0rd\")\n .username(\"jacknich\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/_authenticate": {
"get": {
"tags": [
"security"
],
"summary": "Authenticate a user",
"description": "Authenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.",
"operationId": "security-authenticate",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"api_key": {
"allOf": [
{
"$ref": "#/components/schemas/security.authenticate.AuthenticateApiKey"
}
]
},
"authentication_realm": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.RealmInfo"
}
]
},
"email": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"full_name": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Name"
},
{
"nullable": true,
"type": "string"
}
]
},
"lookup_realm": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.RealmInfo"
}
]
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
},
"enabled": {
"type": "boolean"
},
"authentication_type": {
"type": "string"
},
"token": {
"x-state": "Generally available; Added in 7.14.0",
"allOf": [
{
"$ref": "#/components/schemas/security.authenticate.Token"
}
]
}
},
"required": [
"authentication_realm",
"lookup_realm",
"metadata",
"roles",
"username",
"enabled",
"authentication_type"
]
},
"examples": {
"SecurityAuthenticateResponseExample1": {
"description": "A successful response from `GET /_security/_authenticate`.",
"value": "{\n \"username\": \"rdeniro\",\n \"roles\": [\n \"admin\"\n ],\n \"full_name\": null,\n \"email\": null,\n \"metadata\": { },\n \"enabled\": true,\n \"authentication_realm\": {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"lookup_realm\": {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"authentication_type\": \"realm\"\n}"
},
"SecurityAuthenticateResponseExample2": {
"description": "A successful response from `GET /_security/_authenticate` for access token authentication.",
"value": "{\n \"username\": \"0000000001\",\n \"roles\": [\n \"admin\"\n ],\n \"full_name\": \"Peter Parker\",\n \"email\": \"spider-man@marvel.com\",\n \"metadata\": {},\n \"enabled\": true,\n \"authentication_realm\": {\n \"name\": \"cloud-saml-kibana\",\n \"type\": \"saml\"\n },\n \"lookup_realm\": {\n \"name\": \"cloud-saml-kibana\",\n \"type\": \"saml\"\n },\n \"authentication_type\": \"token\",\n \"token\": {\n \"managed_by\": \"cloud\"\n }\n}"
},
"SecurityAuthenticateResponseExample3": {
"description": "A successful response from `GET /_security/_authenticate` for service account token authentication.",
"value": "{\n \"username\": \"elastic/fleet-server\",\n \"roles\": [ ],\n \"full_name\": \"Service account - elastic/fleet-server\",\n \"email\": null,\n \"metadata\": {\n \"_elastic_service_account\": true\n },\n \"enabled\": true,\n \"authentication_realm\": {\n \"name\": \"_service_account\",\n \"type\": \"_service_account\"\n },\n \"lookup_realm\": {\n \"name\": \"_service_account\",\n \"type\": \"_service_account\"\n },\n \"authentication_type\": \"token\",\n \"token\": {\n \"type\": \"_service_account_index\",\n \"name\": \"token_abcd1234\",\n \"managed_by\": \"elasticsearch\"\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 5.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/_authenticate\n"
},
{
"lang": "Python",
"source": "resp = client.security.authenticate()"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.authenticate();"
},
{
"lang": "Ruby",
"source": "response = client.security.authenticate"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->authenticate();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/_authenticate\""
},
{
"lang": "Java",
"source": "client.security().authenticate();\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/role": {
"post": {
"tags": [
"security"
],
"summary": "Bulk create or update roles",
"description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-bulk-put-role",
"parameters": [
{
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"roles": {
"description": "A dictionary of role name to RoleDescriptor objects to add or update",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleDescriptor"
}
}
},
"required": [
"roles"
]
},
"examples": {
"SecurityBulkPutRoleRequestExample1": {
"summary": "Bulk role success",
"description": "Run `POST /_security/role` to add roles called `my_admin_role` and `my_user_role`.\n",
"value": "{\n \"roles\": {\n \"my_admin_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\n \"all\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n },\n \"my_user_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n }\n }\n}"
},
"SecurityBulkPutRoleRequestExample2": {
"summary": "Bulk role errors",
"description": "Because errors are handled individually for each role create or update, the API allows partial success. For example, `POST /_security/role` would throw an error for `my_admin_role` because the privilege `bad_cluster_privilege` doesn't exist, but would be successful for the `my_user_role`.\n",
"value": "{\n \"roles\": {\n \"my_admin_role\": {\n \"cluster\": [\n \"bad_cluster_privilege\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\"all\"],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n },\n \"my_user_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n }\n }\n}"
},
"SecurityBulkPutRoleRequestExample3": {
"summary": "Role example 3",
"description": "Run `POST /_security/role/only_remote_access_role` to configure a role with remote indices and remote cluster privileges for a remote cluster.",
"value": "{\n \"remote_indices\": [\n {\n \"clusters\": [\"my_remote\"], \n \"names\": [\"logs*\"], \n \"privileges\": [\"read\", \"read_cross_cluster\", \"view_index_metadata\"] \n }\n ],\n \"remote_cluster\": [\n {\n \"clusters\": [\"my_remote\"], \n \"privileges\": [\"monitor_stats\"] \n }\n ]\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"created": {
"description": "Array of created roles",
"type": "array",
"items": {
"type": "string"
}
},
"updated": {
"description": "Array of updated roles",
"type": "array",
"items": {
"type": "string"
}
},
"noop": {
"description": "Array of role names without any changes",
"type": "array",
"items": {
"type": "string"
}
},
"errors": {
"description": "Present if any updates resulted in errors",
"allOf": [
{
"$ref": "#/components/schemas/security._types.BulkError"
}
]
}
}
},
"examples": {
"SecurityBulkPutRoleResponseExample1": {
"summary": "A successful response",
"description": "A successful response from `POST /_security/role/my_admin_role` returns a JSON structure that shows whether the role has been created, updated, or had no changes made.\n",
"value": "{\n \"created\": [ \n \"my_admin_role\", \n \"my_user_role\"\n ]\n}"
},
"SecurityBulkPutRoleResponseExample2": {
"summary": "A partially successful response",
"description": "A partially successful response from `POST /_security/role`. Errors are handled individually for each role create or update, thus the API allows partial success. In this example, the creation of the `my_user_role` role succeeds and the `my_admin_role` role fails.\n",
"value": "{\n \"created\": [\n \"my_user_role\" \n ],\n \"errors\": { \n \"count\": 1, \n \"details\": {\n \"my_admin_role\": { \n \"type\": \"action_request_validation_exception\",\n \"reason\": \"Validation Failed: 1: unknown cluster privilege [bad_cluster_privilege]. a privilege must be either one of the predefined cluster privilege names [manage_own_api_key,manage_data_stream_global_retention,monitor_data_stream_global_retention,none,cancel_task,cross_cluster_replication,cross_cluster_search,delegate_pki,grant_api_key,manage_autoscaling,manage_index_templates,manage_logstash_pipelines,manage_oidc,manage_saml,manage_search_application,manage_search_query_rules,manage_search_synonyms,manage_service_account,manage_token,manage_user_profile,monitor_connector,monitor_enrich,monitor_inference,monitor_ml,monitor_rollup,monitor_snapshot,monitor_stats,monitor_text_structure,monitor_watcher,post_behavioral_analytics_event,read_ccr,read_connector_secrets,read_fleet_secrets,read_ilm,read_pipeline,read_security,read_slm,transport_client,write_connector_secrets,write_fleet_secrets,create_snapshot,manage_behavioral_analytics,manage_ccr,manage_connector,manage_enrich,manage_ilm,manage_inference,manage_ml,manage_rollup,manage_slm,manage_watcher,monitor_data_frame_transforms,monitor_transform,manage_api_key,manage_ingest_pipelines,manage_pipeline,manage_data_frame_transforms,manage_transform,manage_security,monitor,manage,all] or a pattern over one of the available cluster actions;\"\n }\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.15.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/role\n{\n \"roles\": {\n \"my_admin_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\n \"all\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n },\n \"my_user_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.bulk_put_role(\n roles={\n \"my_admin_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\n \"all\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n },\n \"my_user_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.bulkPutRole({\n roles: {\n my_admin_role: {\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index1\", \"index2\"],\n privileges: [\"all\"],\n field_security: {\n grant: [\"title\", \"body\"],\n },\n query: '{\"match\": {\"title\": \"foo\"}}',\n },\n ],\n applications: [\n {\n application: \"myapp\",\n privileges: [\"admin\", \"read\"],\n resources: [\"*\"],\n },\n ],\n run_as: [\"other_user\"],\n metadata: {\n version: 1,\n },\n },\n my_user_role: {\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index1\"],\n privileges: [\"read\"],\n field_security: {\n grant: [\"title\", \"body\"],\n },\n query: '{\"match\": {\"title\": \"foo\"}}',\n },\n ],\n applications: [\n {\n application: \"myapp\",\n privileges: [\"admin\", \"read\"],\n resources: [\"*\"],\n },\n ],\n run_as: [\"other_user\"],\n metadata: {\n version: 1,\n },\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.bulk_put_role(\n body: {\n \"roles\": {\n \"my_admin_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\n \"all\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n },\n \"my_user_role\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->bulkPutRole([\n \"body\" => [\n \"roles\" => [\n \"my_admin_role\" => [\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index1\",\n \"index2\",\n ),\n \"privileges\" => array(\n \"all\",\n ),\n \"field_security\" => [\n \"grant\" => array(\n \"title\",\n \"body\",\n ),\n ],\n \"query\" => \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\",\n ],\n ),\n \"applications\" => array(\n [\n \"application\" => \"myapp\",\n \"privileges\" => array(\n \"admin\",\n \"read\",\n ),\n \"resources\" => array(\n \"*\",\n ),\n ],\n ),\n \"run_as\" => array(\n \"other_user\",\n ),\n \"metadata\" => [\n \"version\" => 1,\n ],\n ],\n \"my_user_role\" => [\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index1\",\n ),\n \"privileges\" => array(\n \"read\",\n ),\n \"field_security\" => [\n \"grant\" => array(\n \"title\",\n \"body\",\n ),\n ],\n \"query\" => \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\",\n ],\n ),\n \"applications\" => array(\n [\n \"application\" => \"myapp\",\n \"privileges\" => array(\n \"admin\",\n \"read\",\n ),\n \"resources\" => array(\n \"*\",\n ),\n ],\n ),\n \"run_as\" => array(\n \"other_user\",\n ),\n \"metadata\" => [\n \"version\" => 1,\n ],\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"roles\":{\"my_admin_role\":{\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index1\",\"index2\"],\"privileges\":[\"all\"],\"field_security\":{\"grant\":[\"title\",\"body\"]},\"query\":\"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"}],\"applications\":[{\"application\":\"myapp\",\"privileges\":[\"admin\",\"read\"],\"resources\":[\"*\"]}],\"run_as\":[\"other_user\"],\"metadata\":{\"version\":1}},\"my_user_role\":{\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index1\"],\"privileges\":[\"read\"],\"field_security\":{\"grant\":[\"title\",\"body\"]},\"query\":\"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"}],\"applications\":[{\"application\":\"myapp\",\"privileges\":[\"admin\",\"read\"],\"resources\":[\"*\"]}],\"run_as\":[\"other_user\"],\"metadata\":{\"version\":1}}}}' \"$ELASTICSEARCH_URL/_security/role\""
},
{
"lang": "Java",
"source": "client.security().bulkPutRole(b -> b\n .roles(Map.of(\"my_admin_role\", RoleDescriptor.roleDescriptorOf(r -> r\n .cluster(\"all\")\n .indices(i -> i\n .fieldSecurity(f -> f\n .except(List.of())\n .grant(List.of(\"title\",\"body\"))\n )\n .names(List.of(\"index1\",\"index2\"))\n .privileges(\"all\")\n .query(q -> q\n .match(m -> m\n .field(\"title\")\n .query(FieldValue.of(\"foo\"))\n )\n )\n )\n .remoteIndices(List.of())\n .remoteCluster(List.of())\n .global(List.of())\n .applications(a -> a\n .application(\"myapp\")\n .privileges(List.of(\"admin\",\"read\"))\n .resources(\"*\")\n )\n .metadata(\"version\", JsonData.fromJson(\"1\"))\n .runAs(\"other_user\")\n .transientMetadata(Map.of())\n ),\"my_user_role\", RoleDescriptor.roleDescriptorOf(ro -> ro\n .cluster(\"all\")\n .indices(i -> i\n .fieldSecurity(f -> f\n .except(List.of())\n .grant(List.of(\"title\",\"body\"))\n )\n .names(\"index1\")\n .privileges(\"read\")\n .query(q -> q\n .match(m -> m\n .field(\"title\")\n .query(FieldValue.of(\"foo\"))\n )\n )\n )\n .remoteIndices(List.of())\n .remoteCluster(List.of())\n .global(List.of())\n .applications(a -> a\n .application(\"myapp\")\n .privileges(List.of(\"admin\",\"read\"))\n .resources(\"*\")\n )\n .metadata(\"version\", JsonData.fromJson(\"1\"))\n .runAs(\"other_user\")\n .transientMetadata(Map.of())\n )))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"security"
],
"summary": "Bulk delete roles",
"description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-bulk-delete-role",
"parameters": [
{
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"names": {
"description": "An array of role names to delete",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"names"
]
},
"examples": {
"SecurityBulkDeleteRoleRequestExample1": {
"summary": "Bulk delete example 1",
"description": "Run DELETE /_security/role` to delete `my_admin_role` and `my_user_role` roles.\n",
"value": "{\n \"names\": [\"my_admin_role\", \"my_user_role\"]\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted": {
"description": "Array of deleted roles",
"type": "array",
"items": {
"type": "string"
}
},
"not_found": {
"description": "Array of roles that could not be found",
"type": "array",
"items": {
"type": "string"
}
},
"errors": {
"description": "Present if any deletes resulted in errors",
"allOf": [
{
"$ref": "#/components/schemas/security._types.BulkError"
}
]
}
}
},
"examples": {
"SecurityBulkDeleteRoleResponseExample1": {
"summary": "A successful response",
"description": "A successful response from `DELETE /_security/role`.",
"value": "{\n \"deleted\": [\n \"my_admin_role\",\n \"my_user_role\"\n ]\n}"
},
"SecurityBulkDeleteRoleResponseExample2": {
"summary": "A response with not_found roles",
"description": "A partially successful response from `DELETE /_security/role`. If a role cannot be found, it appears in the `not_found` list in the response.\n",
"value": "{\n \"deleted\": [\n \"my_admin_role\"\n ],\n \"not_found\": [\n \"not_an_existing_role\"\n ]\n}"
},
"SecurityBulkDeleteRoleResponseExample3": {
"summary": "A response with errors",
"description": "A partially successful response from `DELETE /_security/role`. If part of a request fails or is invalid, the response includes `errors`.\n",
"value": "{\n \"deleted\": [\n \"my_admin_role\"\n ],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"superuser\": {\n \"type\": \"illegal_argument_exception\",\n \"reason\": \"role [superuser] is reserved and cannot be deleted\"\n }\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.15.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_security/role\n{\n \"names\": [\"my_admin_role\", \"my_user_role\"]\n}"
},
{
"lang": "Python",
"source": "resp = client.security.bulk_delete_role(\n names=[\n \"my_admin_role\",\n \"my_user_role\"\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.bulkDeleteRole({\n names: [\"my_admin_role\", \"my_user_role\"],\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.bulk_delete_role(\n body: {\n \"names\": [\n \"my_admin_role\",\n \"my_user_role\"\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->bulkDeleteRole([\n \"body\" => [\n \"names\" => array(\n \"my_admin_role\",\n \"my_user_role\",\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"names\":[\"my_admin_role\",\"my_user_role\"]}' \"$ELASTICSEARCH_URL/_security/role\""
},
{
"lang": "Java",
"source": "client.security().bulkDeleteRole(b -> b\n .names(List.of(\"my_admin_role\",\"my_user_role\"))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/api_key/_bulk_update": {
"post": {
"tags": [
"security"
],
"summary": "Bulk update API keys",
"description": "Update the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`\n",
"operationId": "security-bulk-update-api-keys",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expiration": {
"description": "Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"ids": {
"description": "The API key identifiers.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"metadata": {
"description": "Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"role_descriptors": {
"description": "The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleDescriptor"
}
}
},
"required": [
"ids"
]
},
"examples": {
"SecurityBulkUpdateApiKeysRequestExample1": {
"description": "Assign new role descriptors and metadata and update the expiration time for two API keys.",
"value": "{\n \"ids\": [\n \"VuaCfGcBCdbkQm-e5aOx\",\n \"H3_AhoIBA9hmeQJdg7ij\"\n ],\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"write\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\n \"production\"\n ]\n }\n },\n \"expiration\": \"30d\"\n}"
},
"SecurityBulkUpdateApiKeysRequestExample2": {
"description": "Remove the previously assigned permissions for two API keys, making them inherit the owner user's full permissions.",
"value": "{\n \"ids\": [\n \"VuaCfGcBCdbkQm-e5aOx\",\n \"H3_AhoIBA9hmeQJdg7ij\"\n ],\n \"role_descriptors\": {}\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.BulkError"
}
]
},
"noops": {
"type": "array",
"items": {
"type": "string"
}
},
"updated": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"noops",
"updated"
]
},
"examples": {
"SecurityBulkUpdateApiKeysResponseExample1": {
"description": "A successful response from updating two API keys.",
"value": "{\n \"updated\": [\n \"VuaCfGcBCdbkQm-e5aOx\",\n \"H3_AhoIBA9hmeQJdg7ij\"\n ],\n \"noops\": []\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/api_key/_bulk_update\n{\n \"ids\": [\n \"VuaCfGcBCdbkQm-e5aOx\",\n \"H3_AhoIBA9hmeQJdg7ij\"\n ],\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"write\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\n \"production\"\n ]\n }\n },\n \"expiration\": \"30d\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.bulk_update_api_keys(\n ids=[\n \"VuaCfGcBCdbkQm-e5aOx\",\n \"H3_AhoIBA9hmeQJdg7ij\"\n ],\n role_descriptors={\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"write\"\n ]\n }\n ]\n }\n },\n metadata={\n \"environment\": {\n \"level\": 2,\n \"trusted\": True,\n \"tags\": [\n \"production\"\n ]\n }\n },\n expiration=\"30d\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.bulkUpdateApiKeys({\n ids: [\"VuaCfGcBCdbkQm-e5aOx\", \"H3_AhoIBA9hmeQJdg7ij\"],\n role_descriptors: {\n \"role-a\": {\n indices: [\n {\n names: [\"*\"],\n privileges: [\"write\"],\n },\n ],\n },\n },\n metadata: {\n environment: {\n level: 2,\n trusted: true,\n tags: [\"production\"],\n },\n },\n expiration: \"30d\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.bulk_update_api_keys(\n body: {\n \"ids\": [\n \"VuaCfGcBCdbkQm-e5aOx\",\n \"H3_AhoIBA9hmeQJdg7ij\"\n ],\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"write\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\n \"production\"\n ]\n }\n },\n \"expiration\": \"30d\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->bulkUpdateApiKeys([\n \"body\" => [\n \"ids\" => array(\n \"VuaCfGcBCdbkQm-e5aOx\",\n \"H3_AhoIBA9hmeQJdg7ij\",\n ),\n \"role_descriptors\" => [\n \"role-a\" => [\n \"indices\" => array(\n [\n \"names\" => array(\n \"*\",\n ),\n \"privileges\" => array(\n \"write\",\n ),\n ],\n ),\n ],\n ],\n \"metadata\" => [\n \"environment\" => [\n \"level\" => 2,\n \"trusted\" => true,\n \"tags\" => array(\n \"production\",\n ),\n ],\n ],\n \"expiration\" => \"30d\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"ids\":[\"VuaCfGcBCdbkQm-e5aOx\",\"H3_AhoIBA9hmeQJdg7ij\"],\"role_descriptors\":{\"role-a\":{\"indices\":[{\"names\":[\"*\"],\"privileges\":[\"write\"]}]}},\"metadata\":{\"environment\":{\"level\":2,\"trusted\":true,\"tags\":[\"production\"]}},\"expiration\":\"30d\"}' \"$ELASTICSEARCH_URL/_security/api_key/_bulk_update\""
},
{
"lang": "Java",
"source": "client.security().bulkUpdateApiKeys(b -> b\n .expiration(e -> e\n .time(\"30d\")\n )\n .ids(List.of(\"VuaCfGcBCdbkQm-e5aOx\",\"H3_AhoIBA9hmeQJdg7ij\"))\n .metadata(\"environment\", JsonData.fromJson(\"\"\"\n{\"level\":2,\"trusted\":true,\"tags\":[\"production\"]}\n\"\"\"))\n .roleDescriptors(\"role-a\", r -> r\n .cluster(List.of())\n .indices(i -> i\n .names(\"*\")\n .privileges(\"write\")\n )\n .remoteIndices(List.of())\n .remoteCluster(List.of())\n .global(List.of())\n .applications(List.of())\n .metadata(Map.of())\n .runAs(List.of())\n .transientMetadata(Map.of())\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/user/{username}/_password": {
"post": {
"tags": [
"security"
],
"summary": "Change passwords\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/user/_password\n
\n \n POST\n /_security/user/_password\n
\n \n PUT\n /_security/user/{username}/_password\n
\n \n POST\n /_security/user/{username}/_password\n
\n \n\nChange the passwords of users in the native realm and built-in users.",
"operationId": "security-change-password",
"parameters": [
{
"$ref": "#/components/parameters/security.change_password-username"
},
{
"$ref": "#/components/parameters/security.change_password-refresh"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.change_password"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.change_password-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/user/jacknich/_password\n{\n \"password\" : \"new-test-password\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.change_password(\n username=\"jacknich\",\n password=\"new-test-password\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.changePassword({\n username: \"jacknich\",\n password: \"new-test-password\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.change_password(\n username: \"jacknich\",\n body: {\n \"password\": \"new-test-password\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->changePassword([\n \"username\" => \"jacknich\",\n \"body\" => [\n \"password\" => \"new-test-password\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"password\":\"new-test-password\"}' \"$ELASTICSEARCH_URL/_security/user/jacknich/_password\""
},
{
"lang": "Java",
"source": "client.security().changePassword(c -> c\n .password(\"new-test-password\")\n .username(\"jacknich\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/api_key/{ids}/_clear_cache": {
"post": {
"tags": [
"security"
],
"summary": "Clear the API key cache",
"description": "Evict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-clear-api-key-cache",
"parameters": [
{
"in": "path",
"name": "ids",
"description": "Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_nodes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
},
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.ClusterNode"
}
}
},
"required": [
"_nodes",
"cluster_name",
"nodes"
]
}
}
}
}
},
"x-state": "Generally available; Added in 7.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache\n"
},
{
"lang": "Python",
"source": "resp = client.security.clear_api_key_cache(\n ids=\"yVGMr3QByxdh1MSaicYx\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.clearApiKeyCache({\n ids: \"yVGMr3QByxdh1MSaicYx\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.clear_api_key_cache(\n ids: \"yVGMr3QByxdh1MSaicYx\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->clearApiKeyCache([\n \"ids\" => \"yVGMr3QByxdh1MSaicYx\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache\""
},
{
"lang": "Java",
"source": "client.security().clearApiKeyCache(c -> c\n .ids(\"yVGMr3QByxdh1MSaicYx\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/privilege/{application}/_clear_cache": {
"post": {
"tags": [
"security"
],
"summary": "Clear the privileges cache",
"description": "Evict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-clear-cached-privileges",
"parameters": [
{
"in": "path",
"name": "application",
"description": "A comma-separated list of applications.\nTo clear all applications, use an asterism (`*`).\nIt does not support other wildcard patterns.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_nodes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
},
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.ClusterNode"
}
}
},
"required": [
"_nodes",
"cluster_name",
"nodes"
]
}
}
}
}
},
"x-state": "Generally available; Added in 7.9.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/privilege/myapp/_clear_cache\n"
},
{
"lang": "Python",
"source": "resp = client.security.clear_cached_privileges(\n application=\"myapp\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.clearCachedPrivileges({\n application: \"myapp\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.clear_cached_privileges(\n application: \"myapp\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->clearCachedPrivileges([\n \"application\" => \"myapp\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/privilege/myapp/_clear_cache\""
},
{
"lang": "Java",
"source": "client.security().clearCachedPrivileges(c -> c\n .application(\"myapp\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/realm/{realms}/_clear_cache": {
"post": {
"tags": [
"security"
],
"summary": "Clear the user cache",
"description": "Evict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.",
"externalDocs": {
"description": "About controlling the user cache",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-user-cache",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-clear-cache.html"
},
"operationId": "security-clear-cached-realms",
"parameters": [
{
"in": "path",
"name": "realms",
"description": "A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
{
"in": "query",
"name": "usernames",
"description": "A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_nodes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
},
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.ClusterNode"
}
}
},
"required": [
"_nodes",
"cluster_name",
"nodes"
]
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/realm/default_file/_clear_cache\n"
},
{
"lang": "Python",
"source": "resp = client.security.clear_cached_realms(\n realms=\"default_file\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.clearCachedRealms({\n realms: \"default_file\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.clear_cached_realms(\n realms: \"default_file\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->clearCachedRealms([\n \"realms\" => \"default_file\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/realm/default_file/_clear_cache\""
},
{
"lang": "Java",
"source": "client.security().clearCachedRealms(c -> c\n .realms(\"default_file\")\n .usernames(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/role/{name}/_clear_cache": {
"post": {
"tags": [
"security"
],
"summary": "Clear the roles cache",
"description": "Evict roles from the native role cache.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-clear-cached-roles",
"parameters": [
{
"in": "path",
"name": "name",
"description": "A comma-separated list of roles to evict from the role cache.\nTo evict all roles, use an asterisk (`*`).\nIt does not support other wildcard patterns.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_nodes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
},
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.ClusterNode"
}
}
},
"required": [
"_nodes",
"cluster_name",
"nodes"
]
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/role/my_admin_role/_clear_cache\n"
},
{
"lang": "Python",
"source": "resp = client.security.clear_cached_roles(\n name=\"my_admin_role\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.clearCachedRoles({\n name: \"my_admin_role\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.clear_cached_roles(\n name: \"my_admin_role\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->clearCachedRoles([\n \"name\" => \"my_admin_role\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/role/my_admin_role/_clear_cache\""
},
{
"lang": "Java",
"source": "client.security().clearCachedRoles(c -> c\n .name(\"my_admin_role\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache": {
"post": {
"tags": [
"security"
],
"summary": "Clear service account token caches",
"description": "Evict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "More about service accounts",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-clear-service-token-caches.html"
},
"operationId": "security-clear-cached-service-tokens",
"parameters": [
{
"in": "path",
"name": "namespace",
"description": "The namespace, which is a top-level grouping of service accounts.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Namespace"
},
"style": "simple"
},
{
"in": "path",
"name": "service",
"description": "The name of the service, which must be unique within its namespace.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Service"
},
"style": "simple"
},
{
"in": "path",
"name": "name",
"description": "A comma-separated list of token names to evict from the service account token caches.\nUse a wildcard (`*`) to evict all tokens that belong to a service account.\nIt does not support other wildcard patterns.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_nodes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
},
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.ClusterNode"
}
}
},
"required": [
"_nodes",
"cluster_name",
"nodes"
]
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/service/elastic/fleet-server/credential/token/token1/_clear_cache\n"
},
{
"lang": "Python",
"source": "resp = client.security.clear_cached_service_tokens(\n namespace=\"elastic\",\n service=\"fleet-server\",\n name=\"token1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.clearCachedServiceTokens({\n namespace: \"elastic\",\n service: \"fleet-server\",\n name: \"token1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.clear_cached_service_tokens(\n namespace: \"elastic\",\n service: \"fleet-server\",\n name: \"token1\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->clearCachedServiceTokens([\n \"namespace\" => \"elastic\",\n \"service\" => \"fleet-server\",\n \"name\" => \"token1\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/service/elastic/fleet-server/credential/token/token1/_clear_cache\""
},
{
"lang": "Java",
"source": "client.security().clearCachedServiceTokens(c -> c\n .name(\"token1\")\n .namespace(\"elastic\")\n .service(\"fleet-server\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/api_key/clone": {
"put": {
"tags": [
"security"
],
"summary": "Clone an API key\n",
"description": "**All methods and paths for this operation:**\n\n\n POST\n /_security/api_key/clone\n
\n \n PUT\n /_security/api_key/clone\n
\n \n\nCreate a copy of an existing API key with a new ID.\nThe cloned key inherits the role descriptors of the source key.\nThis is intended for applications (such as Kibana) that need to\ncreate API keys on behalf of a user using an existing API key credential,\nsince derived API keys (API keys created by API keys) are not otherwise supported.\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`\n",
"operationId": "security-clone-api-key",
"parameters": [
{
"$ref": "#/components/parameters/security.clone_api_key-refresh"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.clone_api_key"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.clone_api_key-200"
}
},
"x-state": "Experimental; Added in 9.4.0",
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/api_key": {
"get": {
"tags": [
"security"
],
"summary": "Get API key information",
"description": "Retrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`,`read_security`\n",
"operationId": "security-get-api-key",
"parameters": [
{
"in": "query",
"name": "id",
"description": "An API key id.\nThis parameter cannot be used with any of `name`, `realm_name` or `username`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "form"
},
{
"in": "query",
"name": "name",
"description": "An API key name.\nThis parameter cannot be used with any of `id`, `realm_name` or `username`.\nIt supports prefix search with wildcard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "form"
},
{
"in": "query",
"name": "owner",
"description": "A boolean flag that can be used to query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "realm_name",
"description": "The name of an authentication realm.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "form"
},
{
"in": "query",
"name": "username",
"description": "The username of a user.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Username"
},
"style": "form"
},
{
"in": "query",
"name": "with_limited_by",
"description": "Return the snapshot of the owner user's role descriptors\nassociated with the API key. An API key's actual\npermission is the intersection of its assigned role\ndescriptors and the owner user's role descriptors.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.5.0",
"style": "form"
},
{
"in": "query",
"name": "active_only",
"description": "A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.10.0",
"style": "form"
},
{
"in": "query",
"name": "with_profile_uid",
"description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.14.0",
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"api_keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ApiKey"
}
}
},
"required": [
"api_keys"
]
},
"examples": {
"SecurityGetApiKeyResponseExample1": {
"summary": "Get a key by ID",
"description": "A successful response from `GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true`.",
"value": "{\n \"api_keys\": [ \n {\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\", \n \"name\": \"my-api-key\", \n \"creation\": 1548550550158, \n \"expiration\": 1548551550158, \n \"invalidated\": false, \n \"username\": \"myuser\", \n \"realm\": \"native1\", \n \"realm_type\": \"native\",\n \"metadata\": { \n \"application\": \"myapp\"\n },\n \"role_descriptors\": { }, \n \"limited_by\": [ \n {\n \"role-power-user\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n ]\n }\n ]\n}"
},
"SecurityGetApiKeyResponseExample2": {
"summary": "Get all keys for a user",
"description": "A successful response from `GET /_security/api_key?username=myuser&realm_name=native1`. The response contains all API keys for the user `myuser` in the `native1` realm.\n",
"value": "{\n \"api_keys\": [\n {\n \"id\": \"0GF5GXsBCXxz2eDxWwFN\",\n \"name\": \"hadoop_myuser_key\",\n \"creation\": 1548550550158,\n \"expiration\": 1548551550158,\n \"invalidated\": false,\n \"username\": \"myuser\",\n \"realm\": \"native1\",\n \"realm_type\": \"native\",\n \"metadata\": {\n \"application\": \"myapp\"\n },\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n },\n {\n \"id\": \"6wHJmcQpReKBa42EHV5SBw\",\n \"name\": \"api-key-name-2\",\n \"creation\": 1548550550158,\n \"invalidated\": false,\n \"username\": \"user-y\",\n \"realm\": \"realm-2\",\n \"metadata\": {},\n \"role_descriptors\": { }\n }\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 6.7.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/api_key?username=myuser&realm_name=native1\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_api_key(\n username=\"myuser\",\n realm_name=\"native1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getApiKey({\n username: \"myuser\",\n realm_name: \"native1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_api_key(\n username: \"myuser\",\n realm_name: \"native1\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getApiKey([\n \"username\" => \"myuser\",\n \"realm_name\" => \"native1\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/api_key?username=myuser&realm_name=native1\""
},
{
"lang": "Java",
"source": "client.security().getApiKey(g -> g\n .realmName(\"native1\")\n .username(\"myuser\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"post": {
"tags": [
"security"
],
"summary": "Create an API key\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/api_key\n
\n \n POST\n /_security/api_key\n
\n \n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`\n",
"externalDocs": {
"description": "About API key service settings",
"url": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-create-api-key.html"
},
"operationId": "security-create-api-key",
"parameters": [
{
"$ref": "#/components/parameters/security.create_api_key-refresh"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.create_api_key"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.create_api_key-200"
}
},
"x-state": "Generally available; Added in 6.7.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/api_key\n{\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\", \n \"role_descriptors\": { \n \"role-a\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-a*\"],\n \"privileges\": [\"read\"]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-b*\"],\n \"privileges\": [\"all\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\"dev\", \"staging\"]\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.create_api_key(\n name=\"my-api-key\",\n expiration=\"1d\",\n role_descriptors={\n \"role-a\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a*\"\n ],\n \"privileges\": [\n \"read\"\n ]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-b*\"\n ],\n \"privileges\": [\n \"all\"\n ]\n }\n ]\n }\n },\n metadata={\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": True,\n \"tags\": [\n \"dev\",\n \"staging\"\n ]\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.createApiKey({\n name: \"my-api-key\",\n expiration: \"1d\",\n role_descriptors: {\n \"role-a\": {\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index-a*\"],\n privileges: [\"read\"],\n },\n ],\n },\n \"role-b\": {\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index-b*\"],\n privileges: [\"all\"],\n },\n ],\n },\n },\n metadata: {\n application: \"my-application\",\n environment: {\n level: 1,\n trusted: true,\n tags: [\"dev\", \"staging\"],\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.create_api_key(\n body: {\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\",\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a*\"\n ],\n \"privileges\": [\n \"read\"\n ]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-b*\"\n ],\n \"privileges\": [\n \"all\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\n \"dev\",\n \"staging\"\n ]\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->createApiKey([\n \"body\" => [\n \"name\" => \"my-api-key\",\n \"expiration\" => \"1d\",\n \"role_descriptors\" => [\n \"role-a\" => [\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index-a*\",\n ),\n \"privileges\" => array(\n \"read\",\n ),\n ],\n ),\n ],\n \"role-b\" => [\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index-b*\",\n ),\n \"privileges\" => array(\n \"all\",\n ),\n ],\n ),\n ],\n ],\n \"metadata\" => [\n \"application\" => \"my-application\",\n \"environment\" => [\n \"level\" => 1,\n \"trusted\" => true,\n \"tags\" => array(\n \"dev\",\n \"staging\",\n ),\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"name\":\"my-api-key\",\"expiration\":\"1d\",\"role_descriptors\":{\"role-a\":{\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index-a*\"],\"privileges\":[\"read\"]}]},\"role-b\":{\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index-b*\"],\"privileges\":[\"all\"]}]}},\"metadata\":{\"application\":\"my-application\",\"environment\":{\"level\":1,\"trusted\":true,\"tags\":[\"dev\",\"staging\"]}}}' \"$ELASTICSEARCH_URL/_security/api_key\""
},
{
"lang": "Java",
"source": "client.security().createApiKey(c -> c\n .expiration(e -> e\n .time(\"1d\")\n )\n .metadata(Map.of(\"environment\", JsonData.fromJson(\"\"\"\n{\"level\":1,\"trusted\":true,\"tags\":[\"dev\",\"staging\"]}\n\"\"\"),\"application\", JsonData.fromJson(\"\\\"my-application\\\"\")))\n .name(\"my-api-key\")\n .roleDescriptors(Map.of(\"role-b\", RoleDescriptor.roleDescriptorOf(r -> r\n .cluster(\"all\")\n .indices(i -> i\n .names(\"index-b*\")\n .privileges(\"all\")\n )\n .remoteIndices(List.of())\n .remoteCluster(List.of())\n .global(List.of())\n .applications(List.of())\n .metadata(Map.of())\n .runAs(List.of())\n .transientMetadata(Map.of())\n ),\"role-a\", RoleDescriptor.roleDescriptorOf(r -> r\n .cluster(\"all\")\n .indices(i -> i\n .names(\"index-a*\")\n .privileges(\"read\")\n )\n .remoteIndices(List.of())\n .remoteCluster(List.of())\n .global(List.of())\n .applications(List.of())\n .metadata(Map.of())\n .runAs(List.of())\n .transientMetadata(Map.of())\n )))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"security"
],
"summary": "Invalidate API keys",
"description": "This API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\n\nTo use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges.\nThe `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys.\nThe `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys.\nThe `manage_own_api_key` only allows deleting REST API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user's identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.\n\n## Required authorization\n\n* Cluster privileges: `manage_api_key`,`manage_own_api_key`\n",
"operationId": "security-invalidate-api-key",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"ids": {
"description": "A list of API key ids.\nThis parameter cannot be used with any of `name`, `realm_name`, or `username`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
},
"name": {
"description": "An API key name.\nThis parameter cannot be used with any of `ids`, `realm_name` or `username`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"owner": {
"description": "Query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.\n\nNOTE: At least one of `ids`, `name`, `username`, and `realm_name` must be specified if `owner` is `false`.",
"default": false,
"type": "boolean"
},
"realm_name": {
"description": "The name of an authentication realm.\nThis parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`.",
"type": "string"
},
"username": {
"description": "The username of a user.\nThis parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
}
}
},
"examples": {
"SecurityInvalidateApiKeyRequestExample1": {
"summary": "API keys by ID",
"description": "Run `DELETE /_security/api_key` to invalidate the API keys identified by ID.",
"value": "{\n \"ids\" : [ \"VuaCfGcBCdbkQm-e5aOx\" ]\n}"
},
"SecurityInvalidateApiKeyRequestExample2": {
"summary": "API keys by name",
"description": "Run `DELETE /_security/api_key` to invalidate the API keys identified by name.",
"value": "{\n \"name\" : \"my-api-key\"\n}"
},
"SecurityInvalidateApiKeyRequestExample3": {
"summary": "API keys by realm",
"description": "Run `DELETE /_security/api_key` to invalidate all API keys for the `native1` realm.",
"value": "{\n \"realm_name\" : \"native1\"\n}"
},
"SecurityInvalidateApiKeyRequestExample4": {
"summary": "API keys by user",
"description": "Run `DELETE /_security/api_key` to invalidate all API keys for the user `myuser` in all realms.",
"value": "{\n \"username\" : \"myuser\"\n}"
},
"SecurityInvalidateApiKeyRequestExample5": {
"summary": "API keys by ID and owner",
"description": "Run `DELETE /_security/api_key` to invalidate the API keys identified by ID if they are owned by the currently authenticated user.",
"value": "{\n \"ids\" : [\"VuaCfGcBCdbkQm-e5aOx\"],\n \"owner\" : \"true\"\n}"
},
"SecurityInvalidateApiKeyRequestExample6": {
"summary": "API keys by user and realm",
"description": "Run `DELETE /_security/api_key` to invalidate all API keys for the user `myuser` in the `native1` realm .",
"value": "{\n \"username\" : \"myuser\",\n \"realm_name\" : \"native1\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_count": {
"description": "The number of errors that were encountered when invalidating the API keys.",
"type": "number"
},
"error_details": {
"description": "Details about the errors.\nThis field is not present in the response when `error_count` is `0`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
},
"invalidated_api_keys": {
"description": "The IDs of the API keys that were invalidated as part of this request.",
"type": "array",
"items": {
"type": "string"
}
},
"previously_invalidated_api_keys": {
"description": "The IDs of the API keys that were already invalidated.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error_count",
"invalidated_api_keys",
"previously_invalidated_api_keys"
]
},
"examples": {
"SecurityInvalidateApiKeyResponseExample1": {
"description": "A successful response from `DELETE /_security/api_key`.\n",
"value": "{\n \"invalidated_api_keys\": [ \n \"api-key-id-1\"\n ],\n \"previously_invalidated_api_keys\": [ \n \"api-key-id-2\",\n \"api-key-id-3\"\n ],\n \"error_count\": 2, \n \"error_details\": [ \n {\n \"type\": \"exception\",\n \"reason\": \"error occurred while invalidating api keys\",\n \"caused_by\": {\n \"type\": \"illegal_argument_exception\",\n \"reason\": \"invalid api key id\"\n }\n },\n {\n \"type\": \"exception\",\n \"reason\": \"error occurred while invalidating api keys\",\n \"caused_by\": {\n \"type\": \"illegal_argument_exception\",\n \"reason\": \"invalid api key id\"\n }\n }\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 6.7.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_security/api_key\n{\n \"ids\" : [ \"VuaCfGcBCdbkQm-e5aOx\" ]\n}"
},
{
"lang": "Python",
"source": "resp = client.security.invalidate_api_key(\n ids=[\n \"VuaCfGcBCdbkQm-e5aOx\"\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.invalidateApiKey({\n ids: [\"VuaCfGcBCdbkQm-e5aOx\"],\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.invalidate_api_key(\n body: {\n \"ids\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->invalidateApiKey([\n \"body\" => [\n \"ids\" => array(\n \"VuaCfGcBCdbkQm-e5aOx\",\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"ids\":[\"VuaCfGcBCdbkQm-e5aOx\"]}' \"$ELASTICSEARCH_URL/_security/api_key\""
},
{
"lang": "Java",
"source": "client.security().invalidateApiKey(i -> i\n .ids(\"VuaCfGcBCdbkQm-e5aOx\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/cross_cluster/api_key": {
"post": {
"tags": [
"security"
],
"summary": "Create a cross-cluster API key",
"description": "Create an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "About adding remote clusters",
"url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-api-key",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-create-cross-cluster-api-key.html"
},
"operationId": "security-create-cross-cluster-api-key",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access": {
"description": "The access to be granted to this API key.\nThe access is composed of permissions for cross-cluster search and cross-cluster replication.\nAt least one of them must be specified.\n\nNOTE: No explicit privileges should be specified for either search or replication access.\nThe creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.Access"
}
]
},
"expiration": {
"description": "Expiration time for the API key.\nBy default, API keys never expire.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"metadata": {
"description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"name": {
"description": "Specifies the name for this API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"certificate_identity": {
"description": "The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.",
"type": "string"
}
},
"required": [
"access",
"name"
]
},
"examples": {
"CreateCrossClusterApiKeyRequestExample1": {
"description": "Run `POST /_security/cross_cluster/api_key` to create a cross-cluster API key.\n",
"value": "{\n \"name\": \"my-cross-cluster-api-key\",\n \"expiration\": \"1d\", \n \"access\": {\n \"search\": [ \n {\n \"names\": [\"logs*\"]\n }\n ],\n \"replication\": [ \n {\n \"names\": [\"archive*\"]\n }\n ]\n },\n \"metadata\": {\n \"description\": \"phase one\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\"dev\", \"staging\"]\n }\n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"api_key": {
"description": "Generated API key.",
"type": "string"
},
"expiration": {
"description": "Expiration in milliseconds for the API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"id": {
"description": "Unique ID for this API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"name": {
"description": "Specifies the name for this API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"encoded": {
"description": "API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).",
"type": "string"
}
},
"required": [
"api_key",
"id",
"name",
"encoded"
]
},
"examples": {
"CreateCrossClusterApiKeyResponseExample1": {
"description": "A successful response from `POST /_security/service/elastic/fleet-server/credential/token`.\n",
"value": "{\n \"created\": true,\n \"token\": {\n \"name\": \"Jk5J1HgBuyBK5TpDrdo4\",\n \"value\": \"AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ\"\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/cross_cluster/api_key\n{\n \"name\": \"my-cross-cluster-api-key\",\n \"expiration\": \"1d\", \n \"access\": {\n \"search\": [ \n {\n \"names\": [\"logs*\"]\n }\n ],\n \"replication\": [ \n {\n \"names\": [\"archive*\"]\n }\n ]\n },\n \"metadata\": {\n \"description\": \"phase one\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\"dev\", \"staging\"]\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.create_cross_cluster_api_key(\n name=\"my-cross-cluster-api-key\",\n expiration=\"1d\",\n access={\n \"search\": [\n {\n \"names\": [\n \"logs*\"\n ]\n }\n ],\n \"replication\": [\n {\n \"names\": [\n \"archive*\"\n ]\n }\n ]\n },\n metadata={\n \"description\": \"phase one\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": True,\n \"tags\": [\n \"dev\",\n \"staging\"\n ]\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.createCrossClusterApiKey({\n name: \"my-cross-cluster-api-key\",\n expiration: \"1d\",\n access: {\n search: [\n {\n names: [\"logs*\"],\n },\n ],\n replication: [\n {\n names: [\"archive*\"],\n },\n ],\n },\n metadata: {\n description: \"phase one\",\n environment: {\n level: 1,\n trusted: true,\n tags: [\"dev\", \"staging\"],\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.create_cross_cluster_api_key(\n body: {\n \"name\": \"my-cross-cluster-api-key\",\n \"expiration\": \"1d\",\n \"access\": {\n \"search\": [\n {\n \"names\": [\n \"logs*\"\n ]\n }\n ],\n \"replication\": [\n {\n \"names\": [\n \"archive*\"\n ]\n }\n ]\n },\n \"metadata\": {\n \"description\": \"phase one\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\n \"dev\",\n \"staging\"\n ]\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->createCrossClusterApiKey([\n \"body\" => [\n \"name\" => \"my-cross-cluster-api-key\",\n \"expiration\" => \"1d\",\n \"access\" => [\n \"search\" => array(\n [\n \"names\" => array(\n \"logs*\",\n ),\n ],\n ),\n \"replication\" => array(\n [\n \"names\" => array(\n \"archive*\",\n ),\n ],\n ),\n ],\n \"metadata\" => [\n \"description\" => \"phase one\",\n \"environment\" => [\n \"level\" => 1,\n \"trusted\" => true,\n \"tags\" => array(\n \"dev\",\n \"staging\",\n ),\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"name\":\"my-cross-cluster-api-key\",\"expiration\":\"1d\",\"access\":{\"search\":[{\"names\":[\"logs*\"]}],\"replication\":[{\"names\":[\"archive*\"]}]},\"metadata\":{\"description\":\"phase one\",\"environment\":{\"level\":1,\"trusted\":true,\"tags\":[\"dev\",\"staging\"]}}}' \"$ELASTICSEARCH_URL/_security/cross_cluster/api_key\""
},
{
"lang": "Java",
"source": "client.security().createCrossClusterApiKey(c -> c\n .access(a -> a\n .replication(r -> r\n .names(\"archive*\")\n )\n .search(s -> s\n .names(\"logs*\")\n )\n )\n .expiration(e -> e\n .time(\"1d\")\n )\n .metadata(Map.of(\"environment\", JsonData.fromJson(\"\"\"\n{\"level\":1,\"trusted\":true,\"tags\":[\"dev\",\"staging\"]}\n\"\"\"),\"description\", JsonData.fromJson(\"\\\"phase one\\\"\")))\n .name(\"my-cross-cluster-api-key\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/service/{namespace}/{service}/credential/token/{name}": {
"post": {
"tags": [
"security"
],
"summary": "Create a service account token\n",
"description": "**All methods and paths for this operation:**\n\n\n POST\n /_security/service/{namespace}/{service}/credential/token\n
\n \n PUT\n /_security/service/{namespace}/{service}/credential/token/{name}\n
\n \n POST\n /_security/service/{namespace}/{service}/credential/token/{name}\n
\n \n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.\n\nIMPORTANT: On Serverless, non-operator users can create tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nCreating tokens for any other service account requires operator privileges.\n\n## Required authorization\n\n* Cluster privileges: `manage_service_account`\n",
"externalDocs": {
"description": "More about service accounts",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-create-service-token.html"
},
"operationId": "security-create-service-token",
"parameters": [
{
"$ref": "#/components/parameters/security.create_service_token-namespace"
},
{
"$ref": "#/components/parameters/security.create_service_token-service"
},
{
"$ref": "#/components/parameters/security.create_service_token-name"
},
{
"$ref": "#/components/parameters/security.create_service_token-refresh"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.create_service_token-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/service/elastic/fleet-server/credential/token/token1\n"
},
{
"lang": "Python",
"source": "resp = client.security.create_service_token(\n namespace=\"elastic\",\n service=\"fleet-server\",\n name=\"token1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.createServiceToken({\n namespace: \"elastic\",\n service: \"fleet-server\",\n name: \"token1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.create_service_token(\n namespace: \"elastic\",\n service: \"fleet-server\",\n name: \"token1\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->createServiceToken([\n \"namespace\" => \"elastic\",\n \"service\" => \"fleet-server\",\n \"name\" => \"token1\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/service/elastic/fleet-server/credential/token/token1\""
},
{
"lang": "Java",
"source": "client.security().createServiceToken(c -> c\n .name(\"token1\")\n .namespace(\"elastic\")\n .service(\"fleet-server\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"security"
],
"summary": "Delete service account tokens",
"description": "Delete service account tokens for a service in a specified namespace.\n\nIMPORTANT: On Serverless, non-operator users can delete tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nDeleting tokens for any other service account requires operator privileges.\n\n## Required authorization\n\n* Cluster privileges: `manage_service_account`\n",
"externalDocs": {
"description": "More about service accounts",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delete-service-token.html"
},
"operationId": "security-delete-service-token",
"parameters": [
{
"in": "path",
"name": "namespace",
"description": "The namespace, which is a top-level grouping of service accounts.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Namespace"
},
"style": "simple"
},
{
"in": "path",
"name": "service",
"description": "The service name.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Service"
},
"style": "simple"
},
{
"in": "path",
"name": "name",
"description": "The name of the service account token.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"found": {
"description": "If the service account token is successfully deleted, the request returns `{\"found\": true}`.\nOtherwise, the response will have status code 404 and `found` is set to `false`.",
"type": "boolean"
}
},
"required": [
"found"
]
},
"examples": {
"DeleteServiceTokenResponseExample1": {
"description": "A successful response from `DELETE /_security/service/elastic/fleet-server/credential/token/token42`.\n",
"value": "{\n \"found\" : true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 5.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_security/service/elastic/fleet-server/credential/token/token42\n"
},
{
"lang": "Python",
"source": "resp = client.security.delete_service_token(\n namespace=\"elastic\",\n service=\"fleet-server\",\n name=\"token42\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.deleteServiceToken({\n namespace: \"elastic\",\n service: \"fleet-server\",\n name: \"token42\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.delete_service_token(\n namespace: \"elastic\",\n service: \"fleet-server\",\n name: \"token42\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->deleteServiceToken([\n \"namespace\" => \"elastic\",\n \"service\" => \"fleet-server\",\n \"name\" => \"token42\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/service/elastic/fleet-server/credential/token/token42\""
},
{
"lang": "Java",
"source": "client.security().deleteServiceToken(d -> d\n .name(\"token42\")\n .namespace(\"elastic\")\n .service(\"fleet-server\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/delegate_pki": {
"post": {
"tags": [
"security"
],
"summary": "Delegate PKI authentication",
"description": "This API implements the exchange of an X509Certificate chain for an Elasticsearch access token.\nThe certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`.\nA successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.\n\nThis API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-as if the user connected directly to Elasticsearch.\n\nIMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.\nThis is part of the TLS authentication process and it is delegated to the proxy that calls this API.\nThe proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.\n\n## Required authorization\n\n* Cluster privileges: `all`\n",
"externalDocs": {
"description": "Learn more about pki",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/pki",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delegate-pki-authentication.html"
},
"operationId": "security-delegate-pki",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"x509_certificate_chain": {
"description": "The X509Certificate chain, which is represented as an ordered string array.\nEach string in the array is a base64-encoded (Section 4 of RFC4648 - not base64url-encoded) of the certificate's DER encoding.\n\nThe first element is the target certificate that contains the subject distinguished name that is requesting access.\nThis may be followed by additional certificates; each subsequent certificate is used to certify the previous one.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"x509_certificate_chain"
]
},
"examples": {
"SecurityDelegatePkiRequestExample1": {
"description": "Delegate a one element certificate chain.",
"value": "{\n\"x509_certificate_chain\": [\"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\"]\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access_token": {
"description": "An access token associated with the subject distinguished name of the client's certificate.",
"type": "string"
},
"expires_in": {
"description": "The amount of time (in seconds) before the token expires.",
"type": "number"
},
"type": {
"description": "The type of token.",
"type": "string"
},
"authentication": {
"allOf": [
{
"$ref": "#/components/schemas/security.delegate_pki.Authentication"
}
]
}
},
"required": [
"access_token",
"expires_in",
"type"
]
},
"examples": {
"SecurityDelegatePkiResponseExample1": {
"description": "A successful response from delegating a one element certificate chain.",
"value": "{\n \"access_token\": \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\": \"Bearer\",\n \"expires_in\": 1200,\n \"authentication\": {\n \"username\": \"Elasticsearch Test Client\",\n \"roles\": [],\n \"full_name\": null,\n \"email\": null,\n \"metadata\": {\n \"pki_dn\": \"O=org, OU=Elasticsearch, CN=Elasticsearch Test Client\",\n \"pki_delegated_by_user\": \"test_admin\",\n \"pki_delegated_by_realm\": \"file\"\n },\n \"enabled\": true,\n \"authentication_realm\": {\n \"name\": \"pki1\",\n \"type\": \"pki\"\n },\n \"lookup_realm\": {\n \"name\": \"pki1\",\n \"type\": \"pki\"\n },\n \"authentication_type\": \"realm\"\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/delegate_pki\n{\n\"x509_certificate_chain\": [\"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\"]\n}"
},
{
"lang": "Python",
"source": "resp = client.perform_request(\n \"POST\",\n \"/_security/delegate_pki\",\n headers={\"Content-Type\": \"application/json\"},\n body={\n \"x509_certificate_chain\": [\n \"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\"\n ]\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transport.request({\n method: \"POST\",\n path: \"/_security/delegate_pki\",\n body: {\n x509_certificate_chain: [\n \"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\",\n ],\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.perform_request(\n \"POST\",\n \"/_security/delegate_pki\",\n {},\n {\n \"x509_certificate_chain\": [\n \"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\"\n ]\n },\n { \"Content-Type\": \"application/json\" },\n)"
},
{
"lang": "PHP",
"source": "$requestFactory = Psr17FactoryDiscovery::findRequestFactory();\n$streamFactory = Psr17FactoryDiscovery::findStreamFactory();\n$request = $requestFactory->createRequest(\n \"POST\",\n \"/_security/delegate_pki\",\n);\n$request = $request->withHeader(\"Content-Type\", \"application/json\");\n$request = $request->withBody($streamFactory->createStream(\n json_encode([\n \"x509_certificate_chain\" => array(\n \"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\",\n ),\n ]),\n));\n$resp = $client->sendRequest($request);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"x509_certificate_chain\":[\"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\"]}' \"$ELASTICSEARCH_URL/_security/delegate_pki\""
},
{
"lang": "Java",
"source": "client.security().delegatePki(d -> d\n .x509CertificateChain(\"MIIDeDCCAmCgAwIBAgIUBzj/nGGKxP2iXawsSquHmQjCJmMwDQYJKoZIhvcNAQELBQAwUzErMCkGA1UEAxMiRWxhc3RpY3NlYXJjaCBUZXN0IEludGVybWVkaWF0ZSBDQTEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMB4XDTIzMDcxODE5MjkwNloXDTQzMDcxMzE5MjkwNlowSjEiMCAGA1UEAxMZRWxhc3RpY3NlYXJjaCBUZXN0IENsaWVudDEWMBQGA1UECxMNRWxhc3RpY3NlYXJjaDEMMAoGA1UEChMDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAllHL4pQkkfwAm/oLkxYYO+r950DEy1bjH+4viCHzNADLCTWO+lOZJVlNx7QEzJE3QGMdif9CCBBxQFMapA7oUFCLq84fPSQQu5AnvvbltVD9nwVtCs+9ZGDjMKsz98RhSLMFIkxdxi6HkQ3Lfa4ZSI4lvba4oo+T/GveazBDS+NgmKyq00EOXt3tWi1G9vEVItommzXWfv0agJWzVnLMldwkPqsw0W7zrpyT7FZS4iLbQADGceOW8fiauOGMkscu9zAnDR/SbWl/chYioQOdw6ndFLn1YIFPd37xL0WsdsldTpn0vH3YfzgLMffT/3P6YlwBegWzsx6FnM/93Ecb4wIDAQABo00wSzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQKNRwjW+Ad/FN1Rpoqme/5+jrFWzAfBgNVHSMEGDAWgBRcya0c0x/PaI7MbmJVIylWgLqXNjANBgkqhkiG9w0BAQsFAAOCAQEACZ3PF7Uqu47lplXHP6YlzYL2jL0D28hpj5lGtdha4Muw1m/BjDb0Pu8l0NQ1z3AP6AVcvjNDkQq6Y5jeSz0bwQlealQpYfo7EMXjOidrft1GbqOMFmTBLpLA9SvwYGobSTXWTkJzonqVaTcf80HpMgM2uEhodwTcvz6v1WEfeT/HMjmdIsq4ImrOL9RNrcZG6nWfw0HR3JNOgrbfyEztEI471jHznZ336OEcyX7gQuvHE8tOv5+oD1d7s3Xg1yuFp+Ynh+FfOi3hPCuaHA+7F6fLmzMDLVUBAllugst1C3U+L/paD7tqIa4ka+KNPCbSfwazmJrt4XNiivPR4hwH5g==\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/privilege/{application}/{name}": {
"get": {
"tags": [
"security"
],
"summary": "Get application privileges\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/privilege\n
\n \n GET\n /_security/privilege/{application}\n
\n \n GET\n /_security/privilege/{application}/{name}\n
\n \n\nTo use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"externalDocs": {
"description": "About Elasticsearch privileges",
"url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-privileges.html"
},
"operationId": "security-get-privileges",
"parameters": [
{
"$ref": "#/components/parameters/security.get_privileges-application"
},
{
"$ref": "#/components/parameters/security.get_privileges-name"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.get_privileges-200"
}
},
"x-state": "Generally available; Added in 6.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/privilege/myapp/read\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_privileges(\n application=\"myapp\",\n name=\"read\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getPrivileges({\n application: \"myapp\",\n name: \"read\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_privileges(\n application: \"myapp\",\n name: \"read\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getPrivileges([\n \"application\" => \"myapp\",\n \"name\" => \"read\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/privilege/myapp/read\""
},
{
"lang": "Java",
"source": "client.security().getPrivileges(g -> g\n .application(\"myapp\")\n .name(\"read\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"security"
],
"summary": "Delete application privileges",
"description": "To use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "About Elasticsearch privileges",
"url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delete-privilege.html"
},
"operationId": "security-delete-privileges",
"parameters": [
{
"in": "path",
"name": "application",
"description": "The name of the application.\nApplication privileges are always associated with exactly one application.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "path",
"name": "name",
"description": "The name of the privilege.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
{
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.delete_privileges.FoundStatus"
}
}
},
"examples": {
"SecurityDeletePrivilegesResponseExample1": {
"description": "A successful response from `DELETE /_security/privilege/myapp/read`. If the privilege is successfully deleted, `found` is set to `true`.\n",
"value": "{\n \"myapp\": {\n \"read\": {\n \"found\" : true\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 6.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_security/privilege/myapp/read\n"
},
{
"lang": "Python",
"source": "resp = client.security.delete_privileges(\n application=\"myapp\",\n name=\"read\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.deletePrivileges({\n application: \"myapp\",\n name: \"read\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.delete_privileges(\n application: \"myapp\",\n name: \"read\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->deletePrivileges([\n \"application\" => \"myapp\",\n \"name\" => \"read\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/privilege/myapp/read\""
},
{
"lang": "Java",
"source": "client.security().deletePrivileges(d -> d\n .application(\"myapp\")\n .name(\"read\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/role/{name}": {
"get": {
"tags": [
"security"
],
"summary": "Get roles\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/role\n
\n \n GET\n /_security/role/{name}\n
\n \n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"operationId": "security-get-role",
"parameters": [
{
"$ref": "#/components/parameters/security.get_role-name"
},
{
"$ref": "#/components/parameters/security.get_role-include_implicit"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.get_role-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/role/my_admin_role\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_role(\n name=\"my_admin_role\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getRole({\n name: \"my_admin_role\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_role(\n name: \"my_admin_role\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getRole([\n \"name\" => \"my_admin_role\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/role/my_admin_role\""
},
{
"lang": "Java",
"source": "client.security().getRole(g -> g\n .name(\"my_admin_role\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"post": {
"tags": [
"security"
],
"summary": "Create or update roles\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/role/{name}\n
\n \n POST\n /_security/role/{name}\n
\n \n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "More about defining roles",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-role.html"
},
"operationId": "security-put-role",
"parameters": [
{
"$ref": "#/components/parameters/security.put_role-name"
},
{
"$ref": "#/components/parameters/security.put_role-refresh"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.put_role"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.put_role-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/role/my_admin_role\n{\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [ \"index1\", \"index2\" ],\n \"privileges\": [\"all\"],\n \"field_security\" : { // optional\n \"grant\" : [ \"title\", \"body\" ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\" // optional\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [ \"admin\", \"read\" ],\n \"resources\": [ \"*\" ]\n }\n ],\n \"run_as\": [ \"other_user\" ], // optional\n \"metadata\" : { // optional\n \"version\" : 1\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.put_role(\n name=\"my_admin_role\",\n description=\"Grants full access to all management features within the cluster.\",\n cluster=[\n \"all\"\n ],\n indices=[\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\n \"all\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n applications=[\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n run_as=[\n \"other_user\"\n ],\n metadata={\n \"version\": 1\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.putRole({\n name: \"my_admin_role\",\n description:\n \"Grants full access to all management features within the cluster.\",\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index1\", \"index2\"],\n privileges: [\"all\"],\n field_security: {\n grant: [\"title\", \"body\"],\n },\n query: '{\"match\": {\"title\": \"foo\"}}',\n },\n ],\n applications: [\n {\n application: \"myapp\",\n privileges: [\"admin\", \"read\"],\n resources: [\"*\"],\n },\n ],\n run_as: [\"other_user\"],\n metadata: {\n version: 1,\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.put_role(\n name: \"my_admin_role\",\n body: {\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\n \"all\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->putRole([\n \"name\" => \"my_admin_role\",\n \"body\" => [\n \"description\" => \"Grants full access to all management features within the cluster.\",\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index1\",\n \"index2\",\n ),\n \"privileges\" => array(\n \"all\",\n ),\n \"field_security\" => [\n \"grant\" => array(\n \"title\",\n \"body\",\n ),\n ],\n \"query\" => \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\",\n ],\n ),\n \"applications\" => array(\n [\n \"application\" => \"myapp\",\n \"privileges\" => array(\n \"admin\",\n \"read\",\n ),\n \"resources\" => array(\n \"*\",\n ),\n ],\n ),\n \"run_as\" => array(\n \"other_user\",\n ),\n \"metadata\" => [\n \"version\" => 1,\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"description\":\"Grants full access to all management features within the cluster.\",\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index1\",\"index2\"],\"privileges\":[\"all\"],\"field_security\":{\"grant\":[\"title\",\"body\"]},\"query\":\"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"}],\"applications\":[{\"application\":\"myapp\",\"privileges\":[\"admin\",\"read\"],\"resources\":[\"*\"]}],\"run_as\":[\"other_user\"],\"metadata\":{\"version\":1}}' \"$ELASTICSEARCH_URL/_security/role/my_admin_role\""
},
{
"lang": "Java",
"source": "client.security().putRole(p -> p\n .applications(a -> a\n .application(\"myapp\")\n .privileges(List.of(\"admin\",\"read\"))\n .resources(\"*\")\n )\n .cluster(\"all\")\n .description(\"Grants full access to all management features within the cluster.\")\n .global(Map.of())\n .indices(i -> i\n .fieldSecurity(f -> f\n .except(List.of())\n .grant(List.of(\"title\",\"body\"))\n )\n .names(List.of(\"index1\",\"index2\"))\n .privileges(\"all\")\n .query(q -> q\n .match(m -> m\n .field(\"title\")\n .query(FieldValue.of(\"foo\"))\n )\n )\n )\n .metadata(\"version\", JsonData.fromJson(\"1\"))\n .name(\"my_admin_role\")\n .remoteCluster(List.of())\n .remoteIndices(List.of())\n .runAs(\"other_user\")\n .transientMetadata(Map.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"security"
],
"summary": "Delete roles",
"description": "Delete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-delete-role",
"parameters": [
{
"in": "path",
"name": "name",
"description": "The name of the role.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"found": {
"description": "If the role is successfully deleted, `found` is `true`.\nOtherwise, `found` is `false`.",
"type": "boolean"
}
},
"required": [
"found"
]
},
"examples": {
"SecurityDeleteRoleResponseExample1": {
"description": "A successful response from `DELETE /_security/role/my_admin_role`. If the role is successfully deleted, `found` is set to `true`.\n",
"value": "{\n \"found\" : true\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_security/role/my_admin_role\n"
},
{
"lang": "Python",
"source": "resp = client.security.delete_role(\n name=\"my_admin_role\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.deleteRole({\n name: \"my_admin_role\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.delete_role(\n name: \"my_admin_role\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->deleteRole([\n \"name\" => \"my_admin_role\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/role/my_admin_role\""
},
{
"lang": "Java",
"source": "client.security().deleteRole(d -> d\n .name(\"my_admin_role\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/role_mapping/{name}": {
"get": {
"tags": [
"security"
],
"summary": "Get role mappings\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/role_mapping\n
\n \n GET\n /_security/role_mapping/{name}\n
\n \n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "About mapping users to roles",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-role-mapping.html"
},
"operationId": "security-get-role-mapping",
"parameters": [
{
"$ref": "#/components/parameters/security.get_role_mapping-name"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.get_role_mapping-200"
}
},
"x-state": "Generally available; Added in 5.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/role_mapping/mapping1\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_role_mapping(\n name=\"mapping1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getRoleMapping({\n name: \"mapping1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_role_mapping(\n name: \"mapping1\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getRoleMapping([\n \"name\" => \"mapping1\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/role_mapping/mapping1\""
},
{
"lang": "Java",
"source": "client.security().getRoleMapping(g -> g\n .name(\"mapping1\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"post": {
"tags": [
"security"
],
"summary": "Create or update role mappings\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/role_mapping/{name}\n
\n \n POST\n /_security/role_mapping/{name}\n
\n \n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "About mapping users to roles",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-role-mapping.html"
},
"operationId": "security-put-role-mapping",
"parameters": [
{
"$ref": "#/components/parameters/security.put_role_mapping-name"
},
{
"$ref": "#/components/parameters/security.put_role_mapping-refresh"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.put_role_mapping"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.put_role_mapping-200"
}
},
"x-state": "Generally available; Added in 5.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/role_mapping/mapping1\n{\n \"roles\": [ \"user\"],\n \"enabled\": true, \n \"rules\": {\n \"field\" : { \"username\" : \"*\" }\n },\n \"metadata\" : { \n \"version\" : 1\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.put_role_mapping(\n name=\"mapping1\",\n roles=[\n \"user\"\n ],\n enabled=True,\n rules={\n \"field\": {\n \"username\": \"*\"\n }\n },\n metadata={\n \"version\": 1\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.putRoleMapping({\n name: \"mapping1\",\n roles: [\"user\"],\n enabled: true,\n rules: {\n field: {\n username: \"*\",\n },\n },\n metadata: {\n version: 1,\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.put_role_mapping(\n name: \"mapping1\",\n body: {\n \"roles\": [\n \"user\"\n ],\n \"enabled\": true,\n \"rules\": {\n \"field\": {\n \"username\": \"*\"\n }\n },\n \"metadata\": {\n \"version\": 1\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->putRoleMapping([\n \"name\" => \"mapping1\",\n \"body\" => [\n \"roles\" => array(\n \"user\",\n ),\n \"enabled\" => true,\n \"rules\" => [\n \"field\" => [\n \"username\" => \"*\",\n ],\n ],\n \"metadata\" => [\n \"version\" => 1,\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"roles\":[\"user\"],\"enabled\":true,\"rules\":{\"field\":{\"username\":\"*\"}},\"metadata\":{\"version\":1}}' \"$ELASTICSEARCH_URL/_security/role_mapping/mapping1\""
},
{
"lang": "Java",
"source": "client.security().putRoleMapping(p -> p\n .enabled(true)\n .metadata(\"version\", JsonData.fromJson(\"1\"))\n .name(\"mapping1\")\n .roleTemplates(List.of())\n .roles(\"user\")\n .rules(r -> r\n .field(NamedValue.of(\"username\",List.of(FieldValue.of(\"*\"))))\n )\n .runAs(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"security"
],
"summary": "Delete role mappings",
"description": "Role mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "About mapping users to roles",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-delete-role-mapping.html"
},
"operationId": "security-delete-role-mapping",
"parameters": [
{
"in": "path",
"name": "name",
"description": "The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"found": {
"description": "If the mapping is successfully deleted, `found` is `true`.\nOtherwise, `found` is `false`.",
"type": "boolean"
}
},
"required": [
"found"
]
},
"examples": {
"SecurityDeleteRoleMappingResponseExample1": {
"description": "A successful response from `DELETE /_security/role_mapping/mapping1`. If the mapping is successfully deleted, `found` is `true`.\n",
"value": "{\n \"found\" : true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 5.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_security/role_mapping/mapping1\n"
},
{
"lang": "Python",
"source": "resp = client.security.delete_role_mapping(\n name=\"mapping1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.deleteRoleMapping({\n name: \"mapping1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.delete_role_mapping(\n name: \"mapping1\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->deleteRoleMapping([\n \"name\" => \"mapping1\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/role_mapping/mapping1\""
},
{
"lang": "Java",
"source": "client.security().deleteRoleMapping(d -> d\n .name(\"mapping1\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/user/{username}": {
"get": {
"tags": [
"security"
],
"summary": "Get users\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/user\n
\n \n GET\n /_security/user/{username}\n
\n \n\nGet information about users in the native realm and built-in users.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"operationId": "security-get-user",
"parameters": [
{
"$ref": "#/components/parameters/security.get_user-username"
},
{
"$ref": "#/components/parameters/security.get_user-with_profile_uid"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.get_user-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/user/jacknich?with_profile_uid=true\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_user(\n username=\"jacknich\",\n with_profile_uid=True,\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getUser({\n username: \"jacknich\",\n with_profile_uid: \"true\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_user(\n username: \"jacknich\",\n with_profile_uid: \"true\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getUser([\n \"username\" => \"jacknich\",\n \"with_profile_uid\" => \"true\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/user/jacknich?with_profile_uid=true\""
},
{
"lang": "Java",
"source": "client.security().getUser(g -> g\n .username(\"jacknich\")\n .withProfileUid(true)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"post": {
"tags": [
"security"
],
"summary": "Create or update users\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/user/{username}\n
\n \n POST\n /_security/user/{username}\n
\n \n\nAdd and update users in the native realm.\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user's password without updating any other fields, use the change password API.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-put-user",
"parameters": [
{
"$ref": "#/components/parameters/security.put_user-username"
},
{
"$ref": "#/components/parameters/security.put_user-refresh"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.put_user"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.put_user-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/user/jacknich\n{\n \"password\" : \"l0ng-r4nd0m-p@ssw0rd\",\n \"roles\" : [ \"admin\", \"other_role1\" ],\n \"full_name\" : \"Jack Nicholson\",\n \"email\" : \"jacknich@example.com\",\n \"metadata\" : {\n \"intelligence\" : 7\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.put_user(\n username=\"jacknich\",\n password=\"l0ng-r4nd0m-p@ssw0rd\",\n roles=[\n \"admin\",\n \"other_role1\"\n ],\n full_name=\"Jack Nicholson\",\n email=\"jacknich@example.com\",\n metadata={\n \"intelligence\": 7\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.putUser({\n username: \"jacknich\",\n password: \"l0ng-r4nd0m-p@ssw0rd\",\n roles: [\"admin\", \"other_role1\"],\n full_name: \"Jack Nicholson\",\n email: \"jacknich@example.com\",\n metadata: {\n intelligence: 7,\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.put_user(\n username: \"jacknich\",\n body: {\n \"password\": \"l0ng-r4nd0m-p@ssw0rd\",\n \"roles\": [\n \"admin\",\n \"other_role1\"\n ],\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->putUser([\n \"username\" => \"jacknich\",\n \"body\" => [\n \"password\" => \"l0ng-r4nd0m-p@ssw0rd\",\n \"roles\" => array(\n \"admin\",\n \"other_role1\",\n ),\n \"full_name\" => \"Jack Nicholson\",\n \"email\" => \"jacknich@example.com\",\n \"metadata\" => [\n \"intelligence\" => 7,\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"password\":\"l0ng-r4nd0m-p@ssw0rd\",\"roles\":[\"admin\",\"other_role1\"],\"full_name\":\"Jack Nicholson\",\"email\":\"jacknich@example.com\",\"metadata\":{\"intelligence\":7}}' \"$ELASTICSEARCH_URL/_security/user/jacknich\""
},
{
"lang": "Java",
"source": "client.security().putUser(p -> p\n .email(\"jacknich@example.com\")\n .fullName(\"Jack Nicholson\")\n .metadata(\"intelligence\", JsonData.fromJson(\"7\"))\n .password(\"l0ng-r4nd0m-p@ssw0rd\")\n .roles(List.of(\"admin\",\"other_role1\"))\n .username(\"jacknich\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"security"
],
"summary": "Delete users",
"description": "Delete users from the native realm.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-delete-user",
"parameters": [
{
"in": "path",
"name": "username",
"description": "An identifier for the user.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Username"
},
"style": "simple"
},
{
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"found": {
"description": "If the user is successfully deleted, the request returns `{\"found\": true}`.\nOtherwise, `found` is set to `false`.",
"type": "boolean"
}
},
"required": [
"found"
]
},
"examples": {
"SecurityDeleteUserResponseExample1": {
"description": "A successful response from `DELETE /_security/user/jacknich`.\n",
"value": "{\n \"found\" : true\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_security/user/jacknich\n"
},
{
"lang": "Python",
"source": "resp = client.security.delete_user(\n username=\"jacknich\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.deleteUser({\n username: \"jacknich\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.delete_user(\n username: \"jacknich\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->deleteUser([\n \"username\" => \"jacknich\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/user/jacknich\""
},
{
"lang": "Java",
"source": "client.security().deleteUser(d -> d\n .username(\"jacknich\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/user/{username}/_disable": {
"post": {
"tags": [
"security"
],
"summary": "Disable users\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/user/{username}/_disable\n
\n \n POST\n /_security/user/{username}/_disable\n
\n \n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-disable-user",
"parameters": [
{
"$ref": "#/components/parameters/security.disable_user-username"
},
{
"$ref": "#/components/parameters/security.disable_user-refresh"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.disable_user-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_security/user/jacknich/_disable\n"
},
{
"lang": "Python",
"source": "resp = client.security.disable_user(\n username=\"jacknich\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.disableUser({\n username: \"jacknich\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.disable_user(\n username: \"jacknich\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->disableUser([\n \"username\" => \"jacknich\",\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/user/jacknich/_disable\""
},
{
"lang": "Java",
"source": "client.security().disableUser(d -> d\n .username(\"jacknich\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/profile/{uid}/_disable": {
"post": {
"tags": [
"security"
],
"summary": "Disable a user profile\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/profile/{uid}/_disable\n
\n \n POST\n /_security/profile/{uid}/_disable\n
\n \n\nDisable user profiles so that they are not visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API .\n\n## Required authorization\n\n* Cluster privileges: `manage_user_profile`\n",
"operationId": "security-disable-user-profile",
"parameters": [
{
"$ref": "#/components/parameters/security.disable_user_profile-uid"
},
{
"$ref": "#/components/parameters/security.disable_user_profile-refresh"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.disable_user_profile-200"
}
},
"x-state": "Generally available; Added in 8.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable\n"
},
{
"lang": "Python",
"source": "resp = client.security.disable_user_profile(\n uid=\"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.disableUserProfile({\n uid: \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.disable_user_profile(\n uid: \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->disableUserProfile([\n \"uid\" => \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable\""
},
{
"lang": "Java",
"source": "client.security().disableUserProfile(d -> d\n .uid(\"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/user/{username}/_enable": {
"post": {
"tags": [
"security"
],
"summary": "Enable users\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/user/{username}/_enable\n
\n \n POST\n /_security/user/{username}/_enable\n
\n \n\nEnable users in the native realm.\nBy default, when you create users, they are enabled.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-enable-user",
"parameters": [
{
"$ref": "#/components/parameters/security.enable_user-username"
},
{
"$ref": "#/components/parameters/security.enable_user-refresh"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.enable_user-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT _security/user/logstash_system/_enable\n"
},
{
"lang": "Python",
"source": "resp = client.security.enable_user(\n username=\"logstash_system\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.enableUser({\n username: \"logstash_system\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.enable_user(\n username: \"logstash_system\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->enableUser([\n \"username\" => \"logstash_system\",\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/user/logstash_system/_enable\""
},
{
"lang": "Java",
"source": "client.security().enableUser(e -> e\n .username(\"logstash_system\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/profile/{uid}/_enable": {
"post": {
"tags": [
"security"
],
"summary": "Enable a user profile\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/profile/{uid}/_enable\n
\n \n POST\n /_security/profile/{uid}/_enable\n
\n \n\nEnable user profiles to make them visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.\n\n## Required authorization\n\n* Cluster privileges: `manage_user_profile`\n",
"operationId": "security-enable-user-profile",
"parameters": [
{
"$ref": "#/components/parameters/security.enable_user_profile-uid"
},
{
"$ref": "#/components/parameters/security.enable_user_profile-refresh"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.enable_user_profile-200"
}
},
"x-state": "Generally available; Added in 8.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable\n"
},
{
"lang": "Python",
"source": "resp = client.security.enable_user_profile(\n uid=\"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.enableUserProfile({\n uid: \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.enable_user_profile(\n uid: \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->enableUserProfile([\n \"uid\" => \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable\""
},
{
"lang": "Java",
"source": "client.security().enableUserProfile(e -> e\n .uid(\"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/enroll/kibana": {
"get": {
"tags": [
"security"
],
"summary": "Enroll Kibana",
"description": "Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.\n\nNOTE: This API is currently intended for internal use only by Kibana.\nKibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.",
"operationId": "security-enroll-kibana",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"allOf": [
{
"$ref": "#/components/schemas/security.enroll_kibana.Token"
}
]
},
"http_ca": {
"description": "The CA certificate used to sign the node certificates that Elasticsearch uses for TLS on the HTTP layer.\nThe certificate is returned as a Base64 encoded string of the ASN.1 DER encoding of the certificate.",
"type": "string"
}
},
"required": [
"token",
"http_ca"
]
},
"examples": {
"EnrollKibanaResponseExample1": {
"description": "A successful response from `GET /_security/enroll/kibana`.",
"value": "{\n \"token\" : {\n \"name\" : \"enroll-process-token-1629123923000\", \n \"value\": \"AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ\" \n },\n \"http_ca\" : \"MIIJlAIBAzVoGCSqGSIb3...vsDfsA3UZBAjEPfhubpQysAICAA=\", \n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.0.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/enroll/kibana\n"
},
{
"lang": "Python",
"source": "resp = client.security.enroll_kibana()"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.enrollKibana();"
},
{
"lang": "Ruby",
"source": "response = client.security.enroll_kibana"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->enrollKibana();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/enroll/kibana\""
},
{
"lang": "Java",
"source": "client.security().enrollKibana();\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/enroll/node": {
"get": {
"tags": [
"security"
],
"summary": "Enroll a node",
"description": "Enroll a new node to allow it to join an existing cluster with security features enabled.\n\nThe response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.\nThe response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.",
"operationId": "security-enroll-node",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"http_ca_key": {
"description": "The CA private key that can be used by the new node in order to sign its certificate for the HTTP layer, as a Base64 encoded string of the ASN.1 DER encoding of the key.",
"type": "string"
},
"http_ca_cert": {
"description": "The CA certificate that can be used by the new node in order to sign its certificate for the HTTP layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate.",
"type": "string"
},
"transport_ca_cert": {
"description": "The CA certificate that is used to sign the TLS certificate for the transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate.",
"type": "string"
},
"transport_key": {
"description": "The private key that the node can use for TLS for its transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the key.",
"type": "string"
},
"transport_cert": {
"description": "The certificate that the node can use for TLS for its transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate.",
"type": "string"
},
"nodes_addresses": {
"description": "A list of transport addresses in the form of `host:port` for the nodes that are already members of the cluster.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"http_ca_key",
"http_ca_cert",
"transport_ca_cert",
"transport_key",
"transport_cert",
"nodes_addresses"
]
},
"examples": {
"EnrollNodeResponseExample1": {
"description": "A successful response from `PGET /security/enroll/node`.",
"value": "{\n \"http_ca_key\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"http_ca_cert\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"transport_ca_cert\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqG....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"transport_key\" : \"MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==\", \n \"transport_cert\" : \"MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==\", \n \"nodes_addresses\" : [ \n \"192.168.1.2:9300\"\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.0.0",
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/privilege/_builtin": {
"get": {
"tags": [
"security"
],
"summary": "Get builtin privileges",
"description": "Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "About Elasticsearch privileges",
"url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-builtin-privileges.html"
},
"operationId": "security-get-builtin-privileges",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cluster": {
"description": "The list of cluster privileges that are understood by this version of Elasticsearch.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ClusterPrivilege"
}
},
"index": {
"description": "The list of index privileges that are understood by this version of Elasticsearch.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
},
"remote_cluster": {
"description": "The list of remote_cluster privileges that are understood by this version of Elasticsearch.",
"x-state": "Generally available; Added in 8.15.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteClusterPrivilege"
}
}
},
"required": [
"cluster",
"index",
"remote_cluster"
]
},
"examples": {
"SecurityGetBuiltinPrivilegesResponseExample1": {
"description": "A successful response from `GET /_security/privilege/_builtin`.",
"value": "{\n \"cluster\" : [\n \"all\",\n \"cancel_task\",\n \"create_snapshot\",\n \"cross_cluster_replication\",\n \"cross_cluster_search\",\n \"delegate_pki\",\n \"grant_api_key\",\n \"manage\",\n \"manage_api_key\",\n \"manage_autoscaling\",\n \"manage_behavioral_analytics\",\n \"manage_ccr\",\n \"manage_connector\",\n \"manage_data_frame_transforms\",\n \"manage_data_stream_global_retention\",\n \"manage_enrich\",\n \"manage_ilm\",\n \"manage_index_templates\",\n \"manage_inference\",\n \"manage_ingest_pipelines\",\n \"manage_logstash_pipelines\",\n \"manage_ml\",\n \"manage_oidc\",\n \"manage_own_api_key\",\n \"manage_pipeline\",\n \"manage_rollup\",\n \"manage_saml\",\n \"manage_search_application\",\n \"manage_search_query_rules\",\n \"manage_search_synonyms\",\n \"manage_security\",\n \"manage_service_account\",\n \"manage_slm\",\n \"manage_token\",\n \"manage_transform\",\n \"manage_user_profile\",\n \"manage_watcher\",\n \"monitor\",\n \"monitor_connector\",\n \"monitor_data_frame_transforms\",\n \"monitor_data_stream_global_retention\",\n \"monitor_enrich\",\n \"monitor_inference\",\n \"monitor_ml\",\n \"monitor_rollup\",\n \"monitor_snapshot\",\n \"monitor_stats\",\n \"monitor_text_structure\",\n \"monitor_transform\",\n \"monitor_watcher\",\n \"none\",\n \"post_behavioral_analytics_event\",\n \"read_ccr\",\n \"read_connector_secrets\",\n \"read_fleet_secrets\",\n \"read_ilm\",\n \"read_pipeline\",\n \"read_security\",\n \"read_slm\",\n \"transport_client\",\n \"write_connector_secrets\",\n \"write_fleet_secrets\"\n ],\n \"index\" : [\n \"all\",\n \"auto_configure\",\n \"create\",\n \"create_doc\",\n \"create_index\",\n \"cross_cluster_replication\",\n \"cross_cluster_replication_internal\",\n \"delete\",\n \"delete_index\",\n \"index\",\n \"maintenance\",\n \"manage\",\n \"manage_data_stream_lifecycle\",\n \"manage_follow_index\",\n \"manage_ilm\",\n \"manage_leader_index\",\n \"monitor\",\n \"none\",\n \"read\",\n \"read_cross_cluster\",\n \"view_index_metadata\",\n \"write\"\n ],\n \"remote_cluster\" : [\n \"monitor_enrich\",\n \"monitor_stats\"\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.3.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/privilege/_builtin\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_builtin_privileges()"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getBuiltinPrivileges();"
},
{
"lang": "Ruby",
"source": "response = client.security.get_builtin_privileges"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getBuiltinPrivileges();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/privilege/_builtin\""
},
{
"lang": "Java",
"source": "client.security().getBuiltinPrivileges();\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/service/{namespace}/{service}": {
"get": {
"tags": [
"security"
],
"summary": "Get service accounts\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/service\n
\n \n GET\n /_security/service/{namespace}\n
\n \n GET\n /_security/service/{namespace}/{service}\n
\n \n\nGet a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.\n\n## Required authorization\n\n* Cluster privileges: `manage_service_account`\n",
"externalDocs": {
"description": "More about service accounts",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-service-accounts.html"
},
"operationId": "security-get-service-accounts",
"parameters": [
{
"$ref": "#/components/parameters/security.get_service_accounts-namespace"
},
{
"$ref": "#/components/parameters/security.get_service_accounts-service"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/security.get_service_accounts-200"
}
},
"x-state": "Generally available; Added in 7.13.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/service/elastic/fleet-server\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_service_accounts(\n namespace=\"elastic\",\n service=\"fleet-server\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getServiceAccounts({\n namespace: \"elastic\",\n service: \"fleet-server\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_service_accounts(\n namespace: \"elastic\",\n service: \"fleet-server\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getServiceAccounts([\n \"namespace\" => \"elastic\",\n \"service\" => \"fleet-server\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/service/elastic/fleet-server\""
},
{
"lang": "Java",
"source": "client.security().getServiceAccounts(g -> g\n .namespace(\"elastic\")\n .service(\"fleet-server\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/service/{namespace}/{service}/credential": {
"get": {
"tags": [
"security"
],
"summary": "Get service account credentials",
"description": "To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).\n\nThe response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.\n\nNOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.\nTokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"externalDocs": {
"description": "More about service accounts",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-service-credentials.html"
},
"operationId": "security-get-service-credentials",
"parameters": [
{
"in": "path",
"name": "namespace",
"description": "The name of the namespace.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Namespace"
},
"style": "simple"
},
{
"in": "path",
"name": "service",
"description": "The service name.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"service_account": {
"type": "string"
},
"count": {
"type": "number"
},
"tokens": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.Metadata"
}
},
"nodes_credentials": {
"description": "Service account credentials collected from all nodes of the cluster.",
"allOf": [
{
"$ref": "#/components/schemas/security.get_service_credentials.NodesCredentials"
}
]
}
},
"required": [
"service_account",
"count",
"tokens",
"nodes_credentials"
]
},
"examples": {
"GetServiceCredentialsResponseExample1": {
"description": "A successful response from `GET /_security/service/elastic/fleet-server/credential`. The response contains all credentials for the `elastic/fleet-server` service account.\n",
"value": "{\n \"service_account\": \"elastic/fleet-server\",\n \"count\": 3,\n \"tokens\": {\n \"token1\": {}, \n \"token42\": {} \n },\n \"nodes_credentials\": { \n \"_nodes\": { \n \"total\": 3,\n \"successful\": 3,\n \"failed\": 0\n },\n \"file_tokens\": { \n \"my-token\": {\n \"nodes\": [ \"node0\", \"node1\" ] \n }\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.13.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/service/elastic/fleet-server/credential\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_service_credentials(\n namespace=\"elastic\",\n service=\"fleet-server\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getServiceCredentials({\n namespace: \"elastic\",\n service: \"fleet-server\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_service_credentials(\n namespace: \"elastic\",\n service: \"fleet-server\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getServiceCredentials([\n \"namespace\" => \"elastic\",\n \"service\" => \"fleet-server\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/service/elastic/fleet-server/credential\""
},
{
"lang": "Java",
"source": "client.security().getServiceCredentials(g -> g\n .namespace(\"elastic\")\n .service(\"fleet-server\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/settings": {
"get": {
"tags": [
"security"
],
"summary": "Get security index settings",
"description": "Get the user-configurable settings for the security internal index (`.security` and associated indices).\nOnly a subset of the index settings — those that are user-configurable—will be shown.\nThis includes:\n\n* `index.auto_expand_replicas`\n* `index.number_of_replicas`\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"operationId": "security-get-settings",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"security": {
"description": "Settings for the index used for most security configuration, including native realm users and roles configured with the API.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.SecuritySettings"
}
]
},
"security-profile": {
"description": "Settings for the index used to store profile information.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.SecuritySettings"
}
]
},
"security-tokens": {
"description": "Settings for the index used to store tokens.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.SecuritySettings"
}
]
}
},
"required": [
"security",
"security-profile",
"security-tokens"
]
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/settings\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_settings()"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getSettings();"
},
{
"lang": "Ruby",
"source": "response = client.security.get_settings"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getSettings();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/settings\""
},
{
"lang": "Java",
"source": "client.security().getSettings(g -> g);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"put": {
"tags": [
"security"
],
"summary": "Update security index settings",
"description": "Update the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`.\n\nNOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.\n\nIf a specific index is not in use on the system and settings are provided for it, the request will be rejected.\nThis API does not yet support configuring the settings for indices before they are in use.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"operationId": "security-update-settings",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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": "timeout",
"description": "The period to wait for a response.\nIf 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"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"security": {
"description": "Settings for the index used for most security configuration, including native realm users and roles configured with the API.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.SecuritySettings"
}
]
},
"security-profile": {
"description": "Settings for the index used to store profile information.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.SecuritySettings"
}
]
},
"security-tokens": {
"description": "Settings for the index used to store tokens.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.SecuritySettings"
}
]
}
}
},
"examples": {
"SecurityUpdateSettingsRequestExample1": {
"description": "Run `PUT /_security/settings` to modify the security settings.",
"value": "{\n \"security\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n }\n },\n \"security-tokens\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n } \n },\n \"security-profile\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n } \n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledged": {
"type": "boolean"
}
},
"required": [
"acknowledged"
]
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_security/settings\n{\n \"security\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n }\n },\n \"security-tokens\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n } \n },\n \"security-profile\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n } \n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.update_settings(\n security={\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n }\n },\n security-tokens={\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n }\n },\n security-profile={\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.updateSettings({\n security: {\n index: {\n auto_expand_replicas: \"0-all\",\n },\n },\n \"security-tokens\": {\n index: {\n auto_expand_replicas: \"0-all\",\n },\n },\n \"security-profile\": {\n index: {\n auto_expand_replicas: \"0-all\",\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.update_settings(\n body: {\n \"security\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n }\n },\n \"security-tokens\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n }\n },\n \"security-profile\": {\n \"index\": {\n \"auto_expand_replicas\": \"0-all\"\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->updateSettings([\n \"body\" => [\n \"security\" => [\n \"index\" => [\n \"auto_expand_replicas\" => \"0-all\",\n ],\n ],\n \"security-tokens\" => [\n \"index\" => [\n \"auto_expand_replicas\" => \"0-all\",\n ],\n ],\n \"security-profile\" => [\n \"index\" => [\n \"auto_expand_replicas\" => \"0-all\",\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"security\":{\"index\":{\"auto_expand_replicas\":\"0-all\"}},\"security-tokens\":{\"index\":{\"auto_expand_replicas\":\"0-all\"}},\"security-profile\":{\"index\":{\"auto_expand_replicas\":\"0-all\"}}}' \"$ELASTICSEARCH_URL/_security/settings\""
},
{
"lang": "Java",
"source": "client.security().updateSettings(u -> u\n .security(s -> s\n .index(i -> i\n .otherSettings(Map.of())\n .routingPath(List.of())\n .autoExpandReplicas(\"0-all\")\n .similarity(Map.of())\n )\n )\n .securityProfile(s -> s\n .index(i -> i\n .otherSettings(Map.of())\n .routingPath(List.of())\n .autoExpandReplicas(\"0-all\")\n .similarity(Map.of())\n )\n )\n .securityTokens(s -> s\n .index(i -> i\n .otherSettings(Map.of())\n .routingPath(List.of())\n .autoExpandReplicas(\"0-all\")\n .similarity(Map.of())\n )\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/stats": {
"get": {
"tags": [
"security"
],
"summary": "Get security stats",
"description": "Gather security usage statistics from all node(s) within the cluster.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
"operationId": "security-get-stats",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nodes": {
"description": "A map of node IDs to security statistics for that node.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.NodeSecurityStats"
}
}
},
"required": [
"nodes"
]
},
"examples": {
"SecurityStatsExample1": {
"description": "A successful response from `GET /_security/stats`.",
"value": "{\n \"nodes\": {\n \"CLeCBfYETO2mQ1R2Il5-SA\": {\n \"roles\": {\n \"dls\": {\n \"bit_set_cache\": {\n \"count\": 1,\n \"memory\": \"16b\",\n \"memory_in_bytes\": 16,\n \"hits\": 212,\n \"misses\": 1,\n \"evictions\": 0,\n \"hits_time_in_millis\": 5,\n \"misses_time_in_millis\": 0\n }\n }\n }\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 9.2.0",
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/oauth2/token": {
"post": {
"tags": [
"security"
],
"summary": "Get a token",
"description": "Create a bearer token for access without requiring basic authentication.\nThe tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface.\nAlternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting.\nWhen you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.\n\nThe get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.\n\nA successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.\n\nThe tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used.\nThat time period is defined by the `xpack.security.authc.token.timeout` setting.\nIf you want to invalidate a token immediately, you can do so by using the invalidate token API.\n\n## Required authorization\n\n* Cluster privileges: `manage_token`\n",
"externalDocs": {
"description": "More about setting up https",
"url": "https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security-plus-https#encrypt-http-communication",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-token.html"
},
"operationId": "security-get-token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"grant_type": {
"description": "The type of grant.\nSupported grant types are: `password`, `_kerberos`, `client_credentials`, and `refresh_token`.\n\nSupported values include:\n - `password`: This grant type implements the Resource Owner Password Credentials Grant of OAuth2.\nIn this grant, a trusted client exchanges the end user's credentials for an access token and (possibly) a refresh token.\nThe request needs to be made by an authenticated user but happens on behalf of another authenticated user (the one whose credentials are passed as request parameters).\nThis grant type is not suitable or designed for the self-service user creation of tokens.\n - `client_credentials`: This grant type implements the Client Credentials Grant of OAuth2.\nIt is geared for machine to machine communication and is not suitable or designed for the self-service user creation of tokens.\nIt generates only access tokens that cannot be refreshed.\nThe premise is that the entity that uses `client_credentials` has constant access to a set of (client, not end-user) credentials and can authenticate itself at will.\n - `_kerberos`: This grant type is supported internally and implements SPNEGO based Kerberos support.\nThe `_kerberos` grant type may change from version to version.\n - `refresh_token`: This grant type implements the Refresh Token Grant of OAuth2.\nIn this grant a user exchanges a previously issued refresh token for a new access token and a new refresh token.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/security.get_token.AccessTokenGrantType"
}
]
},
"scope": {
"description": "The scope of the token.\nCurrently tokens are only issued for a scope of FULL regardless of the value sent with the request.",
"type": "string"
},
"password": {
"description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Password"
}
]
},
"kerberos_ticket": {
"description": "The base64 encoded kerberos ticket.\nIf you specify the `_kerberos` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.",
"type": "string"
},
"refresh_token": {
"description": "The string that was returned when you created the token, which enables you to extend its life.\nIf you specify the `refresh_token` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.",
"type": "string"
},
"username": {
"description": "The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
}
}
},
"examples": {
"GetUserAccessTokenRequestExample1": {
"summary": "A client_credentials grant type example",
"description": "Run `POST /_security/oauth2/token` to obtain a token using the `client_credentials` grant type, which simply creates a token as the authenticated user.\n",
"value": "{\n \"grant_type\" : \"client_credentials\"\n}"
},
"GetUserAccessTokenRequestExample2": {
"summary": "A password grant type example",
"description": "Run `POST /_security/oauth2/token` to obtain a token for the `test_admin` user using the password grant type. This request needs to be made by an authenticated user with sufficient privileges that may or may not be the same as the one whose username is passed in the `username` parameter.\n",
"value": "{\n \"grant_type\" : \"password\",\n \"username\" : \"test_admin\",\n \"password\" : \"x-pack-test-password\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"expires_in": {
"type": "number"
},
"scope": {
"type": "string"
},
"type": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"kerberos_authentication_response_token": {
"type": "string"
},
"authentication": {
"allOf": [
{
"$ref": "#/components/schemas/security.get_token.AuthenticatedUser"
}
]
}
},
"required": [
"access_token",
"expires_in",
"type",
"authentication"
]
},
"examples": {
"GetUserAccessTokenResponseExample1": {
"summary": "A client_credentials grant type example",
"description": "A successful response from `POST /_security/oauth2/token`.",
"value": "{\n \"access_token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"authentication\" : {\n \"username\" : \"test_admin\",\n \"roles\" : [\n \"superuser\"\n ],\n \"full_name\" : null,\n \"email\" : null,\n \"metadata\" : { },\n \"enabled\" : true,\n \"authentication_realm\" : {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"lookup_realm\" : {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"authentication_type\" : \"realm\"\n }\n}"
},
"GetUserAccessTokenResponseExample2": {
"summary": "A password grant type example",
"description": "A successful response from `POST /_security/oauth2/token`.",
"value": "{\n \"access_token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"authentication\" : {\n \"username\" : \"test_admin\",\n \"roles\" : [\n \"superuser\"\n ],\n \"full_name\" : null,\n \"email\" : null,\n \"metadata\" : { },\n \"enabled\" : true,\n \"authentication_realm\" : {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"lookup_realm\" : {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"authentication_type\" : \"realm\"\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 5.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/oauth2/token\n{\n \"grant_type\" : \"client_credentials\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.get_token(\n grant_type=\"client_credentials\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getToken({\n grant_type: \"client_credentials\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_token(\n body: {\n \"grant_type\": \"client_credentials\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getToken([\n \"body\" => [\n \"grant_type\" => \"client_credentials\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"grant_type\":\"client_credentials\"}' \"$ELASTICSEARCH_URL/_security/oauth2/token\""
},
{
"lang": "Java",
"source": "client.security().getToken(g -> g\n .grantType(AccessTokenGrantType.ClientCredentials)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"security"
],
"summary": "Invalidate a token",
"description": "The access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours.\nThey can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.\n\nNOTE: While all parameters are optional, at least one of them is required.\nMore specifically, either one of `token` or `refresh_token` parameters is required.\nIf none of these two are specified, then `realm_name` and/or `username` need to be specified.",
"operationId": "security-invalidate-token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"description": "An access token.\nThis parameter cannot be used if any of `refresh_token`, `realm_name`, or `username` are used.",
"type": "string"
},
"refresh_token": {
"description": "A refresh token.\nThis parameter cannot be used if any of `refresh_token`, `realm_name`, or `username` are used.",
"type": "string"
},
"realm_name": {
"description": "The name of an authentication realm.\nThis parameter cannot be used with either `refresh_token` or `token`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"username": {
"description": "The username of a user.\nThis parameter cannot be used with either `refresh_token` or `token`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
}
}
},
"examples": {
"SecurityInvalidateTokenRequestExample1": {
"summary": "Invalidate an access token",
"description": "Run `DELETE /_security/oauth2/token` to invalidate an access token.\n",
"value": "{\n \"token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\"\n}"
},
"SecurityInvalidateTokenRequestExample2": {
"summary": "Invalidate a refresh token",
"description": "Run `DELETE /_security/oauth2/token` to invalidate a refresh token.\n",
"value": "{\n \"refresh_token\" : \"vLBPvmAB6KvwvJZr27cS\"\n}"
},
"SecurityInvalidateTokenRequestExample3": {
"summary": "Invalidate tokens by realm",
"description": "Run `DELETE /_security/oauth2/token` to invalidate all access tokens and refresh tokens for the `saml1` realm.",
"value": "{\n \"realm_name\" : \"saml1\"\n}"
},
"SecurityInvalidateTokenRequestExample4": {
"summary": "Invalidate tokens by user",
"description": "Run `DELETE /_security/oauth2/token` to invalidate all access tokens and refresh tokens for the user `myuser` in all realms.",
"value": "{\n \"username\" : \"myuser\"\n}"
},
"SecurityInvalidateTokenRequestExample5": {
"summary": "Invalidate tokens by user and realm",
"description": "Run `DELETE /_security/oauth2/token` to invalidate all access tokens and refresh tokens for the user `myuser` in the `saml1` realm.",
"value": "{\n \"username\" : \"myuser\",\n \"realm_name\" : \"saml1\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_count": {
"description": "The number of errors that were encountered when invalidating the tokens.",
"type": "number"
},
"error_details": {
"description": "Details about the errors.\nThis field is not present in the response when `error_count` is `0`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
},
"invalidated_tokens": {
"description": "The number of the tokens that were invalidated as part of this request.",
"type": "number"
},
"previously_invalidated_tokens": {
"description": "The number of tokens that were already invalidated.",
"type": "number"
}
},
"required": [
"error_count",
"invalidated_tokens",
"previously_invalidated_tokens"
]
},
"examples": {
"SecurityInvalidateTokenResponseExample1": {
"description": "A partially successful response from `DELETE /_security/oauth2/token`. The response includes the number of the tokens that were invalidated, the number of errors that were encountered when invalidating the tokens, and details about these errors.\n",
"value": "{\n \"invalidated_tokens\":9, \n \"previously_invalidated_tokens\":15, \n \"error_count\":2, \n \"error_details\":[ \n {\n \"type\":\"exception\",\n \"reason\":\"Elasticsearch exception [type=exception, reason=foo]\",\n \"caused_by\":{\n \"type\":\"exception\",\n \"reason\":\"Elasticsearch exception [type=illegal_argument_exception, reason=bar]\"\n }\n },\n {\n \"type\":\"exception\",\n \"reason\":\"Elasticsearch exception [type=exception, reason=boo]\",\n \"caused_by\":{\n \"type\":\"exception\",\n \"reason\":\"Elasticsearch exception [type=illegal_argument_exception, reason=far]\"\n }\n }\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 5.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_security/oauth2/token\n{\n \"token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.invalidate_token(\n token=\"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.invalidateToken({\n token:\n \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.invalidate_token(\n body: {\n \"token\": \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->invalidateToken([\n \"body\" => [\n \"token\" => \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"token\":\"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\"}' \"$ELASTICSEARCH_URL/_security/oauth2/token\""
},
{
"lang": "Java",
"source": "client.security().invalidateToken(i -> i\n .token(\"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/user/_privileges": {
"get": {
"tags": [
"security"
],
"summary": "Get user privileges",
"description": "Get the security privileges for the logged in user.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.\nTo check whether a user has a specific list of privileges, use the has privileges API.",
"operationId": "security-get-user-privileges",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ApplicationPrivileges"
}
},
"cluster": {
"type": "array",
"items": {
"type": "string"
}
},
"remote_cluster": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteClusterPrivileges"
}
},
"global": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.GlobalPrivilege"
}
},
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.UserIndicesPrivileges"
}
},
"remote_indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteUserIndicesPrivileges"
}
},
"run_as": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"applications",
"cluster",
"global",
"indices",
"run_as"
]
},
"examples": {
"SecurityGetUserPrivilegesResponseExample1": {
"description": "A successful response from `GET /_security/user/_privileges`.",
"value": "{\n \"cluster\" : [\n \"all\"\n ],\n \"global\" : [ ],\n \"indices\" : [\n {\n \"names\" : [\n \"*\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"allow_restricted_indices\" : true\n }\n ],\n \"applications\" : [\n {\n \"application\" : \"*\",\n \"privileges\" : [\n \"*\"\n ],\n \"resources\" : [\n \"*\"\n ]\n }\n ],\n \"run_as\" : [\n \"*\"\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 6.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/user/_privileges\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_user_privileges()"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getUserPrivileges();"
},
{
"lang": "Ruby",
"source": "response = client.security.get_user_privileges"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getUserPrivileges();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/user/_privileges\""
},
{
"lang": "Java",
"source": "client.security().getUserPrivileges();\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/profile/{uid}": {
"get": {
"tags": [
"security"
],
"summary": "Get a user profile",
"description": "Get a user's profile using the unique profile ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"operationId": "security-get-user-profile",
"parameters": [
{
"in": "path",
"name": "uid",
"description": "A unique identifier for the user profile.",
"required": true,
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/security._types.UserProfileId"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.UserProfileId"
}
}
]
},
"style": "simple"
},
{
"in": "query",
"name": "data",
"description": "A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content use `data=` to retrieve content nested under the specified ``.\nBy default returns no `data` content.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profiles": {
"description": "A successful call returns the JSON representation of the user profile and its internal versioning numbers.\nThe API returns an empty object if no profile document is found for the provided `uid`.\nThe content of the data field is not returned by default to avoid deserializing a potential large payload.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.UserProfileWithMetadata"
}
},
"errors": {
"allOf": [
{
"$ref": "#/components/schemas/security.get_user_profile.GetUserProfileErrors"
}
]
}
},
"required": [
"profiles"
]
},
"examples": {
"GetUserProfileResponseExample1": {
"summary": "Profile details for a UUID",
"description": "A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`. By default, no content is returned in the `data` field.\n",
"value": "{\n \"profiles\": [\n {\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {\n \"direction\": \"north\"\n },\n \"data\": {}, \n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n }\n ]\n}"
},
"GetUserProfileResponseExample2": {
"summary": "Profile details for a UUID and data key",
"description": "A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1`.\n",
"value": "{\n \"profiles\": [\n {\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {\n \"direction\": \"north\"\n },\n \"data\": {\n \"app1\": {\n \"key1\": \"value1\"\n }\n },\n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n }\n ]\n}"
},
"GetUserProfileResponseExample3": {
"summary": "Profile details with errors",
"description": "A response that contains errors that occurred while retrieving user profiles.\n",
"value": "{\n \"profiles\": [],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"u_FmxQt3gr1BBH5wpnz9HkouPj3Q710XkOgg1PWkwLPBW_5\": {\n \"type\": \"resource_not_found_exception\",\n \"reason\": \"profile document not found\"\n }\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\n"
},
{
"lang": "Python",
"source": "resp = client.security.get_user_profile(\n uid=\"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.getUserProfile({\n uid: \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.get_user_profile(\n uid: \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->getUserProfile([\n \"uid\" => \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\""
},
{
"lang": "Java",
"source": "client.security().getUserProfile(g -> g\n .data(List.of())\n .uid(\"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/api_key/grant": {
"post": {
"tags": [
"security"
],
"summary": "Grant an API key",
"description": "Create an API key on behalf of another user.\nThis API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.\nThe caller must have authentication credentials for the user on whose behalf the API key will be created.\nIt is not possible to use this API to create an API key without that user's credentials.\nThe supported user authentication credential types are:\n\n* username and password\n* Elasticsearch access tokens\n* JWTs\n\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\n## Required authorization\n\n* Cluster privileges: `grant_api_key`\n",
"operationId": "security-grant-api-key",
"parameters": [
{
"in": "query",
"name": "refresh",
"description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"api_key": {
"description": "The API key.",
"allOf": [
{
"$ref": "#/components/schemas/security.grant_api_key.GrantApiKey"
}
]
},
"grant_type": {
"description": "The type of grant. Supported grant types are: `access_token`, `password`.",
"allOf": [
{
"$ref": "#/components/schemas/security.grant_api_key.ApiKeyGrantType"
}
]
},
"access_token": {
"description": "The user's access token.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.",
"type": "string"
},
"username": {
"description": "The user name that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
},
"password": {
"description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Password"
}
]
},
"run_as": {
"description": "The name of the user to be impersonated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
}
},
"required": [
"api_key",
"grant_type"
]
},
"examples": {
"SecurityGrantApiKeyRequestExample1": {
"summary": "Grant an API key",
"description": "Run `POST /_security/api_key/grant` to create an API key on behalf of the `test_admin` user.\n",
"value": "{\n \"grant_type\": \"password\",\n \"username\" : \"test_admin\",\n \"password\" : \"x-pack-test-password\",\n \"api_key\" : {\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\",\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-a*\"],\n \"privileges\": [\"read\"]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-b*\"],\n \"privileges\": [\"all\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\"dev\", \"staging\"]\n }\n }\n }\n}"
},
"SecurityGrantApiKeyRequestExample2": {
"summary": "Grant an API key with run_as",
"description": "Run `POST /_security/api_key/grant`. The user (`test_admin`) whose credentials are provided can \"run as\" another user (`test_user`). The API key will be granted to the impersonated user (`test_user`).\n",
"value": "{\n \"grant_type\": \"password\",\n \"username\" : \"test_admin\", \n \"password\" : \"x-pack-test-password\", \n \"run_as\": \"test_user\", \n \"api_key\" : {\n \"name\": \"another-api-key\"\n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"api_key": {
"type": "string"
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"expiration": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"encoded": {
"type": "string"
}
},
"required": [
"api_key",
"id",
"name",
"encoded"
]
}
}
}
}
},
"x-state": "Generally available; Added in 7.9.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/api_key/grant\n{\n \"grant_type\": \"password\",\n \"username\" : \"test_admin\",\n \"password\" : \"x-pack-test-password\",\n \"api_key\" : {\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\",\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-a*\"],\n \"privileges\": [\"read\"]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-b*\"],\n \"privileges\": [\"all\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\"dev\", \"staging\"]\n }\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.grant_api_key(\n grant_type=\"password\",\n username=\"test_admin\",\n password=\"x-pack-test-password\",\n api_key={\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\",\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a*\"\n ],\n \"privileges\": [\n \"read\"\n ]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-b*\"\n ],\n \"privileges\": [\n \"all\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": True,\n \"tags\": [\n \"dev\",\n \"staging\"\n ]\n }\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.grantApiKey({\n grant_type: \"password\",\n username: \"test_admin\",\n password: \"x-pack-test-password\",\n api_key: {\n name: \"my-api-key\",\n expiration: \"1d\",\n role_descriptors: {\n \"role-a\": {\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index-a*\"],\n privileges: [\"read\"],\n },\n ],\n },\n \"role-b\": {\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index-b*\"],\n privileges: [\"all\"],\n },\n ],\n },\n },\n metadata: {\n application: \"my-application\",\n environment: {\n level: 1,\n trusted: true,\n tags: [\"dev\", \"staging\"],\n },\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.grant_api_key(\n body: {\n \"grant_type\": \"password\",\n \"username\": \"test_admin\",\n \"password\": \"x-pack-test-password\",\n \"api_key\": {\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\",\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a*\"\n ],\n \"privileges\": [\n \"read\"\n ]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-b*\"\n ],\n \"privileges\": [\n \"all\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\n \"dev\",\n \"staging\"\n ]\n }\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->grantApiKey([\n \"body\" => [\n \"grant_type\" => \"password\",\n \"username\" => \"test_admin\",\n \"password\" => \"x-pack-test-password\",\n \"api_key\" => [\n \"name\" => \"my-api-key\",\n \"expiration\" => \"1d\",\n \"role_descriptors\" => [\n \"role-a\" => [\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index-a*\",\n ),\n \"privileges\" => array(\n \"read\",\n ),\n ],\n ),\n ],\n \"role-b\" => [\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index-b*\",\n ),\n \"privileges\" => array(\n \"all\",\n ),\n ],\n ),\n ],\n ],\n \"metadata\" => [\n \"application\" => \"my-application\",\n \"environment\" => [\n \"level\" => 1,\n \"trusted\" => true,\n \"tags\" => array(\n \"dev\",\n \"staging\",\n ),\n ],\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"grant_type\":\"password\",\"username\":\"test_admin\",\"password\":\"x-pack-test-password\",\"api_key\":{\"name\":\"my-api-key\",\"expiration\":\"1d\",\"role_descriptors\":{\"role-a\":{\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index-a*\"],\"privileges\":[\"read\"]}]},\"role-b\":{\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index-b*\"],\"privileges\":[\"all\"]}]}},\"metadata\":{\"application\":\"my-application\",\"environment\":{\"level\":1,\"trusted\":true,\"tags\":[\"dev\",\"staging\"]}}}}' \"$ELASTICSEARCH_URL/_security/api_key/grant\""
},
{
"lang": "Java",
"source": "client.security().grantApiKey(g -> g\n .apiKey(a -> a\n .name(\"my-api-key\")\n .expiration(e -> e\n .time(\"1d\")\n )\n .roleDescriptors(Map.of(\"role-b\", RoleDescriptor.roleDescriptorOf(r -> r\n .cluster(\"all\")\n .indices(i -> i\n .names(\"index-b*\")\n .privileges(\"all\")\n )\n .remoteIndices(List.of())\n .remoteCluster(List.of())\n .global(List.of())\n .applications(List.of())\n .metadata(Map.of())\n .runAs(List.of())\n .transientMetadata(Map.of())\n ),\"role-a\", RoleDescriptor.roleDescriptorOf(r -> r\n .cluster(\"all\")\n .indices(i -> i\n .names(\"index-a*\")\n .privileges(\"read\")\n )\n .remoteIndices(List.of())\n .remoteCluster(List.of())\n .global(List.of())\n .applications(List.of())\n .metadata(Map.of())\n .runAs(List.of())\n .transientMetadata(Map.of())\n )))\n .metadata(Map.of(\"environment\", JsonData.fromJson(\"\"\"\n{\"level\":1,\"trusted\":true,\"tags\":[\"dev\",\"staging\"]}\n\"\"\"),\"application\", JsonData.fromJson(\"\\\"my-application\\\"\")))\n )\n .grantType(ApiKeyGrantType.Password)\n .password(\"x-pack-test-password\")\n .username(\"test_admin\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/user/{user}/_has_privileges": {
"post": {
"tags": [
"security"
],
"summary": "Check user privileges\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/user/_has_privileges\n
\n \n POST\n /_security/user/_has_privileges\n
\n \n GET\n /_security/user/{user}/_has_privileges\n
\n \n POST\n /_security/user/{user}/_has_privileges\n
\n \n\nDetermine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.",
"externalDocs": {
"description": "About Elasticsearch privileges",
"url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-has-privileges.html"
},
"operationId": "security-has-privileges",
"parameters": [
{
"$ref": "#/components/parameters/security.has_privileges-user"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.has_privileges"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.has_privileges-200"
}
},
"x-state": "Generally available; Added in 6.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/user/_has_privileges\n{\n \"cluster\": [ \"monitor\", \"manage\" ],\n \"index\" : [\n {\n \"names\": [ \"suppliers\", \"products\" ],\n \"privileges\": [ \"read\" ]\n },\n {\n \"names\": [ \"inventory\" ],\n \"privileges\" : [ \"read\", \"write\" ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\" : [ \"read\", \"data:write/inventory\" ],\n \"resources\" : [ \"product/1852563\" ]\n }\n ]\n}"
},
{
"lang": "Python",
"source": "resp = client.security.has_privileges(\n cluster=[\n \"monitor\",\n \"manage\"\n ],\n index=[\n {\n \"names\": [\n \"suppliers\",\n \"products\"\n ],\n \"privileges\": [\n \"read\"\n ]\n },\n {\n \"names\": [\n \"inventory\"\n ],\n \"privileges\": [\n \"read\",\n \"write\"\n ]\n }\n ],\n application=[\n {\n \"application\": \"inventory_manager\",\n \"privileges\": [\n \"read\",\n \"data:write/inventory\"\n ],\n \"resources\": [\n \"product/1852563\"\n ]\n }\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.hasPrivileges({\n cluster: [\"monitor\", \"manage\"],\n index: [\n {\n names: [\"suppliers\", \"products\"],\n privileges: [\"read\"],\n },\n {\n names: [\"inventory\"],\n privileges: [\"read\", \"write\"],\n },\n ],\n application: [\n {\n application: \"inventory_manager\",\n privileges: [\"read\", \"data:write/inventory\"],\n resources: [\"product/1852563\"],\n },\n ],\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.has_privileges(\n body: {\n \"cluster\": [\n \"monitor\",\n \"manage\"\n ],\n \"index\": [\n {\n \"names\": [\n \"suppliers\",\n \"products\"\n ],\n \"privileges\": [\n \"read\"\n ]\n },\n {\n \"names\": [\n \"inventory\"\n ],\n \"privileges\": [\n \"read\",\n \"write\"\n ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\": [\n \"read\",\n \"data:write/inventory\"\n ],\n \"resources\": [\n \"product/1852563\"\n ]\n }\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->hasPrivileges([\n \"body\" => [\n \"cluster\" => array(\n \"monitor\",\n \"manage\",\n ),\n \"index\" => array(\n [\n \"names\" => array(\n \"suppliers\",\n \"products\",\n ),\n \"privileges\" => array(\n \"read\",\n ),\n ],\n [\n \"names\" => array(\n \"inventory\",\n ),\n \"privileges\" => array(\n \"read\",\n \"write\",\n ),\n ],\n ),\n \"application\" => array(\n [\n \"application\" => \"inventory_manager\",\n \"privileges\" => array(\n \"read\",\n \"data:write/inventory\",\n ),\n \"resources\" => array(\n \"product/1852563\",\n ),\n ],\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"cluster\":[\"monitor\",\"manage\"],\"index\":[{\"names\":[\"suppliers\",\"products\"],\"privileges\":[\"read\"]},{\"names\":[\"inventory\"],\"privileges\":[\"read\",\"write\"]}],\"application\":[{\"application\":\"inventory_manager\",\"privileges\":[\"read\",\"data:write/inventory\"],\"resources\":[\"product/1852563\"]}]}' \"$ELASTICSEARCH_URL/_security/user/_has_privileges\""
},
{
"lang": "Java",
"source": "client.security().hasPrivileges(h -> h\n .application(a -> a\n .application(\"inventory_manager\")\n .privileges(List.of(\"read\",\"data:write/inventory\"))\n .resources(\"product/1852563\")\n )\n .cluster(List.of(\"monitor\",\"manage\"))\n .index(List.of(IndexPrivilegesCheck.of(i -> i\n .names(List.of(\"suppliers\",\"products\"))\n .privileges(\"read\")\n ),IndexPrivilegesCheck.of(i -> i\n .names(\"inventory\")\n .privileges(List.of(\"read\",\"write\"))\n )))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/profile/_has_privileges": {
"post": {
"tags": [
"security"
],
"summary": "Check user profile privileges\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/profile/_has_privileges\n
\n \n POST\n /_security/profile/_has_privileges\n
\n \n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"externalDocs": {
"description": "Learn more about user profiles",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/user-profiles",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-has-privileges-user-profile.html"
},
"operationId": "security-has-privileges-user-profile",
"requestBody": {
"$ref": "#/components/requestBodies/security.has_privileges_user_profile"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.has_privileges_user_profile-200"
}
},
"x-state": "Generally available; Added in 8.3.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/profile/_has_privileges\n{\n \"uids\": [\n \"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\n \"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\n \"u_does-not-exist_0\"\n ],\n \"privileges\": {\n \"cluster\": [ \"monitor\", \"create_snapshot\", \"manage_ml\" ],\n \"index\" : [\n {\n \"names\": [ \"suppliers\", \"products\" ],\n \"privileges\": [ \"create_doc\"]\n },\n {\n \"names\": [ \"inventory\" ],\n \"privileges\" : [ \"read\", \"write\" ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\" : [ \"read\", \"data:write/inventory\" ],\n \"resources\" : [ \"product/1852563\" ]\n }\n ]\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.has_privileges_user_profile(\n uids=[\n \"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\n \"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\n \"u_does-not-exist_0\"\n ],\n privileges={\n \"cluster\": [\n \"monitor\",\n \"create_snapshot\",\n \"manage_ml\"\n ],\n \"index\": [\n {\n \"names\": [\n \"suppliers\",\n \"products\"\n ],\n \"privileges\": [\n \"create_doc\"\n ]\n },\n {\n \"names\": [\n \"inventory\"\n ],\n \"privileges\": [\n \"read\",\n \"write\"\n ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\": [\n \"read\",\n \"data:write/inventory\"\n ],\n \"resources\": [\n \"product/1852563\"\n ]\n }\n ]\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.hasPrivilegesUserProfile({\n uids: [\n \"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\n \"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\n \"u_does-not-exist_0\",\n ],\n privileges: {\n cluster: [\"monitor\", \"create_snapshot\", \"manage_ml\"],\n index: [\n {\n names: [\"suppliers\", \"products\"],\n privileges: [\"create_doc\"],\n },\n {\n names: [\"inventory\"],\n privileges: [\"read\", \"write\"],\n },\n ],\n application: [\n {\n application: \"inventory_manager\",\n privileges: [\"read\", \"data:write/inventory\"],\n resources: [\"product/1852563\"],\n },\n ],\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.has_privileges_user_profile(\n body: {\n \"uids\": [\n \"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\n \"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\n \"u_does-not-exist_0\"\n ],\n \"privileges\": {\n \"cluster\": [\n \"monitor\",\n \"create_snapshot\",\n \"manage_ml\"\n ],\n \"index\": [\n {\n \"names\": [\n \"suppliers\",\n \"products\"\n ],\n \"privileges\": [\n \"create_doc\"\n ]\n },\n {\n \"names\": [\n \"inventory\"\n ],\n \"privileges\": [\n \"read\",\n \"write\"\n ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\": [\n \"read\",\n \"data:write/inventory\"\n ],\n \"resources\": [\n \"product/1852563\"\n ]\n }\n ]\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->hasPrivilegesUserProfile([\n \"body\" => [\n \"uids\" => array(\n \"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\n \"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\n \"u_does-not-exist_0\",\n ),\n \"privileges\" => [\n \"cluster\" => array(\n \"monitor\",\n \"create_snapshot\",\n \"manage_ml\",\n ),\n \"index\" => array(\n [\n \"names\" => array(\n \"suppliers\",\n \"products\",\n ),\n \"privileges\" => array(\n \"create_doc\",\n ),\n ],\n [\n \"names\" => array(\n \"inventory\",\n ),\n \"privileges\" => array(\n \"read\",\n \"write\",\n ),\n ],\n ),\n \"application\" => array(\n [\n \"application\" => \"inventory_manager\",\n \"privileges\" => array(\n \"read\",\n \"data:write/inventory\",\n ),\n \"resources\" => array(\n \"product/1852563\",\n ),\n ],\n ),\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"uids\":[\"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\"u_does-not-exist_0\"],\"privileges\":{\"cluster\":[\"monitor\",\"create_snapshot\",\"manage_ml\"],\"index\":[{\"names\":[\"suppliers\",\"products\"],\"privileges\":[\"create_doc\"]},{\"names\":[\"inventory\"],\"privileges\":[\"read\",\"write\"]}],\"application\":[{\"application\":\"inventory_manager\",\"privileges\":[\"read\",\"data:write/inventory\"],\"resources\":[\"product/1852563\"]}]}}' \"$ELASTICSEARCH_URL/_security/profile/_has_privileges\""
},
{
"lang": "Java",
"source": "client.security().hasPrivilegesUserProfile(h -> h\n .privileges(p -> p\n .application(a -> a\n .application(\"inventory_manager\")\n .privileges(List.of(\"read\",\"data:write/inventory\"))\n .resources(\"product/1852563\")\n )\n .cluster(List.of(\"monitor\",\"create_snapshot\",\"manage_ml\"))\n .index(List.of(IndexPrivilegesCheck.of(i -> i\n .names(List.of(\"suppliers\",\"products\"))\n .privileges(\"create_doc\")\n ),IndexPrivilegesCheck.of(i -> i\n .names(\"inventory\")\n .privileges(List.of(\"read\",\"write\"))\n )))\n )\n .uids(List.of(\"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\"u_does-not-exist_0\"))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/oidc/authenticate": {
"post": {
"tags": [
"security"
],
"summary": "Authenticate OpenID Connect",
"description": "Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.",
"operationId": "security-oidc-authenticate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nonce": {
"description": "Associate a client session with an ID token and mitigate replay attacks.\nThis value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call.",
"type": "string"
},
"realm": {
"description": "The name of the OpenID Connect realm.\nThis property is useful in cases where multiple realms are defined.",
"type": "string"
},
"redirect_uri": {
"description": "The URL to which the OpenID Connect Provider redirected the User Agent in response to an authentication request after a successful authentication.\nThis URL must be provided as-is (URL encoded), taken from the body of the response or as the value of a location header in the response from the OpenID Connect Provider.",
"type": "string"
},
"state": {
"description": "Maintain state between the authentication request and the response.\nThis value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call.",
"type": "string"
}
},
"required": [
"nonce",
"redirect_uri",
"state"
]
},
"examples": {
"OidcAuthenticateRequestExample1": {
"description": "Run `POST /_security/oidc/authenticate` to exchange the response that was returned from the OpenID Connect Provider after a successful authentication for an Elasticsearch access token and refresh token. This example is from an authentication that uses the authorization code grant flow.\n",
"value": "{\n \"redirect_uri\" : \"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"state\" : \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" : \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" : \"oidc1\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access_token": {
"description": "The Elasticsearch access token.",
"type": "string"
},
"expires_in": {
"description": "The duration (in seconds) of the tokens.",
"type": "number"
},
"refresh_token": {
"description": "The Elasticsearch refresh token.",
"type": "string"
},
"type": {
"description": "The type of token.",
"type": "string"
}
},
"required": [
"access_token",
"expires_in",
"refresh_token",
"type"
]
},
"examples": {
"OidcAuthenticateResponseExample1": {
"description": "A successful response from `POST /_security/oidc/authenticate`. It contains the access and refresh tokens that were generated, the token duration (in seconds), and the type.\n",
"value": "{\n \"access_token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/oidc/authenticate\n{\n \"redirect_uri\" : \"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"state\" : \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" : \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" : \"oidc1\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.oidc_authenticate(\n redirect_uri=\"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n state=\"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n nonce=\"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n realm=\"oidc1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.oidcAuthenticate({\n redirect_uri:\n \"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n state: \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n nonce: \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n realm: \"oidc1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.oidc_authenticate(\n body: {\n \"redirect_uri\": \"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"state\": \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\": \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\": \"oidc1\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->oidcAuthenticate([\n \"body\" => [\n \"redirect_uri\" => \"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"state\" => \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" => \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" => \"oidc1\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"redirect_uri\":\"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\"state\":\"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\"nonce\":\"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\"realm\":\"oidc1\"}' \"$ELASTICSEARCH_URL/_security/oidc/authenticate\""
},
{
"lang": "Java",
"source": "client.security().oidcAuthenticate(o -> o\n .nonce(\"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\")\n .realm(\"oidc1\")\n .redirectUri(\"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\")\n .state(\"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/oidc/logout": {
"post": {
"tags": [
"security"
],
"summary": "Logout of OpenID Connect",
"description": "Invalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API.\n\nIf the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.",
"operationId": "security-oidc-logout",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"description": "The access token to be invalidated.",
"type": "string"
},
"refresh_token": {
"description": "The refresh token to be invalidated.",
"type": "string"
}
},
"required": [
"token"
]
},
"examples": {
"OidcLogoutRequestExample1": {
"description": "Run `POST /_security/oidc/logout` to perform the logout.",
"value": "{\n \"token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redirect": {
"description": "A URI that points to the end session endpoint of the OpenID Connect Provider with all the parameters of the logout request as HTTP GET parameters.",
"type": "string"
}
},
"required": [
"redirect"
]
},
"examples": {
"OidcLogoutResponseExample1": {
"description": "A successful response from `POST /_security/oidc/logout`, which contains the URI pointing to the End Session Endpoint of the OpenID Connect Provider with all the parameters of the Logout Request as HTTP GET parameters.",
"value": "{\n \"redirect\" : \"https://op-provider.org/logout?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=http%3A%2F%2Foidc-kibana.elastic.co%2Floggedout&state=lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO\"\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/oidc/logout\n{\n \"token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.oidc_logout(\n token=\"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n refresh_token=\"vLBPvmAB6KvwvJZr27cS\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.oidcLogout({\n token:\n \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n refresh_token: \"vLBPvmAB6KvwvJZr27cS\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.oidc_logout(\n body: {\n \"token\": \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->oidcLogout([\n \"body\" => [\n \"token\" => \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"refresh_token\" => \"vLBPvmAB6KvwvJZr27cS\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"token\":\"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\"refresh_token\":\"vLBPvmAB6KvwvJZr27cS\"}' \"$ELASTICSEARCH_URL/_security/oidc/logout\""
},
{
"lang": "Java",
"source": "client.security().oidcLogout(o -> o\n .refreshToken(\"vLBPvmAB6KvwvJZr27cS\")\n .token(\"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/oidc/prepare": {
"post": {
"tags": [
"security"
],
"summary": "Prepare OpenID connect authentication",
"description": "Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch.\n\nThe response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.",
"operationId": "security-oidc-prepare-authentication",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"iss": {
"description": "In the case of a third party initiated single sign on, this is the issuer identifier for the OP that the RP is to send the authentication request to.\nIt cannot be specified when *realm* is specified.\nOne of *realm* or *iss* is required.",
"type": "string"
},
"login_hint": {
"description": "In the case of a third party initiated single sign on, it is a string value that is included in the authentication request as the *login_hint* parameter.\nThis parameter is not valid when *realm* is specified.",
"type": "string"
},
"nonce": {
"description": "The value used to associate a client session with an ID token and to mitigate replay attacks.\nIf the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response.",
"type": "string"
},
"realm": {
"description": "The name of the OpenID Connect realm in Elasticsearch the configuration of which should be used in order to generate the authentication request.\nIt cannot be specified when *iss* is specified.\nOne of *realm* or *iss* is required.",
"type": "string"
},
"state": {
"description": "The value used to maintain state between the authentication request and the response, typically used as a Cross-Site Request Forgery mitigation.\nIf the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response.",
"type": "string"
}
}
},
"examples": {
"OidcPrepareAuthenticationRequestExample1": {
"summary": "Prepare with realm",
"description": "Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`.\n",
"value": "{\n \"realm\" : \"oidc1\"\n}"
},
"OidcPrepareAuthenticationRequestExample2": {
"summary": "Prepare with realm, state, and nonce",
"description": "Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`, where the values for the `state` and the `nonce` have been generated by the client.\n",
"value": "{\n \"realm\" : \"oidc1\",\n \"state\" : \"lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO\",\n \"nonce\" : \"zOBXLJGUooRrbLbQk5YCcyC8AXw3iloynvluYhZ5\"\n}"
},
"OidcPrepareAuthenticationRequestExample3": {
"summary": "Prepare by realm",
"description": "Run `POST /_security/oidc/prepare` to generate an authentication request for a third party initiated single sign on. Specify the issuer that should be used for matching the appropriate OpenID Connect Authentication realm.\n",
"value": "{\n \"iss\" : \"http://127.0.0.1:8080\",\n \"login_hint\": \"this_is_an_opaque_string\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nonce": {
"type": "string"
},
"realm": {
"type": "string"
},
"redirect": {
"description": "A URI that points to the authorization endpoint of the OpenID Connect Provider with all the parameters of the authentication request as HTTP GET parameters.",
"type": "string"
},
"state": {
"type": "string"
}
},
"required": [
"nonce",
"realm",
"redirect",
"state"
]
},
"examples": {
"OidcPrepareAuthenticationResponseExample1": {
"description": "A successful response from `POST /_security/oidc/prepare`. It contains the URI pointing to the Authorization Endpoint of the OpenID Connect Provider with all the parameters of the Authentication Request as HTTP GET parameters.\n",
"value": "{\n \"redirect\" : \"http://127.0.0.1:8080/c2id-login?scope=openid&response_type=id_token&redirect_uri=https%3A%2F%2Fmy.fantastic.rp%2Fcb&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I&nonce=WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM&client_id=elasticsearch-rp\",\n \"state\" : \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" : \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" : \"oidc1\"\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/oidc/prepare\n{\n \"realm\" : \"oidc1\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.oidc_prepare_authentication(\n realm=\"oidc1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.oidcPrepareAuthentication({\n realm: \"oidc1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.oidc_prepare_authentication(\n body: {\n \"realm\": \"oidc1\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->oidcPrepareAuthentication([\n \"body\" => [\n \"realm\" => \"oidc1\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"realm\":\"oidc1\"}' \"$ELASTICSEARCH_URL/_security/oidc/prepare\""
},
{
"lang": "Java",
"source": "client.security().oidcPrepareAuthentication(o -> o\n .realm(\"oidc1\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/privilege": {
"post": {
"tags": [
"security"
],
"summary": "Create or update application privileges\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/privilege\n
\n \n POST\n /_security/privilege\n
\n \n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\nApplication names are formed from a prefix, with an optional suffix that conform to the following rules:\n\n* The prefix must begin with a lowercase ASCII letter.\n* The prefix must contain only ASCII letters or digits.\n* The prefix must be at least 3 characters long.\n* If the suffix exists, it must begin with either a dash `-` or `_`.\n* The suffix cannot contain any of the following characters: `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `*`.\n* No part of the name can contain whitespace.\n\nPrivilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.\n\nAction names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "About Elasticsearch privileges",
"url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-privileges.html"
},
"operationId": "security-put-privileges",
"parameters": [
{
"$ref": "#/components/parameters/security.put_privileges-refresh"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.put_privileges"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.put_privileges-200"
}
},
"x-state": "Generally available; Added in 6.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_security/privilege\n{\n \"myapp\": {\n \"read\": {\n \"actions\": [ \n \"data:read/*\" , \n \"action:login\" ],\n \"metadata\": { \n \"description\": \"Read access to myapp\"\n }\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.put_privileges(\n privileges={\n \"myapp\": {\n \"read\": {\n \"actions\": [\n \"data:read/*\",\n \"action:login\"\n ],\n \"metadata\": {\n \"description\": \"Read access to myapp\"\n }\n }\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.putPrivileges({\n privileges: {\n myapp: {\n read: {\n actions: [\"data:read/*\", \"action:login\"],\n metadata: {\n description: \"Read access to myapp\",\n },\n },\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.put_privileges(\n body: {\n \"myapp\": {\n \"read\": {\n \"actions\": [\n \"data:read/*\",\n \"action:login\"\n ],\n \"metadata\": {\n \"description\": \"Read access to myapp\"\n }\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->putPrivileges([\n \"body\" => [\n \"myapp\" => [\n \"read\" => [\n \"actions\" => array(\n \"data:read/*\",\n \"action:login\",\n ),\n \"metadata\" => [\n \"description\" => \"Read access to myapp\",\n ],\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"myapp\":{\"read\":{\"actions\":[\"data:read/*\",\"action:login\"],\"metadata\":{\"description\":\"Read access to myapp\"}}}}' \"$ELASTICSEARCH_URL/_security/privilege\""
},
{
"lang": "Java",
"source": "client.security().putPrivileges(p -> p\n .privileges(\"myapp\", Map.of(\"read\", Actions.of(a -> a\n .actions(List.of(\"data:read/*\",\"action:login\"))\n .metadata(\"description\", JsonData.fromJson(\"\\\"Read access to myapp\\\"\"))\n )))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/_query/api_key": {
"post": {
"tags": [
"security"
],
"summary": "Find API keys with a query\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/_query/api_key\n
\n \n POST\n /_security/_query/api_key\n
\n \n\nGet a paginated list of API keys and their information.\nYou can optionally filter the results with a query.\n\nTo use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.\nIf you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.\nRefer to the linked documentation for examples of how to find API keys:\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`,`read_security`\n",
"externalDocs": {
"description": "About query API key information",
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/query-api-keys",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-query-api-key.html"
},
"operationId": "security-query-api-keys",
"parameters": [
{
"$ref": "#/components/parameters/security.query_api_keys-with_limited_by"
},
{
"$ref": "#/components/parameters/security.query_api_keys-with_profile_uid"
},
{
"$ref": "#/components/parameters/security.query_api_keys-typed_keys"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.query_api_keys"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.query_api_keys-200"
}
},
"x-state": "Generally available; Added in 7.15.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_security/_query/api_key?with_limited_by=true\n{\n \"query\": {\n \"ids\": {\n \"values\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.query_api_keys(\n with_limited_by=True,\n query={\n \"ids\": {\n \"values\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.queryApiKeys({\n with_limited_by: \"true\",\n query: {\n ids: {\n values: [\"VuaCfGcBCdbkQm-e5aOx\"],\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.query_api_keys(\n with_limited_by: \"true\",\n body: {\n \"query\": {\n \"ids\": {\n \"values\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->queryApiKeys([\n \"with_limited_by\" => \"true\",\n \"body\" => [\n \"query\" => [\n \"ids\" => [\n \"values\" => array(\n \"VuaCfGcBCdbkQm-e5aOx\",\n ),\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":{\"ids\":{\"values\":[\"VuaCfGcBCdbkQm-e5aOx\"]}}}' \"$ELASTICSEARCH_URL/_security/_query/api_key?with_limited_by=true\""
},
{
"lang": "Java",
"source": "client.security().queryApiKeys(q -> q\n .aggregations(Map.of())\n .query(qu -> qu\n .ids(i -> i\n .values(\"VuaCfGcBCdbkQm-e5aOx\")\n )\n )\n .searchAfter(List.of())\n .sort(List.of())\n .withLimitedBy(true)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/_query/role": {
"post": {
"tags": [
"security"
],
"summary": "Find roles with a query\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/_query/role\n
\n \n POST\n /_security/_query/role\n
\n \n\nGet roles in a paginated manner.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe query roles API does not retrieve roles that are defined in roles files, nor built-in ones.\nYou can optionally filter the results with a query.\nAlso, the results can be paginated and sorted.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"operationId": "security-query-role",
"requestBody": {
"$ref": "#/components/requestBodies/security.query_role"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.query_role-200"
}
},
"x-state": "Generally available; Added in 8.15.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/_query/role\n{\n \"sort\": [\"name\"]\n}"
},
{
"lang": "Python",
"source": "resp = client.security.query_role(\n sort=[\n \"name\"\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.queryRole({\n sort: [\"name\"],\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.query_role(\n body: {\n \"sort\": [\n \"name\"\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->queryRole([\n \"body\" => [\n \"sort\" => array(\n \"name\",\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"sort\":[\"name\"]}' \"$ELASTICSEARCH_URL/_security/_query/role\""
},
{
"lang": "Java",
"source": "client.security().queryRole(q -> q\n .searchAfter(List.of())\n .sort(s -> s\n .field(f -> f\n .field(\"name\")\n )\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/_query/user": {
"post": {
"tags": [
"security"
],
"summary": "Find users with a query\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/_query/user\n
\n \n POST\n /_security/_query/user\n
\n \n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.\n\nNOTE: As opposed to the get user API, built-in users are excluded from the result.\nThis API is only for native users.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"operationId": "security-query-user",
"parameters": [
{
"$ref": "#/components/parameters/security.query_user-with_profile_uid"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.query_user"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.query_user-200"
}
},
"x-state": "Generally available; Added in 8.14.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/_query/user?with_profile_uid=true\n{\n \"query\": {\n \"prefix\": {\n \"roles\": \"other\"\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.query_user(\n with_profile_uid=True,\n query={\n \"prefix\": {\n \"roles\": \"other\"\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.queryUser({\n with_profile_uid: \"true\",\n query: {\n prefix: {\n roles: \"other\",\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.query_user(\n with_profile_uid: \"true\",\n body: {\n \"query\": {\n \"prefix\": {\n \"roles\": \"other\"\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->queryUser([\n \"with_profile_uid\" => \"true\",\n \"body\" => [\n \"query\" => [\n \"prefix\" => [\n \"roles\" => \"other\",\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":{\"prefix\":{\"roles\":\"other\"}}}' \"$ELASTICSEARCH_URL/_security/_query/user?with_profile_uid=true\""
},
{
"lang": "Java",
"source": "client.security().queryUser(q -> q\n .query(qu -> qu\n .prefix(p -> p\n .field(\"roles\")\n .value(\"other\")\n )\n )\n .searchAfter(List.of())\n .sort(List.of())\n .withProfileUid(true)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/saml/authenticate": {
"post": {
"tags": [
"security"
],
"summary": "Authenticate SAML",
"description": "Submit a SAML response message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML message that is submitted can be:\n\n* A response to a SAML authentication request that was previously created using the SAML prepare authentication API.\n* An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.\n\nIn either case, the SAML message needs to be a base64 encoded XML document with a root element of ``.\n\nAfter successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\nThis API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.",
"externalDocs": {
"description": "More about SAML authentication",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-authenticate.html"
},
"operationId": "security-saml-authenticate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"content": {
"description": "The SAML response as it was sent by the user's browser, usually a Base64 encoded XML document.",
"type": "string"
},
"ids": {
"description": "A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Ids"
}
]
},
"realm": {
"description": "The name of the realm that should authenticate the SAML response. Useful in cases where many SAML realms are defined.",
"type": "string"
}
},
"required": [
"content",
"ids"
]
},
"examples": {
"SamlAuthenticateRequestExample1": {
"description": "Run `POST /_security/saml/authenticate` to exchange a SAML Response indicating a successful authentication at the SAML IdP for an Elasticsearch access token and refresh token to be used in subsequent requests.\n",
"value": "{\n \"content\" : \"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\n \"ids\" : [\"4fee3b046395c4e751011e97f8900b5273d56685\"]\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access_token": {
"description": "The access token that was generated by Elasticsearch.",
"type": "string"
},
"username": {
"description": "The authenticated user's name.",
"type": "string"
},
"expires_in": {
"description": "The amount of time (in seconds) left until the token expires.",
"type": "number"
},
"refresh_token": {
"description": "The refresh token that was generated by Elasticsearch.",
"type": "string"
},
"realm": {
"description": "The name of the realm where the user was authenticated.",
"type": "string"
},
"in_response_to": {
"description": "The id of the request that initiated the authentication process.",
"type": "string"
}
},
"required": [
"access_token",
"username",
"expires_in",
"refresh_token",
"realm"
]
},
"examples": {
"SamlAuthenticateResponseExample1": {
"description": "A successful response from `POST /_security/saml/authenticate`.",
"value": "{\n \"access_token\" : \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"username\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"refresh_token\": \"mJdXLtmvTUSpoLwMvdBt_w\",\n \"realm\": \"saml1\",\n \"in_response_to\": \"4fee3b046395c4e751011e97f8900b5273d56685\"\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/saml/authenticate\n{\n \"content\" : \"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\n \"ids\" : [\"4fee3b046395c4e751011e97f8900b5273d56685\"]\n}"
},
{
"lang": "Python",
"source": "resp = client.security.saml_authenticate(\n content=\"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\n ids=[\n \"4fee3b046395c4e751011e97f8900b5273d56685\"\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.samlAuthenticate({\n content:\n \"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\n ids: [\"4fee3b046395c4e751011e97f8900b5273d56685\"],\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.saml_authenticate(\n body: {\n \"content\": \"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\n \"ids\": [\n \"4fee3b046395c4e751011e97f8900b5273d56685\"\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->samlAuthenticate([\n \"body\" => [\n \"content\" => \"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\n \"ids\" => array(\n \"4fee3b046395c4e751011e97f8900b5273d56685\",\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"content\":\"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\"ids\":[\"4fee3b046395c4e751011e97f8900b5273d56685\"]}' \"$ELASTICSEARCH_URL/_security/saml/authenticate\""
},
{
"lang": "Java",
"source": "client.security().samlAuthenticate(s -> s\n .content(\"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\")\n .ids(\"4fee3b046395c4e751011e97f8900b5273d56685\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/saml/complete_logout": {
"post": {
"tags": [
"security"
],
"summary": "Logout of SAML completely",
"description": "Verifies the logout response sent from the SAML IdP.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout.\nThis API verifies the response by ensuring the content is relevant and validating its signature.\nAn empty response is returned if the verification process is successful.\nThe response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.\nThe caller of this API must prepare the request accordingly so that this API can handle either of them.",
"externalDocs": {
"description": "More about SAML authentication",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-complete-logout.html"
},
"operationId": "security-saml-complete-logout",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"realm": {
"description": "The name of the SAML realm in Elasticsearch for which the configuration is used to verify the logout response.",
"type": "string"
},
"ids": {
"description": "A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Ids"
}
]
},
"query_string": {
"description": "If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI.",
"type": "string"
},
"content": {
"description": "If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response.",
"type": "string"
}
},
"required": [
"realm",
"ids"
]
},
"examples": {
"SamlCompleteLogoutRequestExample1": {
"summary": "HTTP-Redirect binding",
"description": "Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Redirect binding.\n",
"value": "{\n \"realm\": \"saml1\",\n \"ids\": [ \"_1c368075e0b3...\" ],\n \"query_string\": \"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\"\n}"
},
"SamlCompleteLogoutRequestExample2": {
"summary": "HTTP-Post binding",
"description": "Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Post binding.\n",
"value": "{\n \"realm\": \"saml1\",\n \"ids\": [ \"_1c368075e0b3...\" ],\n \"content\": \"PHNhbWxwOkxvZ291dFJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46...\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {}
}
}
},
"x-state": "Generally available; Added in 7.14.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/saml/complete_logout\n{\n \"realm\": \"saml1\",\n \"ids\": [ \"_1c368075e0b3...\" ],\n \"query_string\": \"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.saml_complete_logout(\n realm=\"saml1\",\n ids=[\n \"_1c368075e0b3...\"\n ],\n query_string=\"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.samlCompleteLogout({\n realm: \"saml1\",\n ids: [\"_1c368075e0b3...\"],\n query_string:\n \"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.saml_complete_logout(\n body: {\n \"realm\": \"saml1\",\n \"ids\": [\n \"_1c368075e0b3...\"\n ],\n \"query_string\": \"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->samlCompleteLogout([\n \"body\" => [\n \"realm\" => \"saml1\",\n \"ids\" => array(\n \"_1c368075e0b3...\",\n ),\n \"query_string\" => \"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"realm\":\"saml1\",\"ids\":[\"_1c368075e0b3...\"],\"query_string\":\"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\"}' \"$ELASTICSEARCH_URL/_security/saml/complete_logout\""
},
{
"lang": "Java",
"source": "client.security().samlCompleteLogout(s -> s\n .ids(\"_1c368075e0b3...\")\n .queryString(\"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\")\n .realm(\"saml1\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/saml/invalidate": {
"post": {
"tags": [
"security"
],
"summary": "Invalidate SAML",
"description": "Submit a SAML LogoutRequest message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe logout request comes from the SAML IdP during an IdP initiated Single Logout.\nThe custom web application can use this API to have Elasticsearch process the `LogoutRequest`.\nAfter successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.\nThus the user can be redirected back to their IdP.",
"externalDocs": {
"description": "More about SAML authentication",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-invalidate.html"
},
"operationId": "security-saml-invalidate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acs": {
"description": "The Assertion Consumer Service URL that matches the one of the SAML realm in Elasticsearch that should be used. You must specify either this parameter or the `realm` parameter.",
"type": "string"
},
"query_string": {
"description": "The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout.\nThis query should include a single parameter named `SAMLRequest` that contains a SAML logout request that is deflated and Base64 encoded.\nIf the SAML IdP has signed the logout request, the URL should include two extra parameters named `SigAlg` and `Signature` that contain the algorithm used for the signature and the signature value itself.\nIn order for Elasticsearch to be able to verify the IdP's signature, the value of the `query_string` field must be an exact match to the string provided by the browser.\nThe client application must not attempt to parse or process the string in any way.",
"type": "string"
},
"realm": {
"description": "The name of the SAML realm in Elasticsearch the configuration. You must specify either this parameter or the `acs` parameter.",
"type": "string"
}
},
"required": [
"query_string"
]
},
"examples": {
"SamlInvalidateRequestExample1": {
"description": "Run `POST /_security/saml/invalidate` to invalidate all the tokens for realm `saml1` pertaining to the user that is identified in the SAML Logout Request.\n",
"value": "{\n \"query_string\" : \"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\n \"realm\" : \"saml1\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"invalidated": {
"description": "The number of tokens that were invalidated as part of this logout.",
"type": "number"
},
"realm": {
"description": "The realm name of the SAML realm in Elasticsearch that authenticated the user.",
"type": "string"
},
"redirect": {
"description": "A SAML logout response as a parameter so that the user can be redirected back to the SAML IdP.",
"type": "string"
}
},
"required": [
"invalidated",
"realm",
"redirect"
]
},
"examples": {
"SamlInvalidateResponseExample1": {
"description": "A successful response from `POST /_security/saml/invalidate`.",
"value": "{\n \"redirect\" : \"https://my-idp.org/logout/SAMLResponse=....\",\n \"invalidated\" : 2,\n \"realm\" : \"saml1\"\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/saml/invalidate\n{\n \"query_string\" : \"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\n \"realm\" : \"saml1\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.saml_invalidate(\n query_string=\"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\n realm=\"saml1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.samlInvalidate({\n query_string:\n \"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\n realm: \"saml1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.saml_invalidate(\n body: {\n \"query_string\": \"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\n \"realm\": \"saml1\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->samlInvalidate([\n \"body\" => [\n \"query_string\" => \"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\n \"realm\" => \"saml1\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query_string\":\"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\"realm\":\"saml1\"}' \"$ELASTICSEARCH_URL/_security/saml/invalidate\""
},
{
"lang": "Java",
"source": "client.security().samlInvalidate(s -> s\n .queryString(\"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\")\n .realm(\"saml1\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/saml/logout": {
"post": {
"tags": [
"security"
],
"summary": "Logout of SAML",
"description": "Submits a request to invalidate an access token and refresh token.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API invalidates the tokens that were generated for a user by the SAML authenticate API.\nIf the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).",
"externalDocs": {
"description": "More about SAML authentication",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-logout.html"
},
"operationId": "security-saml-logout",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"description": "The access token that was returned as a response to calling the SAML authenticate API.\nAlternatively, the most recent token that was received after refreshing the original one by using a `refresh_token`.",
"type": "string"
},
"refresh_token": {
"description": "The refresh token that was returned as a response to calling the SAML authenticate API.\nAlternatively, the most recent refresh token that was received after refreshing the original access token.",
"type": "string"
}
},
"required": [
"token"
]
},
"examples": {
"SamlLogoutRequestExample1": {
"description": "Run `POST /_security/saml/logout` to invalidate the pair of tokens that were generated by calling the SAML authenticate API with a successful SAML response.\n",
"value": "{\n \"token\" : \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"refresh_token\" : \"mJdXLtmvTUSpoLwMvdBt_w\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redirect": {
"description": "A URL that contains a SAML logout request as a parameter.\nYou can use this URL to be redirected back to the SAML IdP and to initiate Single Logout.",
"type": "string"
}
},
"required": [
"redirect"
]
},
"examples": {
"SamlLogoutResponseExample1": {
"description": "A successful response from `POST /_security/saml/logout`.",
"value": "{\n \"redirect\" : \"https://my-idp.org/logout/SAMLRequest=....\"\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/saml/logout\n{\n \"token\" : \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"refresh_token\" : \"mJdXLtmvTUSpoLwMvdBt_w\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.saml_logout(\n token=\"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n refresh_token=\"mJdXLtmvTUSpoLwMvdBt_w\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.samlLogout({\n token: \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n refresh_token: \"mJdXLtmvTUSpoLwMvdBt_w\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.saml_logout(\n body: {\n \"token\": \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"refresh_token\": \"mJdXLtmvTUSpoLwMvdBt_w\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->samlLogout([\n \"body\" => [\n \"token\" => \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"refresh_token\" => \"mJdXLtmvTUSpoLwMvdBt_w\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"token\":\"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\"refresh_token\":\"mJdXLtmvTUSpoLwMvdBt_w\"}' \"$ELASTICSEARCH_URL/_security/saml/logout\""
},
{
"lang": "Java",
"source": "client.security().samlLogout(s -> s\n .refreshToken(\"mJdXLtmvTUSpoLwMvdBt_w\")\n .token(\"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/saml/prepare": {
"post": {
"tags": [
"security"
],
"summary": "Prepare SAML authentication",
"description": "Create a SAML authentication request (``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API returns a URL pointing to the SAML Identity Provider.\nYou can use the URL to redirect the browser of the user in order to continue the authentication process.\nThe URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.\nIf the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.\nThese parameters contain the algorithm used for the signature and the signature value itself.\nIt also returns a random string that uniquely identifies this SAML Authentication request.\nThe caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.",
"externalDocs": {
"description": "More about SAML authentication",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-prepare-authentication.html"
},
"operationId": "security-saml-prepare-authentication",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acs": {
"description": "The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch.\nThe realm is used to generate the authentication request. You must specify either this parameter or the `realm` parameter.",
"type": "string"
},
"realm": {
"description": "The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request.\nYou must specify either this parameter or the `acs` parameter.",
"type": "string"
},
"relay_state": {
"description": "A string that will be included in the redirect URL that this API returns as the `RelayState` query parameter.\nIf the Authentication Request is signed, this value is used as part of the signature computation.",
"type": "string"
}
}
},
"examples": {
"SamlPrepareAuthenticationRequestExample1": {
"summary": "Prepare with a realm",
"description": "Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm named `saml1`.\n",
"value": "{\n \"realm\" : \"saml1\"\n}"
},
"SamlPrepareAuthenticationRequestExample2": {
"summary": "Prepare with an ACS",
"description": "Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm with an Assertion Consuming Service (ACS) URL.\n",
"value": "{\n \"acs\" : \"https://kibana.org/api/security/saml/callback\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"description": "A unique identifier for the SAML Request to be stored by the caller of the API.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"realm": {
"description": "The name of the Elasticsearch realm that was used to construct the authentication request.",
"type": "string"
},
"redirect": {
"description": "The URL to redirect the user to.",
"type": "string"
}
},
"required": [
"id",
"realm",
"redirect"
]
},
"examples": {
"SAmlPrepareAuthenticationResponseExample1": {
"description": "A successful response from `POST /_security/saml/prepare`.",
"value": "{\n \"redirect\": \"https://my-idp.org/login?SAMLRequest=fVJdc6IwFP0rmbwDgUKLGbFDtc462%2B06FX3Yl50rBJsKCZsbrPbXL6J22hdfk%2FNx7zl3eL%2BvK7ITBqVWCfVdRolQuS6k2iR0mU2dmN6Phgh1FTQ8be2rehH%2FWoGWdESF%2FPST0NYorgElcgW1QG5zvkh%2FPfHAZbwx2upcV5SkiMLYzmqsFba1MAthdjIXy5enhL5a23DPOyo6W7kGBa7cwhZ2gO7G8OiW%2BR400kORt0bag7fzezAlk24eqcD2OxxlsNN5O3MdsW9c6CZnbq7rntF4d3s0D7BaHTZhIWN52P%2BcjiuGRbDU6cdj%2BEjJbJLQv4N4ADdhxBiEZbQuWclY4Q8iABbCXczCdSiKMAC%2FgyO2YqbQgrIJDZg%2FcFjsMD%2Fzb3gUcBa5sR%2F9oWR%2BzuJBqlPG14Jbn0DIf2TZ3Jn%2FXmSUrC5ddQB6bob37uZrJdeF4dIDHV3iuhb70Ptq83kOz53ubDLXlcwPJK0q%2FT42AqxIaAkVCkqm2tRgr49yfJGFU%2FZQ3hy3QyuUpd7obPv97kb%2FAQ%3D%3D\"}\",\n \"realm\": \"saml1\",\n \"id\": \"_989a34500a4f5bf0f00d195aa04a7804b4ed42a1\"\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/saml/prepare\n{\n \"realm\" : \"saml1\"\n}"
},
{
"lang": "Python",
"source": "resp = client.security.saml_prepare_authentication(\n realm=\"saml1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.samlPrepareAuthentication({\n realm: \"saml1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.saml_prepare_authentication(\n body: {\n \"realm\": \"saml1\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->samlPrepareAuthentication([\n \"body\" => [\n \"realm\" => \"saml1\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"realm\":\"saml1\"}' \"$ELASTICSEARCH_URL/_security/saml/prepare\""
},
{
"lang": "Java",
"source": "client.security().samlPrepareAuthentication(s -> s\n .realm(\"saml1\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/saml/metadata/{realm_name}": {
"get": {
"tags": [
"security"
],
"summary": "Create SAML service provider metadata",
"description": "Generate SAML metadata for a SAML 2.0 Service Provider.\n\nThe SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file.\nThis API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.",
"operationId": "security-saml-service-provider-metadata",
"parameters": [
{
"in": "path",
"name": "realm_name",
"description": "The name of the SAML realm in Elasticsearch.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"metadata": {
"description": "An XML string that contains a SAML Service Provider's metadata for the realm.",
"type": "string"
}
},
"required": [
"metadata"
]
},
"examples": {
"SamlServiceProviderMetadataResponseExample1": {
"description": "A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged.\n",
"value": "{\n\"metadata\": \"\"\"\">/logout\"/>/api/security/saml/callback\" index=\"1\" isDefault=\"true\"/>\"\"\"\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.11.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data\n"
},
{
"lang": "Python",
"source": "resp = client.security.update_user_profile_data(\n uid=\"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.updateUserProfileData({\n uid: \"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.update_user_profile_data(\n uid: \"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->updateUserProfileData([\n \"uid\" => \"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data\""
},
{
"lang": "Java",
"source": "client.security().updateUserProfileData(u -> u\n .data(Map.of())\n .labels(Map.of())\n .uid(\"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/profile/_suggest": {
"post": {
"tags": [
"security"
],
"summary": "Suggest a user profile\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/profile/_suggest\n
\n \n POST\n /_security/profile/_suggest\n
\n \n\nGet suggestions for user profiles that match specified search criteria.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
"operationId": "security-suggest-user-profiles",
"parameters": [
{
"$ref": "#/components/parameters/security.suggest_user_profiles-data"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.suggest_user_profiles"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.suggest_user_profiles-200"
}
},
"x-state": "Generally available; Added in 8.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/profile/_suggest\n{\n \"name\": \"jack\", \n \"hint\": {\n \"uids\": [ \n \"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\n \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n ],\n \"labels\": {\n \"direction\": [\"north\", \"east\"] \n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.suggest_user_profiles(\n name=\"jack\",\n hint={\n \"uids\": [\n \"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\n \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n ],\n \"labels\": {\n \"direction\": [\n \"north\",\n \"east\"\n ]\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.suggestUserProfiles({\n name: \"jack\",\n hint: {\n uids: [\n \"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\n \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n ],\n labels: {\n direction: [\"north\", \"east\"],\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.suggest_user_profiles(\n body: {\n \"name\": \"jack\",\n \"hint\": {\n \"uids\": [\n \"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\n \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n ],\n \"labels\": {\n \"direction\": [\n \"north\",\n \"east\"\n ]\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->suggestUserProfiles([\n \"body\" => [\n \"name\" => \"jack\",\n \"hint\" => [\n \"uids\" => array(\n \"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\n \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n ),\n \"labels\" => [\n \"direction\" => array(\n \"north\",\n \"east\",\n ),\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"name\":\"jack\",\"hint\":{\"uids\":[\"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"],\"labels\":{\"direction\":[\"north\",\"east\"]}}}' \"$ELASTICSEARCH_URL/_security/profile/_suggest\""
},
{
"lang": "Java",
"source": "client.security().suggestUserProfiles(s -> s\n .data(List.of())\n .hint(h -> h\n .uids(List.of(\"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"))\n .labels(\"direction\", List.of(\"north\",\"east\"))\n )\n .name(\"jack\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/api_key/{id}": {
"put": {
"tags": [
"security"
],
"summary": "Update an API key",
"description": "Update attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`\n",
"operationId": "security-update-api-key",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the API key to update.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"role_descriptors": {
"description": "The role descriptors to assign to this API key.\nThe API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not.\nThe structure of a role descriptor is the same as the request for the create API keys API.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleDescriptor"
}
},
"metadata": {
"description": "Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"expiration": {
"description": "The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"examples": {
"UpdateApiKeyRequestExample1": {
"summary": "Update role and metadata",
"description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key.\n",
"value": "{\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\"*\"],\n \"privileges\": [\"write\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\"production\"]\n }\n }\n}"
},
"UpdateApiKeyRequestExample2": {
"summary": "Remove permissions",
"description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. It will inherit the owner user's full permissions.\n",
"value": "{\n \"role_descriptors\": {}\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"updated": {
"description": "If `true`, the API key was updated.\nIf `false`, the API key didn't change because no change was detected.",
"type": "boolean"
}
},
"required": [
"updated"
]
},
"examples": {
"UpdateApiKeyResponseExample1": {
"summary": "Update role and metadata",
"description": "A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions.\n",
"value": "{\n \"updated\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx\n{\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\"*\"],\n \"privileges\": [\"write\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\"production\"]\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.update_api_key(\n id=\"VuaCfGcBCdbkQm-e5aOx\",\n role_descriptors={\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"write\"\n ]\n }\n ]\n }\n },\n metadata={\n \"environment\": {\n \"level\": 2,\n \"trusted\": True,\n \"tags\": [\n \"production\"\n ]\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.updateApiKey({\n id: \"VuaCfGcBCdbkQm-e5aOx\",\n role_descriptors: {\n \"role-a\": {\n indices: [\n {\n names: [\"*\"],\n privileges: [\"write\"],\n },\n ],\n },\n },\n metadata: {\n environment: {\n level: 2,\n trusted: true,\n tags: [\"production\"],\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.update_api_key(\n id: \"VuaCfGcBCdbkQm-e5aOx\",\n body: {\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"write\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\n \"production\"\n ]\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->updateApiKey([\n \"id\" => \"VuaCfGcBCdbkQm-e5aOx\",\n \"body\" => [\n \"role_descriptors\" => [\n \"role-a\" => [\n \"indices\" => array(\n [\n \"names\" => array(\n \"*\",\n ),\n \"privileges\" => array(\n \"write\",\n ),\n ],\n ),\n ],\n ],\n \"metadata\" => [\n \"environment\" => [\n \"level\" => 2,\n \"trusted\" => true,\n \"tags\" => array(\n \"production\",\n ),\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"role_descriptors\":{\"role-a\":{\"indices\":[{\"names\":[\"*\"],\"privileges\":[\"write\"]}]}},\"metadata\":{\"environment\":{\"level\":2,\"trusted\":true,\"tags\":[\"production\"]}}}' \"$ELASTICSEARCH_URL/_security/api_key/VuaCfGcBCdbkQm-e5aOx\""
},
{
"lang": "Java",
"source": "client.security().updateApiKey(u -> u\n .id(\"VuaCfGcBCdbkQm-e5aOx\")\n .metadata(\"environment\", JsonData.fromJson(\"\"\"\n{\"level\":2,\"trusted\":true,\"tags\":[\"production\"]}\n\"\"\"))\n .roleDescriptors(\"role-a\", r -> r\n .cluster(List.of())\n .indices(i -> i\n .names(\"*\")\n .privileges(\"write\")\n )\n .remoteIndices(List.of())\n .remoteCluster(List.of())\n .global(List.of())\n .applications(List.of())\n .metadata(Map.of())\n .runAs(List.of())\n .transientMetadata(Map.of())\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/cross_cluster/api_key/{id}": {
"put": {
"tags": [
"security"
],
"summary": "Update a cross-cluster API key",
"description": "Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.\n\nTo learn more about how to use this API, refer to the [Update cross cluter API key API examples page](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples).\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
"externalDocs": {
"description": "About adding remote clusters",
"url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-api-key",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-cross-cluster-api-key.html"
},
"operationId": "security-update-cross-cluster-api-key",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the cross-cluster API key to update.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access": {
"description": "The access to be granted to this API key.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.Access"
}
]
},
"expiration": {
"description": "The expiration time for the API key.\nBy default, API keys never expire. This property can be omitted to leave the value unchanged.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"metadata": {
"description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this information fully replaces metadata previously associated with the API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"certificate_identity": {
"description": "The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.\nWhen specified, this fully replaces any previously assigned certificate identity.\nTo clear an existing certificate identity, explicitly set this field to `null`.\nWhen omitted, the existing certificate identity remains unchanged.",
"type": "string"
}
},
"required": [
"access"
]
},
"examples": {
"UpdateCrossClusterApiKeyRequestExample1": {
"description": "Run `PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx` to update a cross-cluster API key, assigning it new access scope and metadata.\n",
"value": "{\n \"access\": {\n \"replication\": [\n {\n \"names\": [\"archive\"]\n }\n ]\n },\n \"metadata\": {\n \"application\": \"replication\"\n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"updated": {
"description": "If `true`, the API key was updated.\nIf `false`, the API key didn’t change because no change was detected.",
"type": "boolean"
}
},
"required": [
"updated"
]
},
"examples": {
"UpdateCrossClusterApiKeyResponseExample1": {
"description": "A successful response from `PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx` that indicates that the API key was updated.\n",
"value": "{\n \"updated\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx\n{\n \"access\": {\n \"replication\": [\n {\n \"names\": [\"archive\"]\n }\n ]\n },\n \"metadata\": {\n \"application\": \"replication\"\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.update_cross_cluster_api_key(\n id=\"VuaCfGcBCdbkQm-e5aOx\",\n access={\n \"replication\": [\n {\n \"names\": [\n \"archive\"\n ]\n }\n ]\n },\n metadata={\n \"application\": \"replication\"\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.updateCrossClusterApiKey({\n id: \"VuaCfGcBCdbkQm-e5aOx\",\n access: {\n replication: [\n {\n names: [\"archive\"],\n },\n ],\n },\n metadata: {\n application: \"replication\",\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.update_cross_cluster_api_key(\n id: \"VuaCfGcBCdbkQm-e5aOx\",\n body: {\n \"access\": {\n \"replication\": [\n {\n \"names\": [\n \"archive\"\n ]\n }\n ]\n },\n \"metadata\": {\n \"application\": \"replication\"\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->updateCrossClusterApiKey([\n \"id\" => \"VuaCfGcBCdbkQm-e5aOx\",\n \"body\" => [\n \"access\" => [\n \"replication\" => array(\n [\n \"names\" => array(\n \"archive\",\n ),\n ],\n ),\n ],\n \"metadata\" => [\n \"application\" => \"replication\",\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"access\":{\"replication\":[{\"names\":[\"archive\"]}]},\"metadata\":{\"application\":\"replication\"}}' \"$ELASTICSEARCH_URL/_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx\""
},
{
"lang": "Java",
"source": "client.security().updateCrossClusterApiKey(u -> u\n .access(a -> a\n .replication(r -> r\n .names(\"archive\")\n )\n .search(List.of())\n )\n .id(\"VuaCfGcBCdbkQm-e5aOx\")\n .metadata(\"application\", JsonData.fromJson(\"\\\"replication\\\"\"))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_security/profile/{uid}/_data": {
"post": {
"tags": [
"security"
],
"summary": "Update user profile data\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/profile/{uid}/_data\n
\n \n POST\n /_security/profile/{uid}/_data\n
\n \n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.\n\n## Required authorization\n\n* Cluster privileges: `manage_user_profile`\n",
"operationId": "security-update-user-profile-data",
"parameters": [
{
"$ref": "#/components/parameters/security.update_user_profile_data-uid"
},
{
"$ref": "#/components/parameters/security.update_user_profile_data-if_seq_no"
},
{
"$ref": "#/components/parameters/security.update_user_profile_data-if_primary_term"
},
{
"$ref": "#/components/parameters/security.update_user_profile_data-refresh"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/security.update_user_profile_data"
},
"responses": {
"200": {
"$ref": "#/components/responses/security.update_user_profile_data-200"
}
},
"x-state": "Generally available; Added in 8.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data\n{\n \"labels\": {\n \"direction\": \"east\"\n },\n \"data\": {\n \"app1\": {\n \"theme\": \"default\"\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.security.update_user_profile_data(\n uid=\"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\",\n labels={\n \"direction\": \"east\"\n },\n data={\n \"app1\": {\n \"theme\": \"default\"\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.security.updateUserProfileData({\n uid: \"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\",\n labels: {\n direction: \"east\",\n },\n data: {\n app1: {\n theme: \"default\",\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.security.update_user_profile_data(\n uid: \"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\",\n body: {\n \"labels\": {\n \"direction\": \"east\"\n },\n \"data\": {\n \"app1\": {\n \"theme\": \"default\"\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->security()->updateUserProfileData([\n \"uid\" => \"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\",\n \"body\" => [\n \"labels\" => [\n \"direction\" => \"east\",\n ],\n \"data\" => [\n \"app1\" => [\n \"theme\" => \"default\",\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"labels\":{\"direction\":\"east\"},\"data\":{\"app1\":{\"theme\":\"default\"}}}' \"$ELASTICSEARCH_URL/_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data\""
},
{
"lang": "Java",
"source": "client.security().updateUserProfileData(u -> u\n .data(\"app1\", JsonData.fromJson(\"\"\"\n{\"theme\":\"default\"}\n\"\"\"))\n .labels(\"direction\", JsonData.fromJson(\"\\\"east\\\"\"))\n .uid(\"u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_ingest/{index}/_simulate": {
"post": {
"tags": [
"ingest"
],
"summary": "Simulate data ingestion\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_ingest/_simulate\n
\n \n POST\n /_ingest/_simulate\n
\n \n GET\n /_ingest/{index}/_simulate\n
\n \n POST\n /_ingest/{index}/_simulate\n
\n \n\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.\n\n## Required authorization\n\n* Index privileges: `index`\n",
"operationId": "simulate-ingest",
"parameters": [
{
"$ref": "#/components/parameters/simulate.ingest-index"
},
{
"$ref": "#/components/parameters/simulate.ingest-pipeline"
},
{
"$ref": "#/components/parameters/simulate.ingest-merge_type"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/simulate.ingest"
},
"responses": {
"200": {
"$ref": "#/components/responses/simulate.ingest-200"
}
},
"x-state": "Experimental; Added in 8.12.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_ingest/_simulate\n{\n \"docs\": [\n {\n \"_id\": \"123\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"bar\"\n }\n },\n {\n \"_id\": \"456\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"rab\"\n }\n }\n ]\n}"
},
{
"lang": "Python",
"source": "resp = client.simulate.ingest(\n docs=[\n {\n \"_id\": \"123\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"bar\"\n }\n },\n {\n \"_id\": \"456\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"rab\"\n }\n }\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.simulate.ingest({\n docs: [\n {\n _id: \"123\",\n _index: \"my-index\",\n _source: {\n foo: \"bar\",\n },\n },\n {\n _id: \"456\",\n _index: \"my-index\",\n _source: {\n foo: \"rab\",\n },\n },\n ],\n});"
},
{
"lang": "Ruby",
"source": "response = client.simulate.ingest(\n body: {\n \"docs\": [\n {\n \"_id\": \"123\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"bar\"\n }\n },\n {\n \"_id\": \"456\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"rab\"\n }\n }\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->simulate()->ingest([\n \"body\" => [\n \"docs\" => array(\n [\n \"_id\" => \"123\",\n \"_index\" => \"my-index\",\n \"_source\" => [\n \"foo\" => \"bar\",\n ],\n ],\n [\n \"_id\" => \"456\",\n \"_index\" => \"my-index\",\n \"_source\" => [\n \"foo\" => \"rab\",\n ],\n ],\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"docs\":[{\"_id\":\"123\",\"_index\":\"my-index\",\"_source\":{\"foo\":\"bar\"}},{\"_id\":\"456\",\"_index\":\"my-index\",\"_source\":{\"foo\":\"rab\"}}]}' \"$ELASTICSEARCH_URL/_ingest/_simulate\""
},
{
"lang": "Java",
"source": "client.simulate().ingest(i -> i\n .componentTemplateSubstitutions(Map.of())\n .docs(List.of(Document.of(d -> d\n .id(\"123\")\n .index(\"my-index\")\n .source(JsonData.fromJson(\"\"\"\n{\"foo\":\"bar\"}\n\"\"\"))\n ),Document.of(d -> d\n .id(\"456\")\n .index(\"my-index\")\n .source(JsonData.fromJson(\"\"\"\n{\"foo\":\"rab\"}\n\"\"\"))\n )))\n .indexTemplateSubstitutions(Map.of())\n .pipelineSubstitutions(Map.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_slm/policy/{policy_id}": {
"get": {
"tags": [
"slm"
],
"summary": "Get policy information\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_slm/policy\n
\n \n GET\n /_slm/policy/{policy_id}\n
\n \n\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts.\n\n## Required authorization\n\n* Cluster privileges: `manage_slm`\n",
"operationId": "slm-get-lifecycle",
"parameters": [
{
"$ref": "#/components/parameters/slm.get_lifecycle-policy_id"
},
{
"$ref": "#/components/parameters/slm.get_lifecycle-master_timeout"
},
{
"$ref": "#/components/parameters/slm.get_lifecycle-timeout"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/slm.get_lifecycle-200"
}
},
"x-state": "Generally available; Added in 7.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _slm/policy/daily-snapshots?human\n"
},
{
"lang": "Python",
"source": "resp = client.slm.get_lifecycle(\n policy_id=\"daily-snapshots\",\n human=True,\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.slm.getLifecycle({\n policy_id: \"daily-snapshots\",\n human: \"true\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.slm.get_lifecycle(\n policy_id: \"daily-snapshots\",\n human: \"true\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->slm()->getLifecycle([\n \"policy_id\" => \"daily-snapshots\",\n \"human\" => \"true\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_slm/policy/daily-snapshots?human\""
},
{
"lang": "Java",
"source": "client.slm().getLifecycle(g -> g\n .policyId(\"daily-snapshots\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"put": {
"tags": [
"slm"
],
"summary": "Create or update a policy",
"description": "Create or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored.\n\n## Required authorization\n\n* Index privileges: `manage`\n* Cluster privileges: `manage_slm`\n",
"operationId": "slm-put-lifecycle",
"parameters": [
{
"in": "path",
"name": "policy_id",
"description": "The identifier for the snapshot lifecycle policy you want to create or update.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"config": {
"description": "Configuration for each snapshot created by the policy.",
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Configuration"
}
]
},
"name": {
"description": "Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"repository": {
"description": "Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.",
"type": "string"
},
"retention": {
"description": "Retention rules used to retain and delete snapshots created by the policy.",
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Retention"
}
]
},
"schedule": {
"description": "Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.CronExpression"
}
]
}
}
},
"examples": {
"PutSnapshotLifecycleRequestExample1 copy": {
"summary": "Create a policy",
"description": "Run `PUT /_slm/policy/daily-snapshots` to create a lifecycle policy. The `schedule` is when the snapshot should be taken, in this case, 1:30am daily. The `retention` details specify to: keep snapshots for 30 days; always keep at least 5 successful snapshots, even if they're more than 30 days old; keep no more than 50 successful snapshots, even if they're less than 30 days old.\n",
"value": "{\n \"schedule\": \"0 30 1 * * ?\",\n \"name\": \"\",\n \"repository\": \"my_repository\",\n \"config\": {\n \"indices\": [\"data-*\", \"important\"],\n \"ignore_unavailable\": false,\n \"include_global_state\": false\n },\n \"retention\": {\n \"expire_after\": \"30d\",\n \"min_count\": 5,\n \"max_count\": 50\n }\n}"
},
"PutSnapshotLifecycleRequestExample2": {
"summary": "Create a policy with intevals",
"description": "Run `PUT /_slm/policy/hourly-snapshots` to create a lifecycle policy that uses interval scheduling. It creates a snapshot once every hour. The first snapshot will be created one hour after the policy is modified, with subsequent snapshots every hour afterward.\n",
"value": "{\n \"schedule\": \"1h\",\n \"name\": \"\",\n \"repository\": \"my_repository\",\n \"config\": {\n \"indices\": [\"data-*\", \"important\"]\n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available; Added in 7.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_slm/policy/daily-snapshots\n{\n \"schedule\": \"0 30 1 * * ?\",\n \"name\": \"\",\n \"repository\": \"my_repository\",\n \"config\": {\n \"indices\": [\"data-*\", \"important\"],\n \"ignore_unavailable\": false,\n \"include_global_state\": false\n },\n \"retention\": {\n \"expire_after\": \"30d\",\n \"min_count\": 5,\n \"max_count\": 50\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.slm.put_lifecycle(\n policy_id=\"daily-snapshots\",\n schedule=\"0 30 1 * * ?\",\n name=\"\",\n repository=\"my_repository\",\n config={\n \"indices\": [\n \"data-*\",\n \"important\"\n ],\n \"ignore_unavailable\": False,\n \"include_global_state\": False\n },\n retention={\n \"expire_after\": \"30d\",\n \"min_count\": 5,\n \"max_count\": 50\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.slm.putLifecycle({\n policy_id: \"daily-snapshots\",\n schedule: \"0 30 1 * * ?\",\n name: \"\",\n repository: \"my_repository\",\n config: {\n indices: [\"data-*\", \"important\"],\n ignore_unavailable: false,\n include_global_state: false,\n },\n retention: {\n expire_after: \"30d\",\n min_count: 5,\n max_count: 50,\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.slm.put_lifecycle(\n policy_id: \"daily-snapshots\",\n body: {\n \"schedule\": \"0 30 1 * * ?\",\n \"name\": \"\",\n \"repository\": \"my_repository\",\n \"config\": {\n \"indices\": [\n \"data-*\",\n \"important\"\n ],\n \"ignore_unavailable\": false,\n \"include_global_state\": false\n },\n \"retention\": {\n \"expire_after\": \"30d\",\n \"min_count\": 5,\n \"max_count\": 50\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->slm()->putLifecycle([\n \"policy_id\" => \"daily-snapshots\",\n \"body\" => [\n \"schedule\" => \"0 30 1 * * ?\",\n \"name\" => \"\",\n \"repository\" => \"my_repository\",\n \"config\" => [\n \"indices\" => array(\n \"data-*\",\n \"important\",\n ),\n \"ignore_unavailable\" => false,\n \"include_global_state\" => false,\n ],\n \"retention\" => [\n \"expire_after\" => \"30d\",\n \"min_count\" => 5,\n \"max_count\" => 50,\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"schedule\":\"0 30 1 * * ?\",\"name\":\"\",\"repository\":\"my_repository\",\"config\":{\"indices\":[\"data-*\",\"important\"],\"ignore_unavailable\":false,\"include_global_state\":false},\"retention\":{\"expire_after\":\"30d\",\"min_count\":5,\"max_count\":50}}' \"$ELASTICSEARCH_URL/_slm/policy/daily-snapshots\""
},
{
"lang": "Java",
"source": "client.slm().putLifecycle(p -> p\n .config(c -> c\n .ignoreUnavailable(false)\n .indices(List.of(\"data-*\",\"important\"))\n .includeGlobalState(false)\n .featureStates(List.of())\n .metadata(Map.of())\n )\n .name(\"\")\n .policyId(\"daily-snapshots\")\n .repository(\"my_repository\")\n .retention(r -> r\n .expireAfter(e -> e\n .time(\"30d\")\n )\n .maxCount(50)\n .minCount(5)\n )\n .schedule(\"0 30 1 * * ?\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"slm"
],
"summary": "Delete a policy",
"description": "Delete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.\n\n## Required authorization\n\n* Cluster privileges: `manage_slm`\n",
"operationId": "slm-delete-lifecycle",
"parameters": [
{
"in": "path",
"name": "policy_id",
"description": "The id of the snapshot lifecycle policy to remove",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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": "timeout",
"description": "The period to wait for a response.\nIf 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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available; Added in 7.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_slm/policy/daily-snapshots\n"
},
{
"lang": "Python",
"source": "resp = client.slm.delete_lifecycle(\n policy_id=\"daily-snapshots\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.slm.deleteLifecycle({\n policy_id: \"daily-snapshots\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.slm.delete_lifecycle(\n policy_id: \"daily-snapshots\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->slm()->deleteLifecycle([\n \"policy_id\" => \"daily-snapshots\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_slm/policy/daily-snapshots\""
},
{
"lang": "Java",
"source": "client.slm().deleteLifecycle(d -> d\n .policyId(\"daily-snapshots\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_slm/policy/{policy_id}/_execute": {
"put": {
"tags": [
"slm"
],
"summary": "Run a policy",
"description": "Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.\n\n## Required authorization\n\n* Cluster privileges: `manage_slm`\n",
"operationId": "slm-execute-lifecycle",
"parameters": [
{
"in": "path",
"name": "policy_id",
"description": "The id of the snapshot lifecycle policy to be executed",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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": "timeout",
"description": "The period to wait for a response.\nIf 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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"snapshot_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"snapshot_name"
]
},
"examples": {
"ExecuteSnapshotLifecycleResponseExample1": {
"description": "Run `POST /_slm/policy/daily-snapshots/_execute` to take an immediate snapshot according to the `daily-snapshots` policy.\n",
"value": "{\n \"snapshot_name\": \"daily-snap-2019.04.24-gwrqoo2xtea3q57vvg0uea\"\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_slm/policy/daily-snapshots/_execute\n"
},
{
"lang": "Python",
"source": "resp = client.slm.execute_lifecycle(\n policy_id=\"daily-snapshots\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.slm.executeLifecycle({\n policy_id: \"daily-snapshots\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.slm.execute_lifecycle(\n policy_id: \"daily-snapshots\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->slm()->executeLifecycle([\n \"policy_id\" => \"daily-snapshots\",\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_slm/policy/daily-snapshots/_execute\""
},
{
"lang": "Java",
"source": "client.slm().executeLifecycle(e -> e\n .policyId(\"daily-snapshots\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_slm/_execute_retention": {
"post": {
"tags": [
"slm"
],
"summary": "Run a retention policy",
"description": "Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.\n\n## Required authorization\n\n* Cluster privileges: `manage_slm`\n",
"operationId": "slm-execute-retention",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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": "timeout",
"description": "The period to wait for a response.\nIf 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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _slm/_execute_retention\n"
},
{
"lang": "Python",
"source": "resp = client.slm.execute_retention()"
},
{
"lang": "JavaScript",
"source": "const response = await client.slm.executeRetention();"
},
{
"lang": "Ruby",
"source": "response = client.slm.execute_retention"
},
{
"lang": "PHP",
"source": "$resp = $client->slm()->executeRetention();"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_slm/_execute_retention\""
},
{
"lang": "Java",
"source": "client.slm().executeRetention(e -> e);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_slm/stats": {
"get": {
"tags": [
"slm"
],
"summary": "Get snapshot lifecycle management statistics",
"description": "Get global and policy-level statistics about actions taken by snapshot lifecycle management.\n\n## Required authorization\n\n* Cluster privileges: `manage_slm`\n",
"operationId": "slm-get-stats",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. 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": "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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"retention_deletion_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"retention_deletion_time_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"retention_failed": {
"type": "number"
},
"retention_runs": {
"type": "number"
},
"retention_timed_out": {
"type": "number"
},
"total_snapshots_deleted": {
"type": "number"
},
"total_snapshot_deletion_failures": {
"type": "number"
},
"total_snapshots_failed": {
"type": "number"
},
"total_snapshots_taken": {
"type": "number"
},
"policy_stats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/slm._types.SnapshotPolicyStats"
}
}
},
"required": [
"retention_deletion_time",
"retention_deletion_time_millis",
"retention_failed",
"retention_runs",
"retention_timed_out",
"total_snapshots_deleted",
"total_snapshot_deletion_failures",
"total_snapshots_failed",
"total_snapshots_taken",
"policy_stats"
]
},
"examples": {
"GetSnapshotLifecycleManagementStatsResponseExample1": {
"description": "A successful response from `GET /_slm/stats`.",
"value": "{\n \"retention_runs\": 13,\n \"retention_failed\": 0,\n \"retention_timed_out\": 0,\n \"retention_deletion_time\": \"1.4s\",\n \"retention_deletion_time_millis\": 1404,\n \"policy_stats\": [ ],\n \"total_snapshots_taken\": 1,\n \"total_snapshots_failed\": 1,\n \"total_snapshots_deleted\": 0,\n \"total_snapshot_deletion_failures\": 0\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_slm/stats\n"
},
{
"lang": "Python",
"source": "resp = client.slm.get_stats()"
},
{
"lang": "JavaScript",
"source": "const response = await client.slm.getStats();"
},
{
"lang": "Ruby",
"source": "response = client.slm.get_stats"
},
{
"lang": "PHP",
"source": "$resp = $client->slm()->getStats();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_slm/stats\""
},
{
"lang": "Java",
"source": "client.slm().getStats(g -> g);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_slm/status": {
"get": {
"tags": [
"slm"
],
"summary": "Get the snapshot lifecycle management status",
"description": "\n\n## Required authorization\n\n* Cluster privileges: `read_slm`\n",
"operationId": "slm-get-status",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"operation_mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.LifecycleOperationMode"
}
]
}
},
"required": [
"operation_mode"
]
},
"examples": {
"GetSnapshotLifecycleManagementStatusResponseExample1": {
"description": "A successful response from `GET _slm/status`.",
"value": "{\n \"operation_mode\": \"RUNNING\"\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.6.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _slm/status\n"
},
{
"lang": "Python",
"source": "resp = client.slm.get_status()"
},
{
"lang": "JavaScript",
"source": "const response = await client.slm.getStatus();"
},
{
"lang": "Ruby",
"source": "response = client.slm.get_status"
},
{
"lang": "PHP",
"source": "$resp = $client->slm()->getStatus();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_slm/status\""
},
{
"lang": "Java",
"source": "client.slm().getStatus(g -> g);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_slm/start": {
"post": {
"tags": [
"slm"
],
"summary": "Start snapshot lifecycle management",
"description": "Snapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.\n\n## Required authorization\n\n* Cluster privileges: `manage_slm`\n",
"operationId": "slm-start",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"StartSnapshotLifecycleManagementResponseExample1": {
"description": "A successful response from `POST _slm/start`.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.6.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _slm/start\n"
},
{
"lang": "Python",
"source": "resp = client.slm.start()"
},
{
"lang": "JavaScript",
"source": "const response = await client.slm.start();"
},
{
"lang": "Ruby",
"source": "response = client.slm.start"
},
{
"lang": "PHP",
"source": "$resp = $client->slm()->start();"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_slm/start\""
},
{
"lang": "Java",
"source": "client.slm().start(s -> s);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_slm/stop": {
"post": {
"tags": [
"slm"
],
"summary": "Stop snapshot lifecycle management",
"description": "Stop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running.",
"operationId": "slm-stop",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available; Added in 7.6.0",
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/_cleanup": {
"post": {
"tags": [
"snapshot"
],
"summary": "Clean up the snapshot repository",
"description": "Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"externalDocs": {
"description": "About managing snapshot",
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-cleanup",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clean-up-snapshot-repo-api.html"
},
"operationId": "snapshot-cleanup-repository",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The name of the snapshot repository to clean up.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"results": {
"description": "Statistics for cleanup operations.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.cleanup_repository.CleanupRepositoryResults"
}
]
}
},
"required": [
"results"
]
},
"examples": {
"SnapshotCleanupRepositoryResponseExample1": {
"description": "A successful response from `POST /_snapshot/my_repository/_cleanup`.",
"value": "{\n \"results\": {\n \"deleted_bytes\": 20,\n \"deleted_blobs\": 5\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_snapshot/my_repository/_cleanup\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.cleanup_repository(\n name=\"my_repository\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.cleanupRepository({\n name: \"my_repository\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.cleanup_repository(\n repository: \"my_repository\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->cleanupRepository([\n \"repository\" => \"my_repository\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_repository/_cleanup\""
},
{
"lang": "Java",
"source": "client.snapshot().cleanupRepository(c -> c\n .name(\"my_repository\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}": {
"put": {
"tags": [
"snapshot"
],
"summary": "Clone a snapshot",
"description": "Clone part of all of a snapshot into another snapshot in the same repository.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"operationId": "snapshot-clone",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The name of the snapshot repository that both source and target snapshot belong to.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "path",
"name": "snapshot",
"description": "The source snapshot name.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "path",
"name": "target_snapshot",
"description": "The target snapshot name.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"indices": {
"description": "A comma-separated list of indices to include in the snapshot.\nMulti-target syntax is supported.",
"type": "string"
}
},
"required": [
"indices"
]
},
"examples": {
"SnapshotCloneRequestExample1": {
"description": "Run `PUT /_snapshot/my_repository/source_snapshot/_clone/target_snapshot` to clone the `source_snapshot` into a new `target_snapshot`.",
"value": "{\n \"indices\": \"index_a,index_b\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available; Added in 7.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_snapshot/my_repository/source_snapshot/_clone/target_snapshot\n{\n \"indices\": \"index_a,index_b\"\n}"
},
{
"lang": "Python",
"source": "resp = client.snapshot.clone(\n repository=\"my_repository\",\n snapshot=\"source_snapshot\",\n target_snapshot=\"target_snapshot\",\n indices=\"index_a,index_b\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.clone({\n repository: \"my_repository\",\n snapshot: \"source_snapshot\",\n target_snapshot: \"target_snapshot\",\n indices: \"index_a,index_b\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.clone(\n repository: \"my_repository\",\n snapshot: \"source_snapshot\",\n target_snapshot: \"target_snapshot\",\n body: {\n \"indices\": \"index_a,index_b\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->clone([\n \"repository\" => \"my_repository\",\n \"snapshot\" => \"source_snapshot\",\n \"target_snapshot\" => \"target_snapshot\",\n \"body\" => [\n \"indices\" => \"index_a,index_b\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"indices\":\"index_a,index_b\"}' \"$ELASTICSEARCH_URL/_snapshot/my_repository/source_snapshot/_clone/target_snapshot\""
},
{
"lang": "Java",
"source": "client.snapshot().clone(c -> c\n .indices(\"index_a,index_b\")\n .repository(\"my_repository\")\n .snapshot(\"source_snapshot\")\n .targetSnapshot(\"target_snapshot\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/{snapshot}": {
"get": {
"tags": [
"snapshot"
],
"summary": "Get snapshot information",
"description": "NOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration.\n\n## Required authorization\n\n* Cluster privileges: `monitor_snapshot`\n",
"operationId": "snapshot-get",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "path",
"name": "snapshot",
"description": "A comma-separated list of snapshot names to retrieve\nWildcards (`*`) are supported.\n\n* To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`.\n* To get information about any snapshots that are currently running, use `_current`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
{
"in": "query",
"name": "after",
"description": "An offset identifier to start pagination from as returned by the next field in the response body.",
"deprecated": false,
"schema": {
"type": "string"
},
"x-state": "Generally available; Added in 7.14.0",
"style": "form"
},
{
"in": "query",
"name": "from_sort_value",
"description": "The value of the current sort column at which to start retrieval.\nIt can be a string `snapshot-` or a repository name when sorting by snapshot or repository name.\nIt can be a millisecond time value or a number when sorting by `index-` or shard count.",
"deprecated": false,
"schema": {
"type": "string"
},
"x-state": "Generally available; Added in 7.16.0",
"style": "form"
},
{
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error for any snapshots that are unavailable.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "index_details",
"description": "If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.\nThe default is `false`, meaning that this information is omitted.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 7.13.0",
"style": "form"
},
{
"in": "query",
"name": "index_names",
"description": "If `true`, the response includes the name of each index in each snapshot.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.3.0",
"style": "form"
},
{
"in": "query",
"name": "include_repository",
"description": "If `true`, the response includes the repository name in each snapshot.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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": "order",
"description": "The sort order.\nValid values are `asc` for ascending and `desc` for descending order.\nThe default behavior is ascending order.\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SortOrder"
},
"x-state": "Generally available; Added in 7.14.0",
"style": "form"
},
{
"in": "query",
"name": "offset",
"description": "Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.",
"deprecated": false,
"schema": {
"type": "number"
},
"x-state": "Generally available; Added in 7.15.0",
"style": "form"
},
{
"in": "query",
"name": "size",
"description": "The maximum number of snapshots to return.\nThe default is -1, which means to return all that match the request without limit.",
"deprecated": false,
"schema": {
"type": "number"
},
"x-state": "Generally available; Added in 7.14.0",
"style": "form"
},
{
"in": "query",
"name": "slm_policy_filter",
"description": "Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.\n\nYou can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.\nFor example, the pattern `*,-policy-a-\\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.\nNote that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.\nTo include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"x-state": "Generally available; Added in 7.16.0",
"style": "form"
},
{
"in": "query",
"name": "sort",
"description": "The sort order for the result.\nThe default behavior is sorting by snapshot start time stamp.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/snapshot._types.SnapshotSort"
},
"x-state": "Generally available; Added in 7.14.0",
"style": "form"
},
{
"in": "query",
"name": "state",
"description": "Only return snapshots with a state found in the given comma-separated list of snapshot states.\nThe default is all snapshot states.\n\nSupported values include:\n - `IN_PROGRESS`: The snapshot process has started.\n - `SUCCESS`: The snapshot process completed successfully.\n - `FAILED`: The snapshot failed.\n - `PARTIAL`: The snapshot was partially successful.\n - `INCOMPATIBLE`: The snapshot is incompatible with the current version of the cluster.\n\n",
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/snapshot._types.SnapshotState"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/snapshot._types.SnapshotState"
}
}
]
},
"x-state": "Generally available; Added in 9.1.0",
"style": "form"
},
{
"in": "query",
"name": "verbose",
"description": "If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.\n\nNOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"remaining": {
"description": "The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the `next` field value.",
"x-state": "Generally available; Added in 7.15.0",
"type": "number"
},
"total": {
"description": "The total number of snapshots that match the request when ignoring the size limit or `after` query parameter.",
"x-state": "Generally available; Added in 7.15.0",
"type": "number"
},
"next": {
"description": "If the request contained a size limit and there might be more results, a `next` field will be added to the response.\nIt can be used as the `after` query parameter to fetch additional results.",
"type": "string"
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snapshot.get.SnapshotResponseItem"
}
},
"snapshots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snapshot._types.SnapshotInfo"
}
}
},
"required": [
"remaining",
"total"
]
},
"examples": {
"SnapshotGetResponseExample1": {
"description": "A successful response from `GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000`. The response contains information for all snapshots with names starting with `snapshot_` and that started on or after timestamp `1577833200000` (Jan 1st 2020) when sorted by snapshot start time in the default ascending order.\n",
"value": "{\n \"snapshots\": [\n {\n \"snapshot\": \"snapshot_1\",\n \"uuid\": \"dKb54xw67gvdRctLCxSket\",\n \"repository\": \"my_repository\",\n \"version_id\": ,\n \"version\": ,\n \"indices\": [],\n \"data_streams\": [],\n \"feature_states\": [],\n \"include_global_state\": true,\n \"state\": \"SUCCESS\",\n \"start_time\": \"2020-07-06T21:55:18.128Z\",\n \"start_time_in_millis\": 1593093628849,\n \"end_time\": \"2020-07-06T21:55:18.129Z\",\n \"end_time_in_millis\": 1593093628850,\n \"duration_in_millis\": 1,\n \"failures\": [],\n \"shards\": {\n \"total\": 0,\n \"failed\": 0,\n \"successful\": 0\n }\n },\n {\n \"snapshot\": \"snapshot_2\",\n \"uuid\": \"vdRctLCxSketdKb54xw67g\",\n \"repository\": \"my_repository\",\n \"version_id\": ,\n \"version\": ,\n \"indices\": [],\n \"data_streams\": [],\n \"feature_states\": [],\n \"include_global_state\": true,\n \"state\": \"SUCCESS\",\n \"start_time\": \"2020-07-06T21:55:18.130Z\",\n \"start_time_in_millis\": 1593093628851,\n \"end_time\": \"2020-07-06T21:55:18.130Z\",\n \"end_time_in_millis\": 1593093628851,\n \"duration_in_millis\": 0,\n \"failures\": [],\n \"shards\": {\n \"total\": 0,\n \"failed\": 0,\n \"successful\": 0\n }\n },\n {\n \"snapshot\": \"snapshot_3\",\n \"uuid\": \"dRctdKb54xw67gvLCxSket\",\n \"repository\": \"my_repository\",\n \"version_id\": ,\n \"version\": ,\n \"indices\": [],\n \"data_streams\": [],\n \"feature_states\": [],\n \"include_global_state\": true,\n \"state\": \"SUCCESS\",\n \"start_time\": \"2020-07-06T21:55:18.131Z\",\n \"start_time_in_millis\": 1593093628852,\n \"end_time\": \"2020-07-06T21:55:18.135Z\",\n \"end_time_in_millis\": 1593093628856,\n \"duration_in_millis\": 4,\n \"failures\": [],\n \"shards\": {\n \"total\": 0,\n \"failed\": 0,\n \"successful\": 0\n }\n }\n ],\n \"total\": 3,\n \"remaining\": 0\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.get(\n repository=\"my_repository\",\n snapshot=\"snapshot_*\",\n sort=\"start_time\",\n from_sort_value=\"1577833200000\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.get({\n repository: \"my_repository\",\n snapshot: \"snapshot_*\",\n sort: \"start_time\",\n from_sort_value: 1577833200000,\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.get(\n repository: \"my_repository\",\n snapshot: \"snapshot_*\",\n sort: \"start_time\",\n from_sort_value: \"1577833200000\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->get([\n \"repository\" => \"my_repository\",\n \"snapshot\" => \"snapshot_*\",\n \"sort\" => \"start_time\",\n \"from_sort_value\" => \"1577833200000\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000\""
},
{
"lang": "Java",
"source": "client.snapshot().get(g -> g\n .fromSortValue(\"1577833200000\")\n .repository(\"my_repository\")\n .snapshot(\"snapshot_*\")\n .sort(SnapshotSort.StartTime)\n .state(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"post": {
"tags": [
"snapshot"
],
"summary": "Create a snapshot\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_snapshot/{repository}/{snapshot}\n
\n \n POST\n /_snapshot/{repository}/{snapshot}\n
\n \n\nTake a snapshot of a cluster or of data streams and indices.\n\n## Required authorization\n\n* Cluster privileges: `create_snapshot`\n",
"externalDocs": {
"description": "More about managing snapshots",
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-snapshot-api.html"
},
"operationId": "snapshot-create",
"parameters": [
{
"$ref": "#/components/parameters/snapshot.create-repository"
},
{
"$ref": "#/components/parameters/snapshot.create-snapshot"
},
{
"$ref": "#/components/parameters/snapshot.create-master_timeout"
},
{
"$ref": "#/components/parameters/snapshot.create-wait_for_completion"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/snapshot.create"
},
"responses": {
"200": {
"$ref": "#/components/responses/snapshot.create-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true\n{\n \"indices\": \"index_1,index_2\",\n \"ignore_unavailable\": true,\n \"include_global_state\": false,\n \"metadata\": {\n \"taken_by\": \"user123\",\n \"taken_because\": \"backup before upgrading\"\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.snapshot.create(\n repository=\"my_repository\",\n snapshot=\"snapshot_2\",\n wait_for_completion=True,\n indices=\"index_1,index_2\",\n ignore_unavailable=True,\n include_global_state=False,\n metadata={\n \"taken_by\": \"user123\",\n \"taken_because\": \"backup before upgrading\"\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.create({\n repository: \"my_repository\",\n snapshot: \"snapshot_2\",\n wait_for_completion: \"true\",\n indices: \"index_1,index_2\",\n ignore_unavailable: true,\n include_global_state: false,\n metadata: {\n taken_by: \"user123\",\n taken_because: \"backup before upgrading\",\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.create(\n repository: \"my_repository\",\n snapshot: \"snapshot_2\",\n wait_for_completion: \"true\",\n body: {\n \"indices\": \"index_1,index_2\",\n \"ignore_unavailable\": true,\n \"include_global_state\": false,\n \"metadata\": {\n \"taken_by\": \"user123\",\n \"taken_because\": \"backup before upgrading\"\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->create([\n \"repository\" => \"my_repository\",\n \"snapshot\" => \"snapshot_2\",\n \"wait_for_completion\" => \"true\",\n \"body\" => [\n \"indices\" => \"index_1,index_2\",\n \"ignore_unavailable\" => true,\n \"include_global_state\" => false,\n \"metadata\" => [\n \"taken_by\" => \"user123\",\n \"taken_because\" => \"backup before upgrading\",\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"indices\":\"index_1,index_2\",\"ignore_unavailable\":true,\"include_global_state\":false,\"metadata\":{\"taken_by\":\"user123\",\"taken_because\":\"backup before upgrading\"}}' \"$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_2?wait_for_completion=true\""
},
{
"lang": "Java",
"source": "client.snapshot().create(c -> c\n .expandWildcards(List.of())\n .featureStates(List.of())\n .ignoreUnavailable(true)\n .includeGlobalState(false)\n .indices(\"index_1,index_2\")\n .metadata(Map.of(\"taken_by\", JsonData.fromJson(\"\\\"user123\\\"\"),\"taken_because\", JsonData.fromJson(\"\\\"backup before upgrading\\\"\")))\n .repository(\"my_repository\")\n .snapshot(\"snapshot_2\")\n .waitForCompletion(true)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"snapshot"
],
"summary": "Delete snapshots",
"description": "\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"operationId": "snapshot-delete",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The name of the repository to delete a snapshot from.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "path",
"name": "snapshot",
"description": "A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_completion",
"description": "If `true`, the request returns a response when the matching snapshots are all deleted.\nIf `false`, the request returns a response as soon as the deletes are scheduled.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"SnapshotDeleteResponseExample1": {
"description": "A successful response from `DELETE /_snapshot/my_repository/snapshot_2,snapshot_3`. The request deletes `snapshot_2` and `snapshot_3` from the repository named `my_repository`.\n",
"value": "{\n \"acknowledged\" : true\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_snapshot/my_repository/snapshot_2,snapshot_3\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.delete(\n repository=\"my_repository\",\n snapshot=\"snapshot_2,snapshot_3\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.delete({\n repository: \"my_repository\",\n snapshot: \"snapshot_2,snapshot_3\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.delete(\n repository: \"my_repository\",\n snapshot: \"snapshot_2,snapshot_3\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->delete([\n \"repository\" => \"my_repository\",\n \"snapshot\" => \"snapshot_2,snapshot_3\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_2,snapshot_3\""
},
{
"lang": "Java",
"source": "client.snapshot().delete(d -> d\n .repository(\"my_repository\")\n .snapshot(List.of(\"snapshot_2\",\"snapshot_3\"))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}": {
"get": {
"tags": [
"snapshot"
],
"summary": "Get snapshot repository information\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_snapshot\n
\n \n GET\n /_snapshot/{repository}\n
\n\n## Required authorization\n\n* Cluster privileges: `monitor_snapshot`\n",
"operationId": "snapshot-get-repository",
"parameters": [
{
"$ref": "#/components/parameters/snapshot.get_repository-repository"
},
{
"$ref": "#/components/parameters/snapshot.get_repository-local"
},
{
"$ref": "#/components/parameters/snapshot.get_repository-master_timeout"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/snapshot.get_repository-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_snapshot/my_repository\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.get_repository(\n name=\"my_repository\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.getRepository({\n name: \"my_repository\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.get_repository(\n repository: \"my_repository\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->getRepository([\n \"repository\" => \"my_repository\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_repository\""
},
{
"lang": "Java",
"source": "client.snapshot().getRepository(g -> g\n .name(\"my_repository\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"post": {
"tags": [
"snapshot"
],
"summary": "Create or update a snapshot repository\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_snapshot/{repository}\n
\n \n POST\n /_snapshot/{repository}\n
\n \n\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"externalDocs": {
"description": "About managing snapshot",
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-snapshot-repo-api.html"
},
"operationId": "snapshot-create-repository",
"parameters": [
{
"$ref": "#/components/parameters/snapshot.create_repository-repository"
},
{
"$ref": "#/components/parameters/snapshot.create_repository-master_timeout"
},
{
"$ref": "#/components/parameters/snapshot.create_repository-timeout"
},
{
"$ref": "#/components/parameters/snapshot.create_repository-verify"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/snapshot.create_repository"
},
"responses": {
"200": {
"$ref": "#/components/responses/snapshot.create_repository-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_snapshot/my_repository\n{\n \"type\": \"fs\",\n \"settings\": {\n \"location\": \"my_backup_location\"\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.snapshot.create_repository(\n name=\"my_repository\",\n repository={\n \"type\": \"fs\",\n \"settings\": {\n \"location\": \"my_backup_location\"\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.createRepository({\n name: \"my_repository\",\n repository: {\n type: \"fs\",\n settings: {\n location: \"my_backup_location\",\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.create_repository(\n repository: \"my_repository\",\n body: {\n \"type\": \"fs\",\n \"settings\": {\n \"location\": \"my_backup_location\"\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->createRepository([\n \"repository\" => \"my_repository\",\n \"body\" => [\n \"type\" => \"fs\",\n \"settings\" => [\n \"location\" => \"my_backup_location\",\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"type\":\"fs\",\"settings\":{\"location\":\"my_backup_location\"}}' \"$ELASTICSEARCH_URL/_snapshot/my_repository\""
},
{
"lang": "Java",
"source": "client.snapshot().createRepository(c -> c\n .name(\"my_repository\")\n .repository(r -> r\n .fs(f -> f\n .settings(s -> s\n .location(\"my_backup_location\")\n )\n )\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"snapshot"
],
"summary": "Delete snapshot repositories",
"description": "When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"operationId": "snapshot-delete-repository",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The ame of the snapshot repositories to unregister.\nWildcard (`*`) patterns are supported.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE /_snapshot/my_repository\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.delete_repository(\n name=\"my_repository\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.deleteRepository({\n name: \"my_repository\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.delete_repository(\n repository: \"my_repository\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->deleteRepository([\n \"repository\" => \"my_repository\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_repository\""
},
{
"lang": "Java",
"source": "client.snapshot().deleteRepository(d -> d\n .name(\"my_repository\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/_analyze": {
"post": {
"tags": [
"snapshot"
],
"summary": "Analyze a snapshot repository",
"description": "Performs operations on a snapshot repository in order to check for incorrect behaviour.\n\nThere are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.\nSome storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do.\nThis API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.\n\nThe default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.\nRun your first analysis with the default parameter values to check for simple problems.\nSome repositories may behave correctly when lightly loaded but incorrectly under production-like workloads.\nIf the first analysis is successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`.\nAlways specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion.\nSome repositories may behave correctly when accessed by a small number of Elasticsearch nodes but incorrectly when accessed concurrently by a production-scale cluster.\nPerform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.\n\nIf the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.\nThis usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.\nIf so, this storage system is not suitable for use as a snapshot repository.\nRepository analysis triggers conditions that occur only rarely when taking snapshots in a production system.\nSnapshotting to unsuitable storage may appear to work correctly most of the time despite repository analysis failures.\nHowever your snapshot data is at risk if you store it in a snapshot repository that does not reliably pass repository analysis.\nYou can demonstrate that the analysis failure is due to an incompatible storage implementation by verifying that Elasticsearch does not detect the same problem when analysing the reference implementation of the storage protocol you are using.\nFor instance, if you are using storage that offers an API which the supplier claims to be compatible with AWS S3, verify that repositories in AWS S3 do not fail repository analysis.\nThis allows you to demonstrate to your storage supplier that a repository analysis failure must only be caused by an incompatibility with AWS S3 and cannot be attributed to a problem in Elasticsearch.\nPlease do not report Elasticsearch issues involving third-party storage systems unless you can demonstrate that the same issue exists when analysing a repository that uses the reference implementation of the same storage protocol.\nYou will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.\n\nThe analysis may also report a failure if your repository experienced a service disruption while the analysis was running.\nIn practice, occasional service disruptions are inevitable, but the analysis cannot itself distinguish such disruptions from incorrect behavior so must report all deviations from the expected behavior as failures.\nIf you are certain that you can ascribe an analysis failure to such a service disruption, wait for your service provider to resolve the disruption and then re-run the analysis.\nElasticsearch will be unable to create or restore snapshots during repository service disruptions, so you must ensure that these events occur only very rarely.\n\nIf the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.\nYou can use this information to determine the performance of your storage system.\nIf any operation fails or returns an incorrect result, the API returns an error.\nIf the API returns an error, it may not have removed all the data it wrote to the repository.\nThe error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.\nSome clients are configured to close their connection if no response is received within a certain timeout.\nAn analysis takes a long time to complete so you might need to relax any such client-side timeouts.\nOn cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.\nThe path to the leftover data is recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.\nThe analysis attempts to detect common bugs but it does not offer 100% coverage.\nAdditionally, it does not test the following:\n\n* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.\n* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.\n* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.\n\nIMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.\nThis consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.\nYou must ensure this load does not affect other users of these systems.\nAnalyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.\n\nNOTE: This API is intended for exploratory use by humans.\nYou should expect the request parameters and the response format to vary in future versions.\nThe response exposes immplementation details of the analysis which may change from version to version.\n\nNOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.\nA storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.\nThis indicates it behaves incorrectly in ways that the former version did not detect.\nYou must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\n*Implementation details*\n\nNOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions.\nThe request parameters and response format depend on details of the implementation so may also be different in newer versions.\n\nThe analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter.\nThese tasks are distributed over the data and master-eligible nodes in the cluster for execution.\n\nFor most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.\nThe size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters.\nIf any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.\nThese reads are permitted to fail, but must not return partial data.\nIf any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.\nIn this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.\nIf any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.\n\nThe executing node will use a variety of different methods to write the blob.\nFor instance, where applicable, it will use both single-part and multi-part uploads.\nSimilarly, the reading nodes will use a variety of different methods to read the data back again.\nFor instance they may read the entire blob from start to end or may read only a subset of the data.\n\nFor some blob-level tasks, the executing node will cancel the write before it is complete.\nIn this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.\n\nLinearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.\nThis operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.\nThe detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.\nRepository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.\nRepository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.\nIf an operation fails due to contention, Elasticsearch retries the operation until it succeeds.\nMost of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.\nSome operations also verify the behavior on small blobs with sizes other than 8 bytes.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"operationId": "snapshot-repository-analyze",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The name of the repository.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "blob_count",
"description": "The total number of blobs to write to the repository during the test.\nFor realistic experiments, set this parameter to at least `2000`.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "check_overwrite_protection",
"description": "Whether to run the overwrite protection check.\nFor realistic experiments, leave this parameter unset.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 9.5.0",
"style": "form"
},
{
"in": "query",
"name": "concurrency",
"description": "The number of operations to run concurrently during the test.\nFor realistic experiments, leave this parameter unset.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "detailed",
"description": "Indicates whether to return detailed results, including timing information for every operation performed during the analysis.\nIf false, it returns only a summary of the analysis.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "early_read_node_count",
"description": "The number of nodes on which to perform an early read operation while writing each blob.\nEarly read operations are only rarely performed.\nFor realistic experiments, leave this parameter unset.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "max_blob_size",
"description": "The maximum size of a blob to be written during the test.\nFor realistic experiments, set this parameter to at least `2gb`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.ByteSize"
},
"style": "form"
},
{
"in": "query",
"name": "max_total_data_size",
"description": "An upper limit on the total size of all the blobs written during the test.\nFor realistic experiments, set this parameter to at least `1tb`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.ByteSize"
},
"style": "form"
},
{
"in": "query",
"name": "rare_action_probability",
"description": "The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob.\nFor realistic experiments, leave this parameter unset.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "rarely_abort_writes",
"description": "Indicates whether to rarely cancel writes before they complete.\nFor realistic experiments, leave this parameter unset.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "read_node_count",
"description": "The number of nodes on which to read a blob after writing.\nFor realistic experiments, leave this parameter unset.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "register_operation_count",
"description": "The minimum number of linearizable register operations to perform in total.\nFor realistic experiments, set this parameter to at least `100`.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "seed",
"description": "The seed for the pseudo-random number generator used to generate the list of operations performed during the test.\nTo repeat the same set of operations in multiple experiments, use the same seed in each experiment.\nNote that the operations are performed concurrently so might not always happen in the same order on each run.\nFor realistic experiments, leave this parameter unset.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period of time to wait for the test to complete.\nIf no response is received before the timeout expires, the test is cancelled and returns an error.\nFor realistic experiments, set this parameter sufficiently long to allow the test to complete.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"blob_count": {
"description": "The number of blobs written to the repository during the test.",
"type": "number"
},
"blob_path": {
"description": "The path in the repository under which all the blobs were written during the test.",
"type": "string"
},
"concurrency": {
"description": "The number of write operations performed concurrently during the test.",
"type": "number"
},
"coordinating_node": {
"description": "The node that coordinated the analysis and performed the final cleanup.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo"
}
]
},
"delete_elapsed": {
"description": "The time it took to delete all the blobs in the container.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"delete_elapsed_nanos": {
"description": "The time it took to delete all the blobs in the container, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"details": {
"description": "A description of every read and write operation performed during the test.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.DetailsInfo"
}
]
},
"early_read_node_count": {
"description": "The limit on the number of nodes on which early read operations were performed after writing each blob.",
"type": "number"
},
"issues_detected": {
"description": "A list of correctness issues detected, which is empty if the API succeeded.\nIt is included to emphasize that a successful response does not guarantee correct behaviour in future.",
"type": "array",
"items": {
"type": "string"
}
},
"listing_elapsed": {
"description": "The time it took to retrieve a list of all the blobs in the container.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"listing_elapsed_nanos": {
"description": "The time it took to retrieve a list of all the blobs in the container, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"max_blob_size": {
"description": "The limit on the size of a blob written during the test.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_blob_size_bytes": {
"description": "The limit, in bytes, on the size of a blob written during the test.",
"type": "number"
},
"max_total_data_size": {
"description": "The limit on the total size of all blob written during the test.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_total_data_size_bytes": {
"description": "The limit, in bytes, on the total size of all blob written during the test.",
"type": "number"
},
"rare_action_probability": {
"description": "The probability of performing rare actions during the test.",
"type": "number"
},
"read_node_count": {
"description": "The limit on the number of nodes on which read operations were performed after writing each blob.",
"type": "number"
},
"repository": {
"description": "The name of the repository that was the subject of the analysis.",
"type": "string"
},
"seed": {
"description": "The seed for the pseudo-random number generator used to generate the operations used during the test.",
"type": "number"
},
"summary": {
"description": "A collection of statistics that summarize the results of the test.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.SummaryInfo"
}
]
}
},
"required": [
"blob_count",
"blob_path",
"concurrency",
"coordinating_node",
"delete_elapsed",
"delete_elapsed_nanos",
"details",
"early_read_node_count",
"issues_detected",
"listing_elapsed",
"listing_elapsed_nanos",
"max_blob_size",
"max_blob_size_bytes",
"max_total_data_size",
"max_total_data_size_bytes",
"rare_action_probability",
"read_node_count",
"repository",
"seed",
"summary"
]
}
}
}
}
},
"x-state": "Generally available; Added in 7.12.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_snapshot/my_repository/_analyze?blob_count=10&max_blob_size=1mb&timeout=120s\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.repository_analyze(\n name=\"my_repository\",\n blob_count=\"10\",\n max_blob_size=\"1mb\",\n timeout=\"120s\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.repositoryAnalyze({\n name: \"my_repository\",\n blob_count: 10,\n max_blob_size: \"1mb\",\n timeout: \"120s\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.repository_analyze(\n repository: \"my_repository\",\n blob_count: \"10\",\n max_blob_size: \"1mb\",\n timeout: \"120s\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->repositoryAnalyze([\n \"repository\" => \"my_repository\",\n \"blob_count\" => \"10\",\n \"max_blob_size\" => \"1mb\",\n \"timeout\" => \"120s\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_repository/_analyze?blob_count=10&max_blob_size=1mb&timeout=120s\""
},
{
"lang": "Java",
"source": "client.snapshot().repositoryAnalyze(r -> r\n .blobCount(10)\n .maxBlobSize(\"1mb\")\n .name(\"my_repository\")\n .timeout(t -> t\n .time(\"120s\")\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/_verify_integrity": {
"post": {
"tags": [
"snapshot"
],
"summary": "Verify the repository integrity",
"description": "Verify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\nThe default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster.\nFor instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool.\nIf you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster.\nFor large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"operationId": "snapshot-repository-verify-integrity",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The name of the snapshot repository.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
{
"in": "query",
"name": "blob_thread_pool_concurrency",
"description": "If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "index_snapshot_verification_concurrency",
"description": "The maximum number of index snapshots to verify concurrently within each index verification.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "index_verification_concurrency",
"description": "The number of indices to verify concurrently.\nThe default behavior is to use the entire `snapshot_meta` thread pool.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "max_bytes_per_sec",
"description": "If `verify_blob_contents` is `true`, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "max_failed_shard_snapshots",
"description": "The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage.\nIf your repository contains more than this number of shard snapshot failures, the verification will fail.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "meta_thread_pool_concurrency",
"description": "The maximum number of snapshot metadata operations to run concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "snapshot_verification_concurrency",
"description": "The number of snapshots to verify concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "verify_blob_contents",
"description": "Indicates whether to verify the checksum of every data blob in the repository.\nIf this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"x-state": "Experimental; Added in 8.16.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_snapshot/my_repository/_verify_integrity\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.repository_verify_integrity(\n name=\"my_repository\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.repositoryVerifyIntegrity({\n name: \"my_repository\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.repository_verify_integrity(\n repository: \"my_repository\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->repositoryVerifyIntegrity([\n \"repository\" => \"my_repository\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_repository/_verify_integrity\""
},
{
"lang": "Java",
"source": "client.snapshot().repositoryVerifyIntegrity(r -> r\n .name(\"my_repository\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/{snapshot}/_restore": {
"post": {
"tags": [
"snapshot"
],
"summary": "Restore a snapshot",
"description": "Restore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"externalDocs": {
"description": "More about restoring a snapshot",
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/restore-snapshot",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/restore-snapshot-api.html"
},
"operationId": "snapshot-restore",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The name of the repository to restore a snapshot from.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "path",
"name": "snapshot",
"description": "The name of the snapshot to restore.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_completion",
"description": "If `true`, the request returns a response when the restore operation completes.\nThe operation is complete when it finishes all attempts to recover primary shards for restored indices.\nThis applies even if one or more of the recovery attempts fail.\n\nIf `false`, the request returns a response when the restore operation initializes.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"feature_states": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore#feature-state"
},
"description": "The feature states to restore.\nIf `include_global_state` is `true`, the request restores all feature states in the snapshot by default.\nIf `include_global_state` is `false`, the request restores no feature states by default.\nNote that specifying an empty array will result in the default behavior.\nTo restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`[\"none\"]`).",
"type": "array",
"items": {
"type": "string"
}
},
"ignore_index_settings": {
"description": "The index settings to not restore from the snapshot.\nYou can't use this option to ignore `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.",
"type": "array",
"items": {
"type": "string"
}
},
"ignore_unavailable": {
"description": "If `true`, the request ignores any index or data stream in indices that's missing from the snapshot.\nIf `false`, the request returns an error for any missing index or data stream.",
"default": false,
"type": "boolean"
},
"include_aliases": {
"description": "If `true`, the request restores aliases for any restored data streams and indices.\nIf `false`, the request doesn’t restore aliases.",
"default": true,
"type": "boolean"
},
"include_global_state": {
"description": "If `true`, restore the cluster state. The cluster state includes:\n\n* Persistent cluster settings\n* Index templates\n* Legacy index templates\n* Ingest pipelines\n* Index lifecycle management (ILM) policies\n* Stored scripts\n* For snapshots taken after 7.12.0, feature states\n\nIf `include_global_state` is `true`, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot.\nIt completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot.\n\nUse the `feature_states` parameter to configure how feature states are restored.\n\nIf `include_global_state` is `true` and a snapshot was created without a global state then the restore request will fail.",
"default": false,
"type": "boolean"
},
"index_settings": {
"description": "Index settings to add or change in restored indices, including backing indices.\nYou can't use this option to change `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"indices": {
"description": "A comma-separated list of indices and data streams to restore.\nIt supports a multi-target syntax.\nThe default behavior is all regular indices and regular data streams in the snapshot.\n\nYou can't use this parameter to restore system indices or system data streams.\nUse `feature_states` instead.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"partial": {
"description": "If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.\n\nIf true, it allows restoring a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.",
"default": false,
"type": "boolean"
},
"rename_pattern": {
"externalDocs": {
"url": "https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#appendReplacement-java.lang.StringBuffer-java.lang.String-"
},
"description": "A rename pattern to apply to restored data streams and indices.\nData streams and indices matching the rename pattern will be renamed according to `rename_replacement`.\n\nThe rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the `appendReplacement` logic.",
"type": "string"
},
"rename_replacement": {
"description": "The rename replacement string that is used with the `rename_pattern`.",
"type": "string"
}
}
},
"examples": {
"SnapshotRestoreRequestExample1": {
"summary": "Restore with rename pattern",
"description": "Run `POST /_snapshot/my_repository/snapshot_2/_restore?wait_for_completion=true`. It restores `index_1` and `index_2` from `snapshot_2`. The `rename_pattern` and `rename_replacement` parameters indicate any index matching the regular expression `index_(.+)` will be renamed using the pattern `restored_index_$1`. For example, `index_1` will be renamed to `restored_index_1`.\n",
"value": "{\n \"indices\": \"index_1,index_2\",\n \"ignore_unavailable\": true,\n \"include_global_state\": false,\n \"rename_pattern\": \"index_(.+)\",\n \"rename_replacement\": \"restored_index_$1\",\n \"include_aliases\": false\n}"
},
"SnapshotRestoreRequestExample2": {
"summary": "Restore in-place",
"description": "Close `index_1` then run `POST /_snapshot/my_repository/snapshot_2/_restore?wait_for_completion=true` to restore an index in-place. For example, you might want to perform this type of restore operation when no alternative options surface after the cluster allocation explain API reports `no_valid_shard_copy`.\n",
"value": "{\n \"indices\": \"index_1\"\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"snapshot": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot.restore.SnapshotRestore"
}
]
}
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST /_snapshot/my_repository/snapshot_2/_restore?wait_for_completion=true\n{\n \"indices\": \"index_1,index_2\",\n \"ignore_unavailable\": true,\n \"include_global_state\": false,\n \"rename_pattern\": \"index_(.+)\",\n \"rename_replacement\": \"restored_index_$1\",\n \"include_aliases\": false\n}"
},
{
"lang": "Python",
"source": "resp = client.snapshot.restore(\n repository=\"my_repository\",\n snapshot=\"snapshot_2\",\n wait_for_completion=True,\n indices=\"index_1,index_2\",\n ignore_unavailable=True,\n include_global_state=False,\n rename_pattern=\"index_(.+)\",\n rename_replacement=\"restored_index_$1\",\n include_aliases=False,\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.restore({\n repository: \"my_repository\",\n snapshot: \"snapshot_2\",\n wait_for_completion: \"true\",\n indices: \"index_1,index_2\",\n ignore_unavailable: true,\n include_global_state: false,\n rename_pattern: \"index_(.+)\",\n rename_replacement: \"restored_index_$1\",\n include_aliases: false,\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.restore(\n repository: \"my_repository\",\n snapshot: \"snapshot_2\",\n wait_for_completion: \"true\",\n body: {\n \"indices\": \"index_1,index_2\",\n \"ignore_unavailable\": true,\n \"include_global_state\": false,\n \"rename_pattern\": \"index_(.+)\",\n \"rename_replacement\": \"restored_index_$1\",\n \"include_aliases\": false\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->restore([\n \"repository\" => \"my_repository\",\n \"snapshot\" => \"snapshot_2\",\n \"wait_for_completion\" => \"true\",\n \"body\" => [\n \"indices\" => \"index_1,index_2\",\n \"ignore_unavailable\" => true,\n \"include_global_state\" => false,\n \"rename_pattern\" => \"index_(.+)\",\n \"rename_replacement\" => \"restored_index_$1\",\n \"include_aliases\" => false,\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"indices\":\"index_1,index_2\",\"ignore_unavailable\":true,\"include_global_state\":false,\"rename_pattern\":\"index_(.+)\",\"rename_replacement\":\"restored_index_$1\",\"include_aliases\":false}' \"$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_2/_restore?wait_for_completion=true\""
},
{
"lang": "Java",
"source": "client.snapshot().restore(r -> r\n .featureStates(List.of())\n .ignoreIndexSettings(List.of())\n .ignoreUnavailable(true)\n .includeAliases(false)\n .includeGlobalState(false)\n .indices(\"index_1,index_2\")\n .renamePattern(\"index_(.+)\")\n .renameReplacement(\"restored_index_$1\")\n .repository(\"my_repository\")\n .snapshot(\"snapshot_2\")\n .waitForCompletion(true)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/{snapshot}/_status": {
"get": {
"tags": [
"snapshot"
],
"summary": "Get the snapshot status\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_snapshot/_status\n
\n \n GET\n /_snapshot/{repository}/_status\n
\n \n GET\n /_snapshot/{repository}/{snapshot}/_status\n
\n \n\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running.\n\nNote that the stats will not be available for any shard snapshots in an ongoing snapshot completed by a node that (even momentarily) left the cluster.\nLoading the stats from the repository is an expensive operation (see the WARNING below).\nTherefore the stats values for such shards will be -1 even though the \"stage\" value will be \"DONE\", in order to minimize latency.\nA \"description\" field will be present for a shard snapshot completed by a departed node explaining why the shard snapshot's stats results are invalid.\nConsequently, the total stats for the index will be less than expected due to the missing values from these shards.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.\n\n## Required authorization\n\n* Cluster privileges: `monitor_snapshot`\n",
"operationId": "snapshot-status",
"parameters": [
{
"$ref": "#/components/parameters/snapshot.status-repository"
},
{
"$ref": "#/components/parameters/snapshot.status-snapshot"
},
{
"$ref": "#/components/parameters/snapshot.status-ignore_unavailable"
},
{
"$ref": "#/components/parameters/snapshot.status-master_timeout"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/snapshot.status-200"
}
},
"x-state": "Generally available; Added in 7.8.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _snapshot/my_repository/snapshot_2/_status\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.status(\n repository=\"my_repository\",\n snapshot=\"snapshot_2\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.status({\n repository: \"my_repository\",\n snapshot: \"snapshot_2\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.status(\n repository: \"my_repository\",\n snapshot: \"snapshot_2\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->status([\n \"repository\" => \"my_repository\",\n \"snapshot\" => \"snapshot_2\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_2/_status\""
},
{
"lang": "Java",
"source": "client.snapshot().status(s -> s\n .repository(\"my_repository\")\n .snapshot(\"snapshot_2\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_snapshot/{repository}/_verify": {
"post": {
"tags": [
"snapshot"
],
"summary": "Verify a snapshot repository",
"description": "Check for common misconfigurations in a snapshot repository.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"externalDocs": {
"description": "About managing snapshot",
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-verification",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/verify-snapshot-repo-api.html"
},
"operationId": "snapshot-verify-repository",
"parameters": [
{
"in": "path",
"name": "repository",
"description": "The name of the snapshot repository to verify.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nodes": {
"description": "Information about the nodes connected to the snapshot repository.\nThe key is the ID of the node.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/snapshot.verify_repository.CompactNodeInfo"
}
}
},
"required": [
"nodes"
]
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _snapshot/my_unverified_backup/_verify\n"
},
{
"lang": "Python",
"source": "resp = client.snapshot.verify_repository(\n name=\"my_unverified_backup\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.snapshot.verifyRepository({\n name: \"my_unverified_backup\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.snapshot.verify_repository(\n repository: \"my_unverified_backup\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->snapshot()->verifyRepository([\n \"repository\" => \"my_unverified_backup\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_snapshot/my_unverified_backup/_verify\""
},
{
"lang": "Java",
"source": "client.snapshot().verifyRepository(v -> v\n .name(\"my_unverified_backup\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_sql/close": {
"post": {
"tags": [
"sql"
],
"summary": "Clear an SQL search cursor",
"operationId": "sql-clear-cursor",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"description": "Cursor to clear.",
"type": "string"
}
},
"required": [
"cursor"
]
},
"examples": {
"ClearSqlCursorRequestExample1": {
"description": "Run `POST _sql/close` to clear an SQL search cursor.",
"value": "{\n \"cursor\": \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"succeeded": {
"type": "boolean"
}
},
"required": [
"succeeded"
]
}
}
}
}
},
"x-state": "Generally available; Added in 6.3.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _sql/close\n{\n \"cursor\": \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\"\n}"
},
{
"lang": "Python",
"source": "resp = client.sql.clear_cursor(\n cursor=\"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.sql.clearCursor({\n cursor:\n \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.sql.clear_cursor(\n body: {\n \"cursor\": \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->sql()->clearCursor([\n \"body\" => [\n \"cursor\" => \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"cursor\":\"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\"}' \"$ELASTICSEARCH_URL/_sql/close\""
},
{
"lang": "Java",
"source": "client.sql().clearCursor(c -> c\n .cursor(\"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_sql/async/delete/{id}": {
"delete": {
"tags": [
"sql"
],
"summary": "Delete an async SQL search",
"description": "Delete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.\n\n## Required authorization\n\n* Cluster privileges: `cancel_task`\n",
"operationId": "sql-delete-async",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The identifier for the search.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available; Added in 7.15.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE _sql/async/delete/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\n"
},
{
"lang": "Python",
"source": "resp = client.sql.delete_async(\n id=\"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.sql.deleteAsync({\n id: \"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.sql.delete_async(\n id: \"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->sql()->deleteAsync([\n \"id\" => \"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_sql/async/delete/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\""
},
{
"lang": "Java",
"source": "client.sql().deleteAsync(d -> d\n .id(\"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_sql/async/{id}": {
"get": {
"tags": [
"sql"
],
"summary": "Get async SQL search results",
"description": "Get the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.",
"operationId": "sql-get-async",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The identifier for the search.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "delimiter",
"description": "The separator for CSV results.\nThe API supports this parameter only for CSV responses.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "format",
"description": "The format for the response.\nYou must specify a format using this parameter or the `Accept` HTTP header.\nIf you specify both, the API uses this parameter.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "keep_alive",
"description": "The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_completion_timeout",
"description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"description": "Identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"is_running": {
"description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.",
"type": "boolean"
},
"is_partial": {
"description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.",
"type": "boolean"
},
"columns": {
"description": "Column headings for the search results. Each object is a column.",
"type": "array",
"items": {
"$ref": "#/components/schemas/sql._types.Column"
}
},
"cursor": {
"description": "The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header.",
"type": "string"
},
"rows": {
"description": "The values for the search results.",
"type": "array",
"items": {
"$ref": "#/components/schemas/sql._types.Row"
}
}
},
"required": [
"id",
"is_running",
"is_partial",
"rows"
]
}
}
}
}
},
"x-state": "Generally available; Added in 7.15.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json\n"
},
{
"lang": "Python",
"source": "resp = client.sql.get_async(\n id=\"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n wait_for_completion_timeout=\"2s\",\n format=\"json\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.sql.getAsync({\n id: \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n wait_for_completion_timeout: \"2s\",\n format: \"json\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.sql.get_async(\n id: \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n wait_for_completion_timeout: \"2s\",\n format: \"json\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->sql()->getAsync([\n \"id\" => \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n \"wait_for_completion_timeout\" => \"2s\",\n \"format\" => \"json\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json\""
},
{
"lang": "Java",
"source": "client.sql().getAsync(g -> g\n .format(\"json\")\n .id(\"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\")\n .waitForCompletionTimeout(w -> w\n .time(\"2s\")\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_sql/async/status/{id}": {
"get": {
"tags": [
"sql"
],
"summary": "Get the async SQL search status",
"description": "Get the current status of an async SQL search or a stored synchronous SQL search.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
"operationId": "sql-get-async-status",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The identifier for the search.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expiration_time_in_millis": {
"description": "The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"id": {
"description": "The identifier for the search.",
"type": "string"
},
"is_running": {
"description": "If `true`, the search is still running.\nIf `false`, the search has finished.",
"type": "boolean"
},
"is_partial": {
"description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.",
"type": "boolean"
},
"start_time_in_millis": {
"description": "The timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API returns this property only for running searches.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"completion_status": {
"description": "The HTTP status code for the search.\nThe API returns this property only for completed searches.",
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
}
},
"required": [
"expiration_time_in_millis",
"id",
"is_running",
"is_partial",
"start_time_in_millis"
]
}
}
}
}
},
"x-state": "Generally available; Added in 7.15.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\n"
},
{
"lang": "Python",
"source": "resp = client.sql.get_async_status(\n id=\"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.sql.getAsyncStatus({\n id: \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.sql.get_async_status(\n id: \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->sql()->getAsyncStatus([\n \"id\" => \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\""
},
{
"lang": "Java",
"source": "client.sql().getAsyncStatus(g -> g\n .id(\"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_sql": {
"get": {
"tags": [
"sql"
],
"summary": "Get SQL search results\n",
"description": "**All methods and paths for this operation:**\n\n\n POST\n /_sql\n
\n \n GET\n /_sql\n
\n \n\nRun an SQL request.\n\n## Required authorization\n\n* Index privileges: `read`\n",
"operationId": "sql-query",
"parameters": [
{
"$ref": "#/components/parameters/sql.query-format"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/sql.query"
},
"responses": {
"200": {
"$ref": "#/components/responses/sql.query-200"
}
},
"x-state": "Generally available; Added in 6.3.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _sql?format=txt\n{\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"\n}"
},
{
"lang": "Python",
"source": "resp = client.sql.query(\n format=\"txt\",\n query=\"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.sql.query({\n format: \"txt\",\n query: \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.sql.query(\n format: \"txt\",\n body: {\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->sql()->query([\n \"format\" => \"txt\",\n \"body\" => [\n \"query\" => \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":\"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"}' \"$ELASTICSEARCH_URL/_sql?format=txt\""
},
{
"lang": "Java",
"source": "client.sql().query(q -> q\n .format(SqlFormat.Txt)\n .params(List.of())\n .query(\"\"\"\n SELECT * FROM library ORDER BY page_count DESC LIMIT 5\n \"\"\")\n .runtimeMappings(Map.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_sql/translate": {
"get": {
"tags": [
"sql"
],
"summary": "Translate SQL into Elasticsearch queries\n",
"description": "**All methods and paths for this operation:**\n\n\n POST\n /_sql/translate\n
\n \n GET\n /_sql/translate\n
\n \n\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.\n\n## Required authorization\n\n* Index privileges: `read`\n",
"operationId": "sql-translate",
"requestBody": {
"$ref": "#/components/requestBodies/sql.translate"
},
"responses": {
"200": {
"$ref": "#/components/responses/sql.translate-200"
}
},
"x-state": "Generally available; Added in 6.3.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _sql/translate\n{\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC\",\n \"fetch_size\": 10\n}"
},
{
"lang": "Python",
"source": "resp = client.sql.translate(\n query=\"SELECT * FROM library ORDER BY page_count DESC\",\n fetch_size=10,\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.sql.translate({\n query: \"SELECT * FROM library ORDER BY page_count DESC\",\n fetch_size: 10,\n});"
},
{
"lang": "Ruby",
"source": "response = client.sql.translate(\n body: {\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC\",\n \"fetch_size\": 10\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->sql()->translate([\n \"body\" => [\n \"query\" => \"SELECT * FROM library ORDER BY page_count DESC\",\n \"fetch_size\" => 10,\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":\"SELECT * FROM library ORDER BY page_count DESC\",\"fetch_size\":10}' \"$ELASTICSEARCH_URL/_sql/translate\""
},
{
"lang": "Java",
"source": "client.sql().translate(t -> t\n .fetchSize(10)\n .query(\"\"\"\n SELECT * FROM library ORDER BY page_count DESC\n \"\"\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_ssl/certificates": {
"get": {
"tags": [
"security"
],
"summary": "Get SSL certificates",
"description": "Get information about the X.509 certificates that are used to encrypt communications in the cluster.\nThe API returns a list that includes certificates from all TLS contexts including:\n\n- Settings for transport and HTTP interfaces\n- TLS settings that are used within authentication realms\n- TLS settings for remote monitoring exporters\n\nThe list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.\nIt also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.\n\nThe list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.\n\nNOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.\n\nIf Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
"externalDocs": {
"description": "About setting up transport tls",
"url": "https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security#encrypt-internode-communication",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-ssl.html"
},
"operationId": "ssl-certificates",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ssl.certificates.CertificateInformation"
}
},
"examples": {
"GetCertificatesResponseExample1": {
"description": "A successful response from `GET /_ssl/certificates`, which provides information about the certificates on a single node of Elasticsearch.\n",
"value": "[\n {\n \"path\": \"certs/elastic-certificates.p12\",\n \"format\": \"PKCS12\",\n \"alias\": \"instance\",\n \"subject_dn\": \"CN=Elastic Certificate Tool Autogenerated CA\",\n \"serial_number\": \"a20f0ee901e8f69dc633ff633e5cd5437cdb4137\",\n \"has_private_key\": false,\n \"expiry\": \"2021-01-15T20:42:49.000Z\"\n },\n {\n \"path\": \"certs/elastic-certificates.p12\",\n \"format\": \"PKCS12\",\n \"alias\": \"ca\",\n \"subject_dn\": \"CN=Elastic Certificate Tool Autogenerated CA\",\n \"serial_number\": \"a20f0ee901e8f69dc633ff633e5cd5437cdb4137\",\n \"has_private_key\": false,\n \"expiry\": \"2021-01-15T20:42:49.000Z\"\n },\n {\n \"path\": \"certs/elastic-certificates.p12\",\n \"format\": \"PKCS12\",\n \"alias\": \"instance\",\n \"subject_dn\": \"CN=instance\",\n \"serial_number\": \"fc1905e1494dc5230218d079c47a617088f84ce0\",\n \"has_private_key\": true,\n \"expiry\": \"2021-01-15T20:44:32.000Z\"\n }\n]"
}
}
}
}
}
},
"x-state": "Generally available; Added in 6.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_ssl/certificates\n"
},
{
"lang": "Python",
"source": "resp = client.ssl.certificates()"
},
{
"lang": "JavaScript",
"source": "const response = await client.ssl.certificates();"
},
{
"lang": "Ruby",
"source": "response = client.ssl.certificates"
},
{
"lang": "PHP",
"source": "$resp = $client->ssl()->certificates();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ssl/certificates\""
},
{
"lang": "Java",
"source": "client.ssl().certificates();\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_streams/{name}/_disable": {
"post": {
"tags": [
"streams"
],
"summary": "Disable a named stream",
"description": "Turn off the named stream feature for this cluster.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"operationId": "streams-logs-disable",
"parameters": [
{
"in": "path",
"name": "name",
"description": "The stream type to disable.\n\nSupported values include:\n - `logs`: The logs stream type.\n - `logs.otel`: The logs.otel stream type, meant for OTel-formatted data.\n - `logs.ecs`: The logs.ecs stream type, meant for ECS-formatted data.\n\n",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/streams._types.StreamType"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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": "timeout",
"description": "The period to wait for a response.\nIf 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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"PostStreamsLogsDisableResponseExample1": {
"summary": "Disable logs.otel streams",
"description": "A successful response from `POST _streams/logs.otel/_disable` endpoint\n",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Experimental; Added in 9.1.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _streams/logs.otel/_disable\n"
},
{
"lang": "Python",
"source": "resp = client.streams.logs_disable(\n name=\"logs.otel\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.streams.logsDisable({\n name: \"logs.otel\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.streams.logs_disable(\n name: \"logs.otel\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->streams()->logsDisable([\n \"name\" => \"logs.otel\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_streams/logs.otel/_disable\""
},
{
"lang": "Java",
"source": "client.streams().logsDisable(l -> l);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_streams/{name}/_enable": {
"post": {
"tags": [
"streams"
],
"summary": "Enable a named stream",
"description": "Turn on the named stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the cluster does not have\nexisting indices or data streams that match the pattern `|.*` for the enabled stream\ntype name. If those indices or data streams exist, a `409 - Conflict` response and error is\nreturned.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"operationId": "streams-logs-enable",
"parameters": [
{
"in": "path",
"name": "name",
"description": "The stream type to enable.\n\nSupported values include:\n - `logs`: The logs stream type.\n - `logs.otel`: The logs.otel stream type, meant for OTel-formatted data.\n - `logs.ecs`: The logs.ecs stream type, meant for ECS-formatted data.\n\n",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/streams._types.StreamType"
},
"style": "simple"
},
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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": "timeout",
"description": "The period to wait for a response.\nIf 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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"PostStreamsEnableResponseExample1": {
"summary": "Enable logs streams",
"description": "A successful response from `POST _streams/logs.otel/_enable` endpoint\n",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Experimental; Added in 9.1.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _streams/logs.otel/_enable\n"
},
{
"lang": "Python",
"source": "resp = client.streams.logs_enable(\n name=\"logs.otel\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.streams.logsEnable({\n name: \"logs.otel\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.streams.logs_enable(\n name: \"logs.otel\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->streams()->logsEnable([\n \"name\" => \"logs.otel\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_streams/logs.otel/_enable\""
},
{
"lang": "Java",
"source": "client.streams().logsEnable(l -> l);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_streams/status": {
"get": {
"tags": [
"streams"
],
"summary": "Get the status of streams",
"description": "Get the current status for all types of streams.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
"operationId": "streams-status",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. 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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"logs": {
"allOf": [
{
"$ref": "#/components/schemas/streams.status.StreamStatus"
}
]
},
"logs.otel": {
"allOf": [
{
"$ref": "#/components/schemas/streams.status.StreamStatus"
}
]
},
"logs.ecs": {
"allOf": [
{
"$ref": "#/components/schemas/streams.status.StreamStatus"
}
]
}
},
"required": [
"logs",
"logs.otel",
"logs.ecs"
]
},
"examples": {
"GetStreamsStatusResponseExample1": {
"summary": "Get Streams Status A successful response from `GET _streams/status` that outlines the current state of all wired streams in the cluster.",
"value": "{\n \"logs\": {\n \"enabled\": false\n }\n \"logs.ecs\": {\n \"enabled\": true\n }\n \"logs.otel\": {\n \"enabled\": true\n }\n}"
}
}
}
}
}
},
"x-state": "Experimental; Added in 9.1.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _streams/status\n"
},
{
"lang": "Python",
"source": "resp = client.streams.status()"
},
{
"lang": "JavaScript",
"source": "const response = await client.streams.status();"
},
{
"lang": "Ruby",
"source": "response = client.streams.status"
},
{
"lang": "PHP",
"source": "$resp = $client->streams()->status();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_streams/status\""
},
{
"lang": "Java",
"source": "client.streams().status(s -> s);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_synonyms/{id}": {
"get": {
"tags": [
"synonyms"
],
"summary": "Get a synonym set",
"description": "\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
"operationId": "synonyms-get-synonym",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The synonyms set identifier to retrieve.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "from",
"description": "The starting offset for synonym rules to retrieve.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "size",
"description": "The max number of synonym rules to retrieve.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "search_after",
"description": "The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.",
"deprecated": false,
"schema": {
"type": "string"
},
"x-state": "Generally available; Added in 9.5.0",
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"description": "The total number of synonyms rules that the synonyms set contains.",
"type": "number"
},
"synonyms_set": {
"description": "Synonym rule details.",
"type": "array",
"items": {
"$ref": "#/components/schemas/synonyms._types.SynonymRuleRead"
}
}
},
"required": [
"count",
"synonyms_set"
]
},
"examples": {
"SynonymsGetResponseExample1": {
"description": "A successful response from `GET _synonyms/my-synonyms-set`.",
"value": "{\n \"count\": 3,\n \"synonyms_set\": [\n {\n \"id\": \"test-1\",\n \"synonyms\": \"hello, hi\"\n },\n {\n \"id\": \"test-2\",\n \"synonyms\": \"bye, goodbye\"\n },\n {\n \"id\": \"test-3\",\n \"synonyms\": \"test => check\"\n }\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _synonyms/my-synonyms-set\n"
},
{
"lang": "Python",
"source": "resp = client.synonyms.get_synonym(\n id=\"my-synonyms-set\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.synonyms.getSynonym({\n id: \"my-synonyms-set\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.synonyms.get_synonym(\n id: \"my-synonyms-set\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->synonyms()->getSynonym([\n \"id\" => \"my-synonyms-set\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set\""
},
{
"lang": "Java",
"source": "client.synonyms().getSynonym(g -> g\n .id(\"my-synonyms-set\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"put": {
"tags": [
"synonyms"
],
"summary": "Create or update a synonym set",
"description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
"externalDocs": {
"description": "About synonym API examples",
"url": "https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-synonyms-set.html"
},
"operationId": "synonyms-put-synonym",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the synonyms set to be created or updated.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "refresh",
"description": "If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 9.1.0",
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"synonyms_set": {
"description": "The synonym rules definitions for the synonyms set.",
"oneOf": [
{
"$ref": "#/components/schemas/synonyms._types.SynonymRule"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/synonyms._types.SynonymRule"
}
}
]
}
},
"required": [
"synonyms_set"
]
},
"examples": {
"SynonymsPutRequestExample1": {
"description": "",
"value": "\n{\n \"synonyms_set\": {\n \"synonyms\" : \"hello, hi, howdy\"\n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"description": "The update operation result.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Result"
}
]
},
"reload_analyzers_details": {
"description": "Updating a synonyms set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result.",
"allOf": [
{
"$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult"
}
]
}
},
"required": [
"result"
]
}
}
}
}
},
"x-state": "Generally available; Added in 8.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT _synonyms/my-synonyms-set\n\n{\n \"synonyms_set\": {\n \"synonyms\" : \"hello, hi, howdy\"\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.synonyms.put_synonym(\n id=\"my-synonyms-set\",\n synonyms_set={\n \"synonyms\": \"hello, hi, howdy\"\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.synonyms.putSynonym({\n id: \"my-synonyms-set\",\n synonyms_set: {\n synonyms: \"hello, hi, howdy\",\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.synonyms.put_synonym(\n id: \"my-synonyms-set\",\n body: {\n \"synonyms_set\": {\n \"synonyms\": \"hello, hi, howdy\"\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->synonyms()->putSynonym([\n \"id\" => \"my-synonyms-set\",\n \"body\" => [\n \"synonyms_set\" => [\n \"synonyms\" => \"hello, hi, howdy\",\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"synonyms_set\":{\"synonyms\":\"hello, hi, howdy\"}}' \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set\""
},
{
"lang": "Java",
"source": "client.synonyms().putSynonym(p -> p\n .id(\"my-synonyms-set\")\n .synonymsSet(s -> s\n .synonyms(\"hello, hi, howdy\")\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"synonyms"
],
"summary": "Delete a synonym set",
"description": "You can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
"operationId": "synonyms-delete-synonym",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The synonyms set identifier to delete.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available; Added in 8.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE _synonyms/my-synonyms-set\n"
},
{
"lang": "Python",
"source": "resp = client.synonyms.delete_synonym(\n id=\"my-synonyms-set\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.synonyms.deleteSynonym({\n id: \"my-synonyms-set\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.synonyms.delete_synonym(\n id: \"my-synonyms-set\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->synonyms()->deleteSynonym([\n \"id\" => \"my-synonyms-set\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set\""
},
{
"lang": "Java",
"source": "client.synonyms().deleteSynonym(d -> d\n .id(\"my-synonyms-set\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_synonyms/{set_id}/{rule_id}": {
"get": {
"tags": [
"synonyms"
],
"summary": "Get a synonym rule",
"description": "Get a synonym rule from a synonym set.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
"operationId": "synonyms-get-synonym-rule",
"parameters": [
{
"in": "path",
"name": "set_id",
"description": "The ID of the synonym set to retrieve the synonym rule from.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "path",
"name": "rule_id",
"description": "The ID of the synonym rule to retrieve.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/synonyms._types.SynonymRuleRead"
},
"examples": {
"SynonymRuleGetResponseExample1": {
"description": "A successful response from `GET _synonyms/my-synonyms-set/test-1`.",
"value": "{\n \"id\": \"test-1\",\n \"synonyms\": \"hello, hi\"\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _synonyms/my-synonyms-set/test-1\n"
},
{
"lang": "Python",
"source": "resp = client.synonyms.get_synonym_rule(\n set_id=\"my-synonyms-set\",\n rule_id=\"test-1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.synonyms.getSynonymRule({\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.synonyms.get_synonym_rule(\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->synonyms()->getSynonymRule([\n \"set_id\" => \"my-synonyms-set\",\n \"rule_id\" => \"test-1\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1\""
},
{
"lang": "Java",
"source": "client.synonyms().getSynonymRule(g -> g\n .ruleId(\"test-1\")\n .setId(\"my-synonyms-set\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"put": {
"tags": [
"synonyms"
],
"summary": "Create or update a synonym rule",
"description": "Create or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
"operationId": "synonyms-put-synonym-rule",
"parameters": [
{
"in": "path",
"name": "set_id",
"description": "The ID of the synonym set.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "path",
"name": "rule_id",
"description": "The ID of the synonym rule to be updated or created.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "refresh",
"description": "If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 9.1.0",
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"synonyms": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms"
},
"description": "The synonym rule information definition, which must be in Solr format.",
"allOf": [
{
"$ref": "#/components/schemas/synonyms._types.SynonymString"
}
]
}
},
"required": [
"synonyms"
]
},
"examples": {
"SynonymRulePutRequestExample1": {
"summary": "synonyms/apis/put-synonym-rule.asciidoc:107",
"description": "",
"value": "{\n \"synonyms\": \"hello, hi, howdy\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/synonyms._types.SynonymsUpdateResult"
},
"examples": {
"SynonymRuleResponseExample1": {
"description": "A successful response from `PUT _synonyms/my-synonyms-set/test-1`.\n",
"value": "{\n \"result\": \"updated\",\n \"reload_analyzers_details\": {\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"reload_details\": [\n {\n \"index\": \"test-index\",\n \"reloaded_analyzers\": [\n \"my_search_analyzer\"\n ],\n \"reloaded_node_ids\": [\n \"1wYFZzq8Sxeu_Jvt9mlbkg\"\n ]\n }\n ]\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT _synonyms/my-synonyms-set/test-1\n{\n \"synonyms\": \"hello, hi, howdy\"\n}"
},
{
"lang": "Python",
"source": "resp = client.synonyms.put_synonym_rule(\n set_id=\"my-synonyms-set\",\n rule_id=\"test-1\",\n synonyms=\"hello, hi, howdy\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.synonyms.putSynonymRule({\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\",\n synonyms: \"hello, hi, howdy\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.synonyms.put_synonym_rule(\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\",\n body: {\n \"synonyms\": \"hello, hi, howdy\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->synonyms()->putSynonymRule([\n \"set_id\" => \"my-synonyms-set\",\n \"rule_id\" => \"test-1\",\n \"body\" => [\n \"synonyms\" => \"hello, hi, howdy\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"synonyms\":\"hello, hi, howdy\"}' \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1\""
},
{
"lang": "Java",
"source": "client.synonyms().putSynonymRule(p -> p\n .ruleId(\"test-1\")\n .setId(\"my-synonyms-set\")\n .synonyms(\"hello, hi, howdy\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"synonyms"
],
"summary": "Delete a synonym rule",
"description": "Delete a synonym rule from a synonym set.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
"operationId": "synonyms-delete-synonym-rule",
"parameters": [
{
"in": "path",
"name": "set_id",
"description": "The ID of the synonym set to update.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "path",
"name": "rule_id",
"description": "The ID of the synonym rule to delete.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "refresh",
"description": "If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the deleted synonym rule",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 9.1.0",
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/synonyms._types.SynonymsUpdateResult"
},
"examples": {
"SynonymRuleDeleteResponseExample1": {
"description": "A successful response from `DELETE _synonyms/my-synonyms-set/test-1`. All analyzers using this synonyms set will be reloaded automatically to reflect the rule being deleted.\n",
"value": "{\n \"result\": \"deleted\",\n \"reload_analyzers_details\": {\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"reload_details\": [\n {\n \"index\": \"test-index\",\n \"reloaded_analyzers\": [\n \"my_search_analyzer\"\n ],\n \"reloaded_node_ids\": [\n \"1wYFZzq8Sxeu_Jvt9mlbkg\"\n ]\n }\n ]\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE _synonyms/my-synonyms-set/test-1\n"
},
{
"lang": "Python",
"source": "resp = client.synonyms.delete_synonym_rule(\n set_id=\"my-synonyms-set\",\n rule_id=\"test-1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.synonyms.deleteSynonymRule({\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.synonyms.delete_synonym_rule(\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->synonyms()->deleteSynonymRule([\n \"set_id\" => \"my-synonyms-set\",\n \"rule_id\" => \"test-1\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1\""
},
{
"lang": "Java",
"source": "client.synonyms().deleteSynonymRule(d -> d\n .ruleId(\"test-1\")\n .setId(\"my-synonyms-set\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_synonyms": {
"get": {
"tags": [
"synonyms"
],
"summary": "Get all synonym sets",
"description": "Get a summary of all defined synonym sets.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
"operationId": "synonyms-get-synonyms-sets",
"parameters": [
{
"in": "query",
"name": "from",
"description": "The starting offset for synonyms sets to retrieve.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "size",
"description": "The maximum number of synonyms sets to retrieve.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"description": "The total number of synonyms sets defined.",
"type": "number"
},
"results": {
"description": "The identifier and total number of defined synonym rules for each synonyms set.",
"type": "array",
"items": {
"$ref": "#/components/schemas/synonyms.get_synonyms_sets.SynonymsSetItem"
}
}
},
"required": [
"count",
"results"
]
},
"examples": {
"SynonymsSetsGetResponseExample1": {
"description": "A successful response from `GET _synonyms`.",
"value": "{\n \"count\": 3,\n \"results\": [\n {\n \"synonyms_set\": \"ecommerce-synonyms\",\n \"count\": 2\n },\n {\n \"synonyms_set\": \"my-synonyms-set\",\n \"count\": 3\n },\n {\n \"synonyms_set\": \"new-ecommerce-synonyms\",\n \"count\": 1\n }\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.10.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _synonyms\n"
},
{
"lang": "Python",
"source": "resp = client.synonyms.get_synonyms_sets()"
},
{
"lang": "JavaScript",
"source": "const response = await client.synonyms.getSynonymsSets();"
},
{
"lang": "Ruby",
"source": "response = client.synonyms.get_synonyms_sets"
},
{
"lang": "PHP",
"source": "$resp = $client->synonyms()->getSynonymsSets();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms\""
},
{
"lang": "Java",
"source": "client.synonyms().getSynonymsSets(g -> g);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_tasks/{task_id}/_cancel": {
"post": {
"tags": [
"tasks"
],
"summary": "Cancel a task\n",
"description": "**All methods and paths for this operation:**\n\n\n POST\n /_tasks/_cancel\n
\n \n POST\n /_tasks/{task_id}/_cancel\n
\n \n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
"operationId": "tasks-cancel",
"parameters": [
{
"$ref": "#/components/parameters/tasks.cancel-task_id"
},
{
"$ref": "#/components/parameters/tasks.cancel-actions"
},
{
"$ref": "#/components/parameters/tasks.cancel-nodes"
},
{
"$ref": "#/components/parameters/tasks.cancel-parent_task_id"
},
{
"$ref": "#/components/parameters/tasks.cancel-wait_for_completion"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/tasks.cancel-200"
}
},
"x-state": "Experimental; Added in 2.3.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _tasks//_cancel\n"
},
{
"lang": "Python",
"source": "resp = client.tasks.cancel(\n task_id=\"\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.tasks.cancel({\n task_id: \"\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.tasks.cancel(\n task_id: \"\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->tasks()->cancel([\n \"task_id\" => \"\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_tasks//_cancel\""
},
{
"lang": "Java",
"source": "client.tasks().cancel(c -> c\n .actions(List.of())\n .nodes(List.of())\n .taskId(\"\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_tasks/{task_id}": {
"get": {
"tags": [
"tasks"
],
"summary": "Get task information",
"description": "Get information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
"operationId": "tasks-get",
"parameters": [
{
"in": "path",
"name": "task_id",
"description": "The task identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for a response.\nIf 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": "object",
"properties": {
"completed": {
"type": "boolean"
},
"task": {
"allOf": [
{
"$ref": "#/components/schemas/tasks._types.TaskInfo"
}
]
},
"response": {
"type": "object"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"completed",
"task"
]
},
"examples": {
"GetTaskResponseExample1": {
"summary": "Get cluster actions",
"description": "A successful response from `GET _tasks?actions=cluster:*`, which retrieves all cluster-related tasks.\n",
"value": "{\n \"nodes\" : {\n \"oTUltX4IQMOUUVeiohTt8A\" : {\n \"name\" : \"H5dfFeA\",\n \"transport_address\" : \"127.0.0.1:9300\",\n \"host\" : \"127.0.0.1\",\n \"ip\" : \"127.0.0.1:9300\",\n \"tasks\" : {\n \"oTUltX4IQMOUUVeiohTt8A:124\" : {\n \"node\" : \"oTUltX4IQMOUUVeiohTt8A\",\n \"id\" : 124,\n \"type\" : \"direct\",\n \"action\" : \"cluster:monitor/tasks/lists[n]\",\n \"start_time_in_millis\" : 1458585884904,\n \"running_time_in_nanos\" : 47402,\n \"cancellable\" : false,\n \"parent_task_id\" : \"oTUltX4IQMOUUVeiohTt8A:123\"\n },\n \"oTUltX4IQMOUUVeiohTt8A:123\" : {\n \"node\" : \"oTUltX4IQMOUUVeiohTt8A\",\n \"id\" : 123,\n \"type\" : \"transport\",\n \"action\" : \"cluster:monitor/tasks/lists\",\n \"start_time_in_millis\" : 1458585884904,\n \"running_time_in_nanos\" : 236042,\n \"cancellable\" : false\n }\n }\n }\n }\n}"
},
"GetTaskResponseExample2": {
"summary": "Get details about a delete by query",
"description": "A successful response from `GET _tasks?detailed=true&actions=*/delete/byquery`, which gets the status of a delete by query operation. The `status` object contains the actual status. `total` is the total number of operations that the reindex expects to perform. You can estimate the progress by adding the `updated`, `created`, and `deleted` fields. The request will finish when their sum is equal to the `total` field.\n",
"value": "{\n \"nodes\" : {\n \"r1A2WoRbTwKZ516z6NEs5A\" : {\n \"name\" : \"r1A2WoR\",\n \"transport_address\" : \"127.0.0.1:9300\",\n \"host\" : \"127.0.0.1\",\n \"ip\" : \"127.0.0.1:9300\",\n \"attributes\" : {\n \"testattr\" : \"test\",\n \"portsfile\" : \"true\"\n },\n \"tasks\" : {\n \"r1A2WoRbTwKZ516z6NEs5A:36619\" : {\n \"node\" : \"r1A2WoRbTwKZ516z6NEs5A\",\n \"id\" : 36619,\n \"type\" : \"transport\",\n \"action\" : \"indices:data/write/delete/byquery\",\n \"status\" : { \n \"total\" : 6154,\n \"updated\" : 0,\n \"created\" : 0,\n \"deleted\" : 3500,\n \"batches\" : 36,\n \"version_conflicts\" : 0,\n \"noops\" : 0,\n \"retries\": 0,\n \"throttled_millis\": 0\n },\n \"description\" : \"\"\n }\n }\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Experimental; Added in 5.0.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _tasks?detailed=true&actions=*/delete/byquery\n"
},
{
"lang": "Python",
"source": "resp = client.tasks.list(\n detailed=True,\n actions=\"*/delete/byquery\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.tasks.list({\n detailed: \"true\",\n actions: \"*/delete/byquery\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.tasks.list(\n detailed: \"true\",\n actions: \"*/delete/byquery\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->tasks()->list([\n \"detailed\" => \"true\",\n \"actions\" => \"*/delete/byquery\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_tasks?detailed=true&actions=*/delete/byquery\""
},
{
"lang": "Java",
"source": "client.tasks().list(l -> l\n .actions(\"*/delete/byquery\")\n .detailed(true)\n .nodes(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_tasks": {
"get": {
"tags": [
"tasks"
],
"summary": "Get all tasks",
"description": "Get information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n \"tasks\" : {\n \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 45,\n \"type\" : \"transport\",\n \"action\" : \"cluster:monitor/tasks/lists\",\n \"start_time_in_millis\" : 1513823752749,\n \"running_time_in_nanos\" : 293139,\n \"cancellable\" : false,\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n },\n \"children\" : [\n {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 46,\n \"type\" : \"direct\",\n \"action\" : \"cluster:monitor/tasks/lists[n]\",\n \"start_time_in_millis\" : 1513823752750,\n \"running_time_in_nanos\" : 92133,\n \"cancellable\" : false,\n \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n }\n }\n ]\n }\n }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
"operationId": "tasks-list",
"parameters": [
{
"in": "query",
"name": "actions",
"description": "A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
{
"in": "query",
"name": "detailed",
"description": "If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "group_by",
"description": "A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.\n\nSupported values include:\n - `nodes`: Group tasks by node ID.\n - `parents`: Group tasks by parent task ID.\n - `none`: Do not group tasks.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/tasks._types.GroupBy"
},
"style": "form"
},
{
"in": "query",
"name": "nodes",
"description": "A comma-separated list of node IDs or names that is used to limit the returned information.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeIds"
},
"style": "form"
},
{
"in": "query",
"name": "parent_task_id",
"description": "A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_completion",
"description": "If `true`, the request blocks until the operation is complete.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasks._types.TaskListResponseBase"
},
"examples": {
"ListTasksResponseExample1": {
"description": "A successful response from `GET _tasks?actions=*search&detailed` The `detailed` parameter affects the `description` field, which contains human readable text that identifies the particular request that the task is performing. For example, it helps identify the search request being performed by a search task.\n",
"value": "{\n \"nodes\" : {\n \"oTUltX4IQMOUUVeiohTt8A\" : {\n \"name\" : \"H5dfFeA\",\n \"transport_address\" : \"127.0.0.1:9300\",\n \"host\" : \"127.0.0.1\",\n \"ip\" : \"127.0.0.1:9300\",\n \"tasks\" : {\n \"oTUltX4IQMOUUVeiohTt8A:464\" : {\n \"node\" : \"oTUltX4IQMOUUVeiohTt8A\",\n \"id\" : 464,\n \"type\" : \"transport\",\n \"action\" : \"indices:data/read/search\",\n \"description\" : \"indices[test], types[test], search_type[QUERY_THEN_FETCH], source[{\\\"query\\\":...}]\",\n \"start_time_in_millis\" : 1483478610008,\n \"running_time_in_nanos\" : 13991383,\n \"cancellable\" : true,\n \"cancelled\" : false\n }\n }\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Experimental; Added in 2.3.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _tasks?actions=*search&detailed\n"
},
{
"lang": "Python",
"source": "resp = client.tasks.list(\n actions=\"*search\",\n detailed=True,\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.tasks.list({\n actions: \"*search\",\n detailed: \"true\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.tasks.list(\n actions: \"*search\",\n detailed: \"true\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->tasks()->list([\n \"actions\" => \"*search\",\n \"detailed\" => \"true\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_tasks?actions=*search&detailed\""
},
{
"lang": "Java",
"source": "client.tasks().list(l -> l\n .actions(\"*search\")\n .detailed(true)\n .nodes(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/{index}/_terms_enum": {
"post": {
"tags": [
"search"
],
"summary": "Get terms in an index\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /{index}/_terms_enum\n
\n \n POST\n /{index}/_terms_enum\n
\n \n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.",
"operationId": "terms-enum",
"parameters": [
{
"$ref": "#/components/parameters/terms_enum-index"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/terms_enum"
},
"responses": {
"200": {
"$ref": "#/components/responses/terms_enum-200"
}
},
"x-state": "Generally available; Added in 7.14.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST stackoverflow/_terms_enum\n{\n \"field\" : \"tags\",\n \"string\" : \"kiba\"\n}"
},
{
"lang": "Python",
"source": "resp = client.terms_enum(\n index=\"stackoverflow\",\n field=\"tags\",\n string=\"kiba\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.termsEnum({\n index: \"stackoverflow\",\n field: \"tags\",\n string: \"kiba\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.terms_enum(\n index: \"stackoverflow\",\n body: {\n \"field\": \"tags\",\n \"string\": \"kiba\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->termsEnum([\n \"index\" => \"stackoverflow\",\n \"body\" => [\n \"field\" => \"tags\",\n \"string\" => \"kiba\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"field\":\"tags\",\"string\":\"kiba\"}' \"$ELASTICSEARCH_URL/stackoverflow/_terms_enum\""
},
{
"lang": "Java",
"source": "client.termsEnum(t -> t\n .field(\"tags\")\n .index(\"stackoverflow\")\n .string(\"kiba\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/{index}/_termvectors/{id}": {
"post": {
"tags": [
"document"
],
"summary": "Get term vector information\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /{index}/_termvectors\n
\n \n POST\n /{index}/_termvectors\n
\n \n GET\n /{index}/_termvectors/{id}\n
\n \n POST\n /{index}/_termvectors/{id}\n
\n \n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.\nRefer to the linked documentation for detailed examples of how to use this API.\n\n## Required authorization\n\n* Index privileges: `read`\n",
"externalDocs": {
"description": "About term vectors API examples",
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/term-vectors-examples",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-termvectors.html"
},
"operationId": "termvectors",
"parameters": [
{
"$ref": "#/components/parameters/termvectors-index"
},
{
"$ref": "#/components/parameters/termvectors-id"
},
{
"$ref": "#/components/parameters/termvectors-fields"
},
{
"$ref": "#/components/parameters/termvectors-field_statistics"
},
{
"$ref": "#/components/parameters/termvectors-offsets"
},
{
"$ref": "#/components/parameters/termvectors-payloads"
},
{
"$ref": "#/components/parameters/termvectors-positions"
},
{
"$ref": "#/components/parameters/termvectors-preference"
},
{
"$ref": "#/components/parameters/termvectors-realtime"
},
{
"$ref": "#/components/parameters/termvectors-routing"
},
{
"$ref": "#/components/parameters/termvectors-term_statistics"
},
{
"$ref": "#/components/parameters/termvectors-version"
},
{
"$ref": "#/components/parameters/termvectors-version_type"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/termvectors"
},
"responses": {
"200": {
"$ref": "#/components/responses/termvectors-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /my-index-000001/_termvectors/1\n{\n \"fields\" : [\"text\"],\n \"offsets\" : true,\n \"payloads\" : true,\n \"positions\" : true,\n \"term_statistics\" : true,\n \"field_statistics\" : true\n}"
},
{
"lang": "Python",
"source": "resp = client.termvectors(\n index=\"my-index-000001\",\n id=\"1\",\n fields=[\n \"text\"\n ],\n offsets=True,\n payloads=True,\n positions=True,\n term_statistics=True,\n field_statistics=True,\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.termvectors({\n index: \"my-index-000001\",\n id: 1,\n fields: [\"text\"],\n offsets: true,\n payloads: true,\n positions: true,\n term_statistics: true,\n field_statistics: true,\n});"
},
{
"lang": "Ruby",
"source": "response = client.termvectors(\n index: \"my-index-000001\",\n id: \"1\",\n body: {\n \"fields\": [\n \"text\"\n ],\n \"offsets\": true,\n \"payloads\": true,\n \"positions\": true,\n \"term_statistics\": true,\n \"field_statistics\": true\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->termvectors([\n \"index\" => \"my-index-000001\",\n \"id\" => \"1\",\n \"body\" => [\n \"fields\" => array(\n \"text\",\n ),\n \"offsets\" => true,\n \"payloads\" => true,\n \"positions\" => true,\n \"term_statistics\" => true,\n \"field_statistics\" => true,\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"fields\":[\"text\"],\"offsets\":true,\"payloads\":true,\"positions\":true,\"term_statistics\":true,\"field_statistics\":true}' \"$ELASTICSEARCH_URL/my-index-000001/_termvectors/1\""
},
{
"lang": "Java",
"source": "client.termvectors(t -> t\n .fieldStatistics(true)\n .fields(\"text\")\n .id(\"1\")\n .index(\"my-index-000001\")\n .offsets(true)\n .payloads(true)\n .perFieldAnalyzer(Map.of())\n .positions(true)\n .routing(List.of())\n .termStatistics(true)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_text_structure/find_field_structure": {
"get": {
"tags": [
"text_structure"
],
"summary": "Find the structure of a text field",
"description": "Find the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.\n\n## Required authorization\n\n* Cluster privileges: `monitor_text_structure`\n",
"operationId": "text-structure-find-field-structure",
"parameters": [
{
"in": "query",
"name": "column_names",
"description": "If `format` is set to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header row, columns are named \"column1\", \"column2\", \"column3\", for example.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
{
"in": "query",
"name": "delimiter",
"description": "If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "documents_to_sample",
"description": "The number of documents to include in the structural analysis.\nThe minimum value is 2.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.uint"
},
"style": "form"
},
{
"in": "query",
"name": "ecs_compatibility",
"description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.\nThe intention in that situation is that a user who knows the meanings will rename the fields before using them.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/text_structure._types.EcsCompatibilityType"
},
"style": "form"
},
{
"in": "query",
"name": "explain",
"description": "If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "field",
"description": "The field that should be analyzed.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
{
"in": "query",
"name": "format",
"description": "The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/text_structure._types.FormatType"
},
"style": "form"
},
{
"in": "query",
"name": "grok_pattern",
"description": "If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.GrokPattern"
},
"style": "form"
},
{
"in": "query",
"name": "index",
"description": "The name of the index that contains the analyzed field.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "form"
},
{
"in": "query",
"name": "quote",
"description": "If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "should_trim_fields",
"description": "If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "should_parse_recursively",
"description": "If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timestamp_field",
"description": "The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
{
"in": "query",
"name": "timestamp_format",
"description": "The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"charset": {
"type": "string"
},
"ecs_compatibility": {
"allOf": [
{
"$ref": "#/components/schemas/text_structure._types.EcsCompatibilityType"
}
]
},
"field_stats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/text_structure._types.FieldStat"
}
},
"format": {
"allOf": [
{
"$ref": "#/components/schemas/text_structure._types.FormatType"
}
]
},
"grok_pattern": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GrokPattern"
}
]
},
"java_timestamp_formats": {
"type": "array",
"items": {
"type": "string"
}
},
"joda_timestamp_formats": {
"type": "array",
"items": {
"type": "string"
}
},
"ingest_pipeline": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.PipelineConfig"
}
]
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"multiline_start_pattern": {
"type": "string"
},
"need_client_timezone": {
"type": "boolean"
},
"num_lines_analyzed": {
"type": "number"
},
"num_messages_analyzed": {
"type": "number"
},
"sample_start": {
"type": "string"
},
"timestamp_field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"charset",
"field_stats",
"format",
"ingest_pipeline",
"mappings",
"need_client_timezone",
"num_lines_analyzed",
"num_messages_analyzed",
"sample_start"
]
},
"examples": {
"FindFieldStructureResponseExample1": {
"description": "A successful response from `GET _text_structure/find_field_structure?index=test-logs&field=message`.",
"value": "{\n \"num_lines_analyzed\" : 22,\n \"num_messages_analyzed\" : 22,\n \"sample_start\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\\n[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\\n\",\n \"charset\" : \"UTF-8\",\n \"format\" : \"semi_structured_text\",\n \"multiline_start_pattern\" : \"^\\\\[\\\\b\\\\d{4}-\\\\d{2}-\\\\d{2}[T ]\\\\d{2}:\\\\d{2}\",\n \"grok_pattern\" : \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"timestamp\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"loglevel\" : {\n \"type\" : \"keyword\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"grok\" : {\n \"field\" : \"message\",\n \"patterns\" : [\n \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\"\n ],\n \"ecs_compatibility\" : \"disabled\"\n }\n },\n {\n \"date\" : {\n \"field\" : \"timestamp\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n },\n {\n \"remove\" : {\n \"field\" : \"timestamp\"\n }\n }\n ]\n },\n \"field_stats\" : {\n \"loglevel\" : {\n \"count\" : 22,\n \"cardinality\" : 1,\n \"top_hits\" : [\n {\n \"value\" : \"INFO\",\n \"count\" : 22\n }\n ]\n },\n \"message\" : {\n \"count\" : 22,\n \"cardinality\" : 22,\n \"top_hits\" : [\n {\n \"value\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"count\" : 1\n }\n ]\n },\n \"timestamp\" : {\n \"count\" : 22,\n \"cardinality\" : 14,\n \"earliest\" : \"2024-03-05T10:52:36,256\",\n \"latest\" : \"2024-03-05T10:52:49,199\",\n \"top_hits\" : [\n {\n \"value\" : \"2024-03-05T10:52:41,044\",\n \"count\" : 6\n },\n {\n \"value\" : \"2024-03-05T10:52:41,043\",\n \"count\" : 3\n },\n {\n \"value\" : \"2024-03-05T10:52:41,059\",\n \"count\" : 2\n },\n {\n \"value\" : \"2024-03-05T10:52:36,256\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,038\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,042\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:43,291\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:46,098\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,227\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,259\",\n \"count\" : 1\n }\n ]\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _text_structure/find_field_structure?index=test-logs&field=message\n"
},
{
"lang": "Python",
"source": "resp = client.text_structure.find_field_structure(\n index=\"test-logs\",\n field=\"message\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.textStructure.findFieldStructure({\n index: \"test-logs\",\n field: \"message\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.text_structure.find_field_structure(\n index: \"test-logs\",\n field: \"message\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->textStructure()->findFieldStructure([\n \"index\" => \"test-logs\",\n \"field\" => \"message\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_text_structure/find_field_structure?index=test-logs&field=message\""
},
{
"lang": "Java",
"source": "client.textStructure().findFieldStructure(f -> f\n .columnNames(List.of())\n .field(\"message\")\n .index(\"test-logs\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_text_structure/find_message_structure": {
"post": {
"tags": [
"text_structure"
],
"summary": "Find the structure of text messages\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_text_structure/find_message_structure\n
\n \n POST\n /_text_structure/find_message_structure\n
\n \n\nFind the structure of a list of text messages.\nThe messages must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUse this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\nAppropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.\n\n## Required authorization\n\n* Cluster privileges: `monitor_text_structure`\n",
"operationId": "text-structure-find-message-structure",
"parameters": [
{
"$ref": "#/components/parameters/text_structure.find_message_structure-column_names"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-delimiter"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-ecs_compatibility"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-explain"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-format"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-grok_pattern"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-quote"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-should_trim_fields"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-should_parse_recursively"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-timeout"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-timestamp_field"
},
{
"$ref": "#/components/parameters/text_structure.find_message_structure-timestamp_format"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/text_structure.find_message_structure"
},
"responses": {
"200": {
"$ref": "#/components/responses/text_structure.find_message_structure-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _text_structure/find_message_structure\n{\n \"messages\": [\n \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\n \"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\n \"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\n \"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\n \"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\n \"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\n \"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\n \"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\n \"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\"\n ]\n}"
},
{
"lang": "Python",
"source": "resp = client.text_structure.find_message_structure(\n messages=[\n \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\n \"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\n \"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\n \"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\n \"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\n \"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\n \"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\n \"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\n \"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\"\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.textStructure.findMessageStructure({\n messages: [\n \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\n \"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\n \"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\n \"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\n \"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\n \"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\n \"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\n \"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\n \"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\",\n ],\n});"
},
{
"lang": "Ruby",
"source": "response = client.text_structure.find_message_structure(\n body: {\n \"messages\": [\n \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\n \"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\n \"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\n \"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\n \"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\n \"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\n \"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\n \"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\n \"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\"\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->textStructure()->findMessageStructure([\n \"body\" => [\n \"messages\" => array(\n \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\n \"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\n \"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\n \"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\n \"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\n \"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\n \"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\n \"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\n \"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\",\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"messages\":[\"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\"]}' \"$ELASTICSEARCH_URL/_text_structure/find_message_structure\""
},
{
"lang": "Java",
"source": "client.textStructure().findMessageStructure(f -> f\n .columnNames(List.of())\n .messages(List.of(\"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\"))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_text_structure/find_structure": {
"post": {
"tags": [
"text_structure"
],
"summary": "Find the structure of a text file",
"description": "The text file must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUnlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.\nIt must, however, be text; binary text formats are not currently supported.\nThe size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.\n\nThe response from the API contains:\n\n* A couple of messages from the beginning of the text.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\n## Required authorization\n\n* Cluster privileges: `monitor_text_structure`\n",
"externalDocs": {
"description": "About finding text structure API",
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/find-text-structure-examples",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/find-structure.html"
},
"operationId": "text-structure-find-structure",
"parameters": [
{
"in": "query",
"name": "charset",
"description": "The text's character set.\nIt must be a character set that is supported by the JVM that Elasticsearch uses.\nFor example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`.\nIf this parameter is not specified, the structure finder chooses an appropriate character set.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "column_names",
"description": "If you have set format to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
{
"in": "query",
"name": "delimiter",
"description": "If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "ecs_compatibility",
"description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "explain",
"description": "If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.\nIf the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "format",
"description": "The high level structure of the text.\nValid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/text_structure.find_structure.FindStructureFormat"
},
"style": "form"
},
{
"in": "query",
"name": "grok_pattern",
"description": "If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.GrokPattern"
},
"style": "form"
},
{
"in": "query",
"name": "has_header_row",
"description": "If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text.\nIf this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "line_merge_size_limit",
"description": "The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text.\nIf you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.uint"
},
"style": "form"
},
{
"in": "query",
"name": "lines_to_sample",
"description": "The number of lines to include in the structural analysis, starting from the beginning of the text.\nThe minimum is 2.\nIf the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.\n\nNOTE: The number of lines and the variation of the lines affects the speed of the analysis.\nFor example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample.\nIf possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.uint"
},
"style": "form"
},
{
"in": "query",
"name": "quote",
"description": "If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "should_trim_fields",
"description": "If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`.\nOtherwise, the default value is `false`.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "should_parse_recursively",
"description": "If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires then it will be stopped.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "timestamp_field",
"description": "The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
{
"in": "query",
"name": "timestamp_format",
"description": "The Java time format of the timestamp field in the text.\n\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`.\nSpacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text this will result in the structure finder treating the text as single-line messages.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"FindStructureRequestExample1": {
"description": "Run `POST _text_structure/find_structure` to analyze newline-delimited JSON text.",
"value": "{\"name\": \"Leviathan Wakes\", \"author\": \"James S.A. Corey\", \"release_date\": \"2011-06-02\", \"page_count\": 561}\n{\"name\": \"Hyperion\", \"author\": \"Dan Simmons\", \"release_date\": \"1989-05-26\", \"page_count\": 482}\n{\"name\": \"Dune\", \"author\": \"Frank Herbert\", \"release_date\": \"1965-06-01\", \"page_count\": 604}\n{\"name\": \"Dune Messiah\", \"author\": \"Frank Herbert\", \"release_date\": \"1969-10-15\", \"page_count\": 331}\n{\"name\": \"Children of Dune\", \"author\": \"Frank Herbert\", \"release_date\": \"1976-04-21\", \"page_count\": 408}\n{\"name\": \"God Emperor of Dune\", \"author\": \"Frank Herbert\", \"release_date\": \"1981-05-28\", \"page_count\": 454}\n{\"name\": \"Consider Phlebas\", \"author\": \"Iain M. Banks\", \"release_date\": \"1987-04-23\", \"page_count\": 471}\n{\"name\": \"Pandora's Star\", \"author\": \"Peter F. Hamilton\", \"release_date\": \"2004-03-02\", \"page_count\": 768}\n{\"name\": \"Revelation Space\", \"author\": \"Alastair Reynolds\", \"release_date\": \"2000-03-15\", \"page_count\": 585}\n{\"name\": \"A Fire Upon the Deep\", \"author\": \"Vernor Vinge\", \"release_date\": \"1992-06-01\", \"page_count\": 613}\n{\"name\": \"Ender's Game\", \"author\": \"Orson Scott Card\", \"release_date\": \"1985-06-01\", \"page_count\": 324}\n{\"name\": \"1984\", \"author\": \"George Orwell\", \"release_date\": \"1985-06-01\", \"page_count\": 328}\n{\"name\": \"Fahrenheit 451\", \"author\": \"Ray Bradbury\", \"release_date\": \"1953-10-15\", \"page_count\": 227}\n{\"name\": \"Brave New World\", \"author\": \"Aldous Huxley\", \"release_date\": \"1932-06-01\", \"page_count\": 268}\n{\"name\": \"Foundation\", \"author\": \"Isaac Asimov\", \"release_date\": \"1951-06-01\", \"page_count\": 224}\n{\"name\": \"The Giver\", \"author\": \"Lois Lowry\", \"release_date\": \"1993-04-26\", \"page_count\": 208}\n{\"name\": \"Slaughterhouse-Five\", \"author\": \"Kurt Vonnegut\", \"release_date\": \"1969-06-01\", \"page_count\": 275}\n{\"name\": \"The Hitchhiker's Guide to the Galaxy\", \"author\": \"Douglas Adams\", \"release_date\": \"1979-10-12\", \"page_count\": 180}\n{\"name\": \"Snow Crash\", \"author\": \"Neal Stephenson\", \"release_date\": \"1992-06-01\", \"page_count\": 470}\n{\"name\": \"Neuromancer\", \"author\": \"William Gibson\", \"release_date\": \"1984-07-01\", \"page_count\": 271}\n{\"name\": \"The Handmaid's Tale\", \"author\": \"Margaret Atwood\", \"release_date\": \"1985-06-01\", \"page_count\": 311}\n{\"name\": \"Starship Troopers\", \"author\": \"Robert A. Heinlein\", \"release_date\": \"1959-12-01\", \"page_count\": 335}\n{\"name\": \"The Left Hand of Darkness\", \"author\": \"Ursula K. Le Guin\", \"release_date\": \"1969-06-01\", \"page_count\": 304}\n{\"name\": \"The Moon is a Harsh Mistress\", \"author\": \"Robert A. Heinlein\", \"release_date\": \"1966-04-01\", \"page_count\": 288}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"charset": {
"description": "The character encoding used to parse the text.",
"type": "string"
},
"has_header_row": {
"type": "boolean"
},
"has_byte_order_marker": {
"description": "For UTF character encodings, it indicates whether the text begins with a byte order marker.",
"type": "boolean"
},
"format": {
"description": "Valid values include `ndjson`, `xml`, `delimited`, and `semi_structured_text`.",
"type": "string"
},
"field_stats": {
"description": "The most common values of each field, plus basic numeric statistics for the numeric `page_count` field.\nThis information may provide clues that the data needs to be cleaned or transformed prior to use by other Elastic Stack functionality.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/text_structure._types.FieldStat"
}
},
"sample_start": {
"description": "The first two messages in the text verbatim.\nThis may help diagnose parse errors or accidental uploads of the wrong text.",
"type": "string"
},
"num_messages_analyzed": {
"description": "The number of distinct messages the lines contained.\nFor NDJSON, this value is the same as `num_lines_analyzed`.\nFor other text formats, messages can span several lines.",
"type": "number"
},
"mappings": {
"description": "Some suitable mappings for an index into which the data could be ingested.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"quote": {
"type": "string"
},
"delimiter": {
"type": "string"
},
"need_client_timezone": {
"description": "If a timestamp format is detected that does not include a timezone, `need_client_timezone` is `true`.\nThe server that parses the text must therefore be told the correct timezone by the client.",
"type": "boolean"
},
"num_lines_analyzed": {
"description": "The number of lines of the text that were analyzed.",
"type": "number"
},
"column_names": {
"description": "If `format` is `delimited`, the `column_names` field lists the column names in the order they appear in the sample.",
"type": "array",
"items": {
"type": "string"
}
},
"explanation": {
"type": "array",
"items": {
"type": "string"
}
},
"grok_pattern": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GrokPattern"
}
]
},
"multiline_start_pattern": {
"type": "string"
},
"exclude_lines_pattern": {
"type": "string"
},
"java_timestamp_formats": {
"description": "The Java time formats recognized in the time fields.\nElasticsearch mappings and ingest pipelines use this format.",
"type": "array",
"items": {
"type": "string"
}
},
"joda_timestamp_formats": {
"description": "Information that is used to tell Logstash how to parse timestamps.",
"type": "array",
"items": {
"type": "string"
}
},
"timestamp_field": {
"description": "The field considered most likely to be the primary timestamp of each document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"should_trim_fields": {
"type": "boolean"
},
"ingest_pipeline": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.PipelineConfig"
}
]
}
},
"required": [
"charset",
"has_byte_order_marker",
"format",
"field_stats",
"sample_start",
"num_messages_analyzed",
"mappings",
"need_client_timezone",
"num_lines_analyzed",
"ingest_pipeline"
]
},
"examples": {
"FindStructureResponseExample1": {
"description": "A successful response from `POST _text_structure/find_structure`.",
"value": "{\n \"num_lines_analyzed\" : 24,\n \"num_messages_analyzed\" : 24,\n \"sample_start\" : \"{\\\"name\\\": \\\"Leviathan Wakes\\\", \\\"author\\\": \\\"James S.A. Corey\\\", \\\"release_date\\\": \\\"2011-06-02\\\", \\\"page_count\\\": 561}\\n{\\\"name\\\": \\\"Hyperion\\\", \\\"author\\\": \\\"Dan Simmons\\\", \\\"release_date\\\": \\\"1989-05-26\\\", \\\"page_count\\\": 482}\\n\",\n \"charset\" : \"UTF-8\",\n \"has_byte_order_marker\" : false,\n \"format\" : \"ndjson\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"release_date\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"author\" : {\n \"type\" : \"keyword\"\n },\n \"name\" : {\n \"type\" : \"keyword\"\n },\n \"page_count\" : {\n \"type\" : \"long\"\n },\n \"release_date\" : {\n \"type\" : \"date\",\n \"format\" : \"iso8601\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"date\" : {\n \"field\" : \"release_date\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n }\n ]\n },\n \"field_stats\" : {\n \"author\" : {\n \"count\" : 24,\n \"cardinality\" : 20,\n \"top_hits\" : [\n {\n \"value\" : \"Frank Herbert\",\n \"count\" : 4\n },\n {\n \"value\" : \"Robert A. Heinlein\",\n \"count\" : 2\n },\n {\n \"value\" : \"Alastair Reynolds\",\n \"count\" : 1\n },\n {\n \"value\" : \"Aldous Huxley\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dan Simmons\",\n \"count\" : 1\n },\n {\n \"value\" : \"Douglas Adams\",\n \"count\" : 1\n },\n {\n \"value\" : \"George Orwell\",\n \"count\" : 1\n },\n {\n \"value\" : \"Iain M. Banks\",\n \"count\" : 1\n },\n {\n \"value\" : \"Isaac Asimov\",\n \"count\" : 1\n },\n {\n \"value\" : \"James S.A. Corey\",\n \"count\" : 1\n }\n ]\n },\n \"name\" : {\n \"count\" : 24,\n \"cardinality\" : 24,\n \"top_hits\" : [\n {\n \"value\" : \"1984\",\n \"count\" : 1\n },\n {\n \"value\" : \"A Fire Upon the Deep\",\n \"count\" : 1\n },\n {\n \"value\" : \"Brave New World\",\n \"count\" : 1\n },\n {\n \"value\" : \"Children of Dune\",\n \"count\" : 1\n },\n {\n \"value\" : \"Consider Phlebas\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dune\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dune Messiah\",\n \"count\" : 1\n },\n {\n \"value\" : \"Ender's Game\",\n \"count\" : 1\n },\n {\n \"value\" : \"Fahrenheit 451\",\n \"count\" : 1\n },\n {\n \"value\" : \"Foundation\",\n \"count\" : 1\n }\n ]\n },\n \"page_count\" : {\n \"count\" : 24,\n \"cardinality\" : 24,\n \"min_value\" : 180,\n \"max_value\" : 768,\n \"mean_value\" : 387.0833333333333,\n \"median_value\" : 329.5,\n \"top_hits\" : [\n {\n \"value\" : 180,\n \"count\" : 1\n },\n {\n \"value\" : 208,\n \"count\" : 1\n },\n {\n \"value\" : 224,\n \"count\" : 1\n },\n {\n \"value\" : 227,\n \"count\" : 1\n },\n {\n \"value\" : 268,\n \"count\" : 1\n },\n {\n \"value\" : 271,\n \"count\" : 1\n },\n {\n \"value\" : 275,\n \"count\" : 1\n },\n {\n \"value\" : 288,\n \"count\" : 1\n },\n {\n \"value\" : 304,\n \"count\" : 1\n },\n {\n \"value\" : 311,\n \"count\" : 1\n }\n ]\n },\n \"release_date\" : {\n \"count\" : 24,\n \"cardinality\" : 20,\n \"earliest\" : \"1932-06-01\",\n \"latest\" : \"2011-06-02\",\n \"top_hits\" : [\n {\n \"value\" : \"1985-06-01\",\n \"count\" : 3\n },\n {\n \"value\" : \"1969-06-01\",\n \"count\" : 2\n },\n {\n \"value\" : \"1992-06-01\",\n \"count\" : 2\n },\n {\n \"value\" : \"1932-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1951-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1953-10-15\",\n \"count\" : 1\n },\n {\n \"value\" : \"1959-12-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1965-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1966-04-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1969-10-15\",\n \"count\" : 1\n }\n ]\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.13.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _text_structure/find_structure\n{\"name\": \"Leviathan Wakes\", \"author\": \"James S.A. Corey\", \"release_date\": \"2011-06-02\", \"page_count\": 561}\n{\"name\": \"Hyperion\", \"author\": \"Dan Simmons\", \"release_date\": \"1989-05-26\", \"page_count\": 482}\n{\"name\": \"Dune\", \"author\": \"Frank Herbert\", \"release_date\": \"1965-06-01\", \"page_count\": 604}\n{\"name\": \"Dune Messiah\", \"author\": \"Frank Herbert\", \"release_date\": \"1969-10-15\", \"page_count\": 331}\n{\"name\": \"Children of Dune\", \"author\": \"Frank Herbert\", \"release_date\": \"1976-04-21\", \"page_count\": 408}\n{\"name\": \"God Emperor of Dune\", \"author\": \"Frank Herbert\", \"release_date\": \"1981-05-28\", \"page_count\": 454}\n{\"name\": \"Consider Phlebas\", \"author\": \"Iain M. Banks\", \"release_date\": \"1987-04-23\", \"page_count\": 471}\n{\"name\": \"Pandora's Star\", \"author\": \"Peter F. Hamilton\", \"release_date\": \"2004-03-02\", \"page_count\": 768}\n{\"name\": \"Revelation Space\", \"author\": \"Alastair Reynolds\", \"release_date\": \"2000-03-15\", \"page_count\": 585}\n{\"name\": \"A Fire Upon the Deep\", \"author\": \"Vernor Vinge\", \"release_date\": \"1992-06-01\", \"page_count\": 613}\n{\"name\": \"Ender's Game\", \"author\": \"Orson Scott Card\", \"release_date\": \"1985-06-01\", \"page_count\": 324}\n{\"name\": \"1984\", \"author\": \"George Orwell\", \"release_date\": \"1985-06-01\", \"page_count\": 328}\n{\"name\": \"Fahrenheit 451\", \"author\": \"Ray Bradbury\", \"release_date\": \"1953-10-15\", \"page_count\": 227}\n{\"name\": \"Brave New World\", \"author\": \"Aldous Huxley\", \"release_date\": \"1932-06-01\", \"page_count\": 268}\n{\"name\": \"Foundation\", \"author\": \"Isaac Asimov\", \"release_date\": \"1951-06-01\", \"page_count\": 224}\n{\"name\": \"The Giver\", \"author\": \"Lois Lowry\", \"release_date\": \"1993-04-26\", \"page_count\": 208}\n{\"name\": \"Slaughterhouse-Five\", \"author\": \"Kurt Vonnegut\", \"release_date\": \"1969-06-01\", \"page_count\": 275}\n{\"name\": \"The Hitchhiker's Guide to the Galaxy\", \"author\": \"Douglas Adams\", \"release_date\": \"1979-10-12\", \"page_count\": 180}\n{\"name\": \"Snow Crash\", \"author\": \"Neal Stephenson\", \"release_date\": \"1992-06-01\", \"page_count\": 470}\n{\"name\": \"Neuromancer\", \"author\": \"William Gibson\", \"release_date\": \"1984-07-01\", \"page_count\": 271}\n{\"name\": \"The Handmaid's Tale\", \"author\": \"Margaret Atwood\", \"release_date\": \"1985-06-01\", \"page_count\": 311}\n{\"name\": \"Starship Troopers\", \"author\": \"Robert A. Heinlein\", \"release_date\": \"1959-12-01\", \"page_count\": 335}\n{\"name\": \"The Left Hand of Darkness\", \"author\": \"Ursula K. Le Guin\", \"release_date\": \"1969-06-01\", \"page_count\": 304}\n{\"name\": \"The Moon is a Harsh Mistress\", \"author\": \"Robert A. Heinlein\", \"release_date\": \"1966-04-01\", \"page_count\": 288}"
},
{
"lang": "Python",
"source": "resp = client.text_structure.find_structure(\n text_files=[\n {\n \"name\": \"Leviathan Wakes\",\n \"author\": \"James S.A. Corey\",\n \"release_date\": \"2011-06-02\",\n \"page_count\": 561\n },\n {\n \"name\": \"Hyperion\",\n \"author\": \"Dan Simmons\",\n \"release_date\": \"1989-05-26\",\n \"page_count\": 482\n },\n {\n \"name\": \"Dune\",\n \"author\": \"Frank Herbert\",\n \"release_date\": \"1965-06-01\",\n \"page_count\": 604\n },\n {\n \"name\": \"Dune Messiah\",\n \"author\": \"Frank Herbert\",\n \"release_date\": \"1969-10-15\",\n \"page_count\": 331\n },\n {\n \"name\": \"Children of Dune\",\n \"author\": \"Frank Herbert\",\n \"release_date\": \"1976-04-21\",\n \"page_count\": 408\n },\n {\n \"name\": \"God Emperor of Dune\",\n \"author\": \"Frank Herbert\",\n \"release_date\": \"1981-05-28\",\n \"page_count\": 454\n },\n {\n \"name\": \"Consider Phlebas\",\n \"author\": \"Iain M. Banks\",\n \"release_date\": \"1987-04-23\",\n \"page_count\": 471\n },\n {\n \"name\": \"Pandora's Star\",\n \"author\": \"Peter F. Hamilton\",\n \"release_date\": \"2004-03-02\",\n \"page_count\": 768\n },\n {\n \"name\": \"Revelation Space\",\n \"author\": \"Alastair Reynolds\",\n \"release_date\": \"2000-03-15\",\n \"page_count\": 585\n },\n {\n \"name\": \"A Fire Upon the Deep\",\n \"author\": \"Vernor Vinge\",\n \"release_date\": \"1992-06-01\",\n \"page_count\": 613\n },\n {\n \"name\": \"Ender's Game\",\n \"author\": \"Orson Scott Card\",\n \"release_date\": \"1985-06-01\",\n \"page_count\": 324\n },\n {\n \"name\": \"1984\",\n \"author\": \"George Orwell\",\n \"release_date\": \"1985-06-01\",\n \"page_count\": 328\n },\n {\n \"name\": \"Fahrenheit 451\",\n \"author\": \"Ray Bradbury\",\n \"release_date\": \"1953-10-15\",\n \"page_count\": 227\n },\n {\n \"name\": \"Brave New World\",\n \"author\": \"Aldous Huxley\",\n \"release_date\": \"1932-06-01\",\n \"page_count\": 268\n },\n {\n \"name\": \"Foundation\",\n \"author\": \"Isaac Asimov\",\n \"release_date\": \"1951-06-01\",\n \"page_count\": 224\n },\n {\n \"name\": \"The Giver\",\n \"author\": \"Lois Lowry\",\n \"release_date\": \"1993-04-26\",\n \"page_count\": 208\n },\n {\n \"name\": \"Slaughterhouse-Five\",\n \"author\": \"Kurt Vonnegut\",\n \"release_date\": \"1969-06-01\",\n \"page_count\": 275\n },\n {\n \"name\": \"The Hitchhiker's Guide to the Galaxy\",\n \"author\": \"Douglas Adams\",\n \"release_date\": \"1979-10-12\",\n \"page_count\": 180\n },\n {\n \"name\": \"Snow Crash\",\n \"author\": \"Neal Stephenson\",\n \"release_date\": \"1992-06-01\",\n \"page_count\": 470\n },\n {\n \"name\": \"Neuromancer\",\n \"author\": \"William Gibson\",\n \"release_date\": \"1984-07-01\",\n \"page_count\": 271\n },\n {\n \"name\": \"The Handmaid's Tale\",\n \"author\": \"Margaret Atwood\",\n \"release_date\": \"1985-06-01\",\n \"page_count\": 311\n },\n {\n \"name\": \"Starship Troopers\",\n \"author\": \"Robert A. Heinlein\",\n \"release_date\": \"1959-12-01\",\n \"page_count\": 335\n },\n {\n \"name\": \"The Left Hand of Darkness\",\n \"author\": \"Ursula K. Le Guin\",\n \"release_date\": \"1969-06-01\",\n \"page_count\": 304\n },\n {\n \"name\": \"The Moon is a Harsh Mistress\",\n \"author\": \"Robert A. Heinlein\",\n \"release_date\": \"1966-04-01\",\n \"page_count\": 288\n }\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.textStructure.findStructure({\n text_files: [\n {\n name: \"Leviathan Wakes\",\n author: \"James S.A. Corey\",\n release_date: \"2011-06-02\",\n page_count: 561,\n },\n {\n name: \"Hyperion\",\n author: \"Dan Simmons\",\n release_date: \"1989-05-26\",\n page_count: 482,\n },\n {\n name: \"Dune\",\n author: \"Frank Herbert\",\n release_date: \"1965-06-01\",\n page_count: 604,\n },\n {\n name: \"Dune Messiah\",\n author: \"Frank Herbert\",\n release_date: \"1969-10-15\",\n page_count: 331,\n },\n {\n name: \"Children of Dune\",\n author: \"Frank Herbert\",\n release_date: \"1976-04-21\",\n page_count: 408,\n },\n {\n name: \"God Emperor of Dune\",\n author: \"Frank Herbert\",\n release_date: \"1981-05-28\",\n page_count: 454,\n },\n {\n name: \"Consider Phlebas\",\n author: \"Iain M. Banks\",\n release_date: \"1987-04-23\",\n page_count: 471,\n },\n {\n name: \"Pandora's Star\",\n author: \"Peter F. Hamilton\",\n release_date: \"2004-03-02\",\n page_count: 768,\n },\n {\n name: \"Revelation Space\",\n author: \"Alastair Reynolds\",\n release_date: \"2000-03-15\",\n page_count: 585,\n },\n {\n name: \"A Fire Upon the Deep\",\n author: \"Vernor Vinge\",\n release_date: \"1992-06-01\",\n page_count: 613,\n },\n {\n name: \"Ender's Game\",\n author: \"Orson Scott Card\",\n release_date: \"1985-06-01\",\n page_count: 324,\n },\n {\n name: \"1984\",\n author: \"George Orwell\",\n release_date: \"1985-06-01\",\n page_count: 328,\n },\n {\n name: \"Fahrenheit 451\",\n author: \"Ray Bradbury\",\n release_date: \"1953-10-15\",\n page_count: 227,\n },\n {\n name: \"Brave New World\",\n author: \"Aldous Huxley\",\n release_date: \"1932-06-01\",\n page_count: 268,\n },\n {\n name: \"Foundation\",\n author: \"Isaac Asimov\",\n release_date: \"1951-06-01\",\n page_count: 224,\n },\n {\n name: \"The Giver\",\n author: \"Lois Lowry\",\n release_date: \"1993-04-26\",\n page_count: 208,\n },\n {\n name: \"Slaughterhouse-Five\",\n author: \"Kurt Vonnegut\",\n release_date: \"1969-06-01\",\n page_count: 275,\n },\n {\n name: \"The Hitchhiker's Guide to the Galaxy\",\n author: \"Douglas Adams\",\n release_date: \"1979-10-12\",\n page_count: 180,\n },\n {\n name: \"Snow Crash\",\n author: \"Neal Stephenson\",\n release_date: \"1992-06-01\",\n page_count: 470,\n },\n {\n name: \"Neuromancer\",\n author: \"William Gibson\",\n release_date: \"1984-07-01\",\n page_count: 271,\n },\n {\n name: \"The Handmaid's Tale\",\n author: \"Margaret Atwood\",\n release_date: \"1985-06-01\",\n page_count: 311,\n },\n {\n name: \"Starship Troopers\",\n author: \"Robert A. Heinlein\",\n release_date: \"1959-12-01\",\n page_count: 335,\n },\n {\n name: \"The Left Hand of Darkness\",\n author: \"Ursula K. Le Guin\",\n release_date: \"1969-06-01\",\n page_count: 304,\n },\n {\n name: \"The Moon is a Harsh Mistress\",\n author: \"Robert A. Heinlein\",\n release_date: \"1966-04-01\",\n page_count: 288,\n },\n ],\n});"
},
{
"lang": "Ruby",
"source": "response = client.text_structure.find_structure(\n body: [\n {\n \"name\": \"Leviathan Wakes\",\n \"author\": \"James S.A. Corey\",\n \"release_date\": \"2011-06-02\",\n \"page_count\": 561\n },\n {\n \"name\": \"Hyperion\",\n \"author\": \"Dan Simmons\",\n \"release_date\": \"1989-05-26\",\n \"page_count\": 482\n },\n {\n \"name\": \"Dune\",\n \"author\": \"Frank Herbert\",\n \"release_date\": \"1965-06-01\",\n \"page_count\": 604\n },\n {\n \"name\": \"Dune Messiah\",\n \"author\": \"Frank Herbert\",\n \"release_date\": \"1969-10-15\",\n \"page_count\": 331\n },\n {\n \"name\": \"Children of Dune\",\n \"author\": \"Frank Herbert\",\n \"release_date\": \"1976-04-21\",\n \"page_count\": 408\n },\n {\n \"name\": \"God Emperor of Dune\",\n \"author\": \"Frank Herbert\",\n \"release_date\": \"1981-05-28\",\n \"page_count\": 454\n },\n {\n \"name\": \"Consider Phlebas\",\n \"author\": \"Iain M. Banks\",\n \"release_date\": \"1987-04-23\",\n \"page_count\": 471\n },\n {\n \"name\": \"Pandora's Star\",\n \"author\": \"Peter F. Hamilton\",\n \"release_date\": \"2004-03-02\",\n \"page_count\": 768\n },\n {\n \"name\": \"Revelation Space\",\n \"author\": \"Alastair Reynolds\",\n \"release_date\": \"2000-03-15\",\n \"page_count\": 585\n },\n {\n \"name\": \"A Fire Upon the Deep\",\n \"author\": \"Vernor Vinge\",\n \"release_date\": \"1992-06-01\",\n \"page_count\": 613\n },\n {\n \"name\": \"Ender's Game\",\n \"author\": \"Orson Scott Card\",\n \"release_date\": \"1985-06-01\",\n \"page_count\": 324\n },\n {\n \"name\": \"1984\",\n \"author\": \"George Orwell\",\n \"release_date\": \"1985-06-01\",\n \"page_count\": 328\n },\n {\n \"name\": \"Fahrenheit 451\",\n \"author\": \"Ray Bradbury\",\n \"release_date\": \"1953-10-15\",\n \"page_count\": 227\n },\n {\n \"name\": \"Brave New World\",\n \"author\": \"Aldous Huxley\",\n \"release_date\": \"1932-06-01\",\n \"page_count\": 268\n },\n {\n \"name\": \"Foundation\",\n \"author\": \"Isaac Asimov\",\n \"release_date\": \"1951-06-01\",\n \"page_count\": 224\n },\n {\n \"name\": \"The Giver\",\n \"author\": \"Lois Lowry\",\n \"release_date\": \"1993-04-26\",\n \"page_count\": 208\n },\n {\n \"name\": \"Slaughterhouse-Five\",\n \"author\": \"Kurt Vonnegut\",\n \"release_date\": \"1969-06-01\",\n \"page_count\": 275\n },\n {\n \"name\": \"The Hitchhiker's Guide to the Galaxy\",\n \"author\": \"Douglas Adams\",\n \"release_date\": \"1979-10-12\",\n \"page_count\": 180\n },\n {\n \"name\": \"Snow Crash\",\n \"author\": \"Neal Stephenson\",\n \"release_date\": \"1992-06-01\",\n \"page_count\": 470\n },\n {\n \"name\": \"Neuromancer\",\n \"author\": \"William Gibson\",\n \"release_date\": \"1984-07-01\",\n \"page_count\": 271\n },\n {\n \"name\": \"The Handmaid's Tale\",\n \"author\": \"Margaret Atwood\",\n \"release_date\": \"1985-06-01\",\n \"page_count\": 311\n },\n {\n \"name\": \"Starship Troopers\",\n \"author\": \"Robert A. Heinlein\",\n \"release_date\": \"1959-12-01\",\n \"page_count\": 335\n },\n {\n \"name\": \"The Left Hand of Darkness\",\n \"author\": \"Ursula K. Le Guin\",\n \"release_date\": \"1969-06-01\",\n \"page_count\": 304\n },\n {\n \"name\": \"The Moon is a Harsh Mistress\",\n \"author\": \"Robert A. Heinlein\",\n \"release_date\": \"1966-04-01\",\n \"page_count\": 288\n }\n ]\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->textStructure()->findStructure([\n \"body\" => array(\n [\n \"name\" => \"Leviathan Wakes\",\n \"author\" => \"James S.A. Corey\",\n \"release_date\" => \"2011-06-02\",\n \"page_count\" => 561,\n ],\n [\n \"name\" => \"Hyperion\",\n \"author\" => \"Dan Simmons\",\n \"release_date\" => \"1989-05-26\",\n \"page_count\" => 482,\n ],\n [\n \"name\" => \"Dune\",\n \"author\" => \"Frank Herbert\",\n \"release_date\" => \"1965-06-01\",\n \"page_count\" => 604,\n ],\n [\n \"name\" => \"Dune Messiah\",\n \"author\" => \"Frank Herbert\",\n \"release_date\" => \"1969-10-15\",\n \"page_count\" => 331,\n ],\n [\n \"name\" => \"Children of Dune\",\n \"author\" => \"Frank Herbert\",\n \"release_date\" => \"1976-04-21\",\n \"page_count\" => 408,\n ],\n [\n \"name\" => \"God Emperor of Dune\",\n \"author\" => \"Frank Herbert\",\n \"release_date\" => \"1981-05-28\",\n \"page_count\" => 454,\n ],\n [\n \"name\" => \"Consider Phlebas\",\n \"author\" => \"Iain M. Banks\",\n \"release_date\" => \"1987-04-23\",\n \"page_count\" => 471,\n ],\n [\n \"name\" => \"Pandora's Star\",\n \"author\" => \"Peter F. Hamilton\",\n \"release_date\" => \"2004-03-02\",\n \"page_count\" => 768,\n ],\n [\n \"name\" => \"Revelation Space\",\n \"author\" => \"Alastair Reynolds\",\n \"release_date\" => \"2000-03-15\",\n \"page_count\" => 585,\n ],\n [\n \"name\" => \"A Fire Upon the Deep\",\n \"author\" => \"Vernor Vinge\",\n \"release_date\" => \"1992-06-01\",\n \"page_count\" => 613,\n ],\n [\n \"name\" => \"Ender's Game\",\n \"author\" => \"Orson Scott Card\",\n \"release_date\" => \"1985-06-01\",\n \"page_count\" => 324,\n ],\n [\n \"name\" => \"1984\",\n \"author\" => \"George Orwell\",\n \"release_date\" => \"1985-06-01\",\n \"page_count\" => 328,\n ],\n [\n \"name\" => \"Fahrenheit 451\",\n \"author\" => \"Ray Bradbury\",\n \"release_date\" => \"1953-10-15\",\n \"page_count\" => 227,\n ],\n [\n \"name\" => \"Brave New World\",\n \"author\" => \"Aldous Huxley\",\n \"release_date\" => \"1932-06-01\",\n \"page_count\" => 268,\n ],\n [\n \"name\" => \"Foundation\",\n \"author\" => \"Isaac Asimov\",\n \"release_date\" => \"1951-06-01\",\n \"page_count\" => 224,\n ],\n [\n \"name\" => \"The Giver\",\n \"author\" => \"Lois Lowry\",\n \"release_date\" => \"1993-04-26\",\n \"page_count\" => 208,\n ],\n [\n \"name\" => \"Slaughterhouse-Five\",\n \"author\" => \"Kurt Vonnegut\",\n \"release_date\" => \"1969-06-01\",\n \"page_count\" => 275,\n ],\n [\n \"name\" => \"The Hitchhiker's Guide to the Galaxy\",\n \"author\" => \"Douglas Adams\",\n \"release_date\" => \"1979-10-12\",\n \"page_count\" => 180,\n ],\n [\n \"name\" => \"Snow Crash\",\n \"author\" => \"Neal Stephenson\",\n \"release_date\" => \"1992-06-01\",\n \"page_count\" => 470,\n ],\n [\n \"name\" => \"Neuromancer\",\n \"author\" => \"William Gibson\",\n \"release_date\" => \"1984-07-01\",\n \"page_count\" => 271,\n ],\n [\n \"name\" => \"The Handmaid's Tale\",\n \"author\" => \"Margaret Atwood\",\n \"release_date\" => \"1985-06-01\",\n \"page_count\" => 311,\n ],\n [\n \"name\" => \"Starship Troopers\",\n \"author\" => \"Robert A. Heinlein\",\n \"release_date\" => \"1959-12-01\",\n \"page_count\" => 335,\n ],\n [\n \"name\" => \"The Left Hand of Darkness\",\n \"author\" => \"Ursula K. Le Guin\",\n \"release_date\" => \"1969-06-01\",\n \"page_count\" => 304,\n ],\n [\n \"name\" => \"The Moon is a Harsh Mistress\",\n \"author\" => \"Robert A. Heinlein\",\n \"release_date\" => \"1966-04-01\",\n \"page_count\" => 288,\n ],\n ),\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/x-ndjson\" -d $'{\"name\":\"Leviathan Wakes\",\"author\":\"James S.A. Corey\",\"release_date\":\"2011-06-02\",\"page_count\":561}\\n{\"name\":\"Hyperion\",\"author\":\"Dan Simmons\",\"release_date\":\"1989-05-26\",\"page_count\":482}\\n{\"name\":\"Dune\",\"author\":\"Frank Herbert\",\"release_date\":\"1965-06-01\",\"page_count\":604}\\n{\"name\":\"Dune Messiah\",\"author\":\"Frank Herbert\",\"release_date\":\"1969-10-15\",\"page_count\":331}\\n{\"name\":\"Children of Dune\",\"author\":\"Frank Herbert\",\"release_date\":\"1976-04-21\",\"page_count\":408}\\n{\"name\":\"God Emperor of Dune\",\"author\":\"Frank Herbert\",\"release_date\":\"1981-05-28\",\"page_count\":454}\\n{\"name\":\"Consider Phlebas\",\"author\":\"Iain M. Banks\",\"release_date\":\"1987-04-23\",\"page_count\":471}\\n{\"name\":\"Pandora'\"'\"$'s Star\",\"author\":\"Peter F. Hamilton\",\"release_date\":\"2004-03-02\",\"page_count\":768}\\n{\"name\":\"Revelation Space\",\"author\":\"Alastair Reynolds\",\"release_date\":\"2000-03-15\",\"page_count\":585}\\n{\"name\":\"A Fire Upon the Deep\",\"author\":\"Vernor Vinge\",\"release_date\":\"1992-06-01\",\"page_count\":613}\\n{\"name\":\"Ender'\"'\"$'s Game\",\"author\":\"Orson Scott Card\",\"release_date\":\"1985-06-01\",\"page_count\":324}\\n{\"name\":\"1984\",\"author\":\"George Orwell\",\"release_date\":\"1985-06-01\",\"page_count\":328}\\n{\"name\":\"Fahrenheit 451\",\"author\":\"Ray Bradbury\",\"release_date\":\"1953-10-15\",\"page_count\":227}\\n{\"name\":\"Brave New World\",\"author\":\"Aldous Huxley\",\"release_date\":\"1932-06-01\",\"page_count\":268}\\n{\"name\":\"Foundation\",\"author\":\"Isaac Asimov\",\"release_date\":\"1951-06-01\",\"page_count\":224}\\n{\"name\":\"The Giver\",\"author\":\"Lois Lowry\",\"release_date\":\"1993-04-26\",\"page_count\":208}\\n{\"name\":\"Slaughterhouse-Five\",\"author\":\"Kurt Vonnegut\",\"release_date\":\"1969-06-01\",\"page_count\":275}\\n{\"name\":\"The Hitchhiker'\"'\"$'s Guide to the Galaxy\",\"author\":\"Douglas Adams\",\"release_date\":\"1979-10-12\",\"page_count\":180}\\n{\"name\":\"Snow Crash\",\"author\":\"Neal Stephenson\",\"release_date\":\"1992-06-01\",\"page_count\":470}\\n{\"name\":\"Neuromancer\",\"author\":\"William Gibson\",\"release_date\":\"1984-07-01\",\"page_count\":271}\\n{\"name\":\"The Handmaid'\"'\"$'s Tale\",\"author\":\"Margaret Atwood\",\"release_date\":\"1985-06-01\",\"page_count\":311}\\n{\"name\":\"Starship Troopers\",\"author\":\"Robert A. Heinlein\",\"release_date\":\"1959-12-01\",\"page_count\":335}\\n{\"name\":\"The Left Hand of Darkness\",\"author\":\"Ursula K. Le Guin\",\"release_date\":\"1969-06-01\",\"page_count\":304}\\n{\"name\":\"The Moon is a Harsh Mistress\",\"author\":\"Robert A. Heinlein\",\"release_date\":\"1966-04-01\",\"page_count\":288}\\n' \"$ELASTICSEARCH_URL/_text_structure/find_structure\""
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_text_structure/test_grok_pattern": {
"post": {
"tags": [
"text_structure"
],
"summary": "Test a Grok pattern\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_text_structure/test_grok_pattern\n
\n \n POST\n /_text_structure/test_grok_pattern\n
\n \n\nTest a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.",
"externalDocs": {
"description": "Learn more about Grok patterns",
"url": "https://www.elastic.co/docs/explore-analyze/scripting/grok",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/test-grok-pattern.html"
},
"operationId": "text-structure-test-grok-pattern",
"parameters": [
{
"$ref": "#/components/parameters/text_structure.test_grok_pattern-ecs_compatibility"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/text_structure.test_grok_pattern"
},
"responses": {
"200": {
"$ref": "#/components/responses/text_structure.test_grok_pattern-200"
}
},
"x-state": "Generally available; Added in 8.13.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _text_structure/test_grok_pattern\n{\n \"grok_pattern\": \"Hello %{WORD:first_name} %{WORD:last_name}\",\n \"text\": [\n \"Hello John Doe\",\n \"this does not match\"\n ]\n}"
},
{
"lang": "Python",
"source": "resp = client.text_structure.test_grok_pattern(\n grok_pattern=\"Hello %{WORD:first_name} %{WORD:last_name}\",\n text=[\n \"Hello John Doe\",\n \"this does not match\"\n ],\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.textStructure.testGrokPattern({\n grok_pattern: \"Hello %{WORD:first_name} %{WORD:last_name}\",\n text: [\"Hello John Doe\", \"this does not match\"],\n});"
},
{
"lang": "Ruby",
"source": "response = client.text_structure.test_grok_pattern(\n body: {\n \"grok_pattern\": \"Hello %{WORD:first_name} %{WORD:last_name}\",\n \"text\": [\n \"Hello John Doe\",\n \"this does not match\"\n ]\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->textStructure()->testGrokPattern([\n \"body\" => [\n \"grok_pattern\" => \"Hello %{WORD:first_name} %{WORD:last_name}\",\n \"text\" => array(\n \"Hello John Doe\",\n \"this does not match\",\n ),\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"grok_pattern\":\"Hello %{WORD:first_name} %{WORD:last_name}\",\"text\":[\"Hello John Doe\",\"this does not match\"]}' \"$ELASTICSEARCH_URL/_text_structure/test_grok_pattern\""
},
{
"lang": "Java",
"source": "client.textStructure().testGrokPattern(t -> t\n .grokPattern(\"Hello %{WORD:first_name} %{WORD:last_name}\")\n .text(List.of(\"Hello John Doe\",\"this does not match\"))\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/{transform_id}": {
"get": {
"tags": [
"transform"
],
"summary": "Get transforms\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_transform\n
\n \n GET\n /_transform/{transform_id}\n
\n \n\nGet configuration information for transforms.\n\n## Required authorization\n\n* Cluster privileges: `monitor_transform`\n",
"operationId": "transform-get-transform",
"parameters": [
{
"$ref": "#/components/parameters/transform.get_transform-transform_id"
},
{
"$ref": "#/components/parameters/transform.get_transform-allow_no_match"
},
{
"$ref": "#/components/parameters/transform.get_transform-from"
},
{
"$ref": "#/components/parameters/transform.get_transform-size"
},
{
"$ref": "#/components/parameters/transform.get_transform-exclude_generated"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/transform.get_transform-200"
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _transform?size=10\n"
},
{
"lang": "Python",
"source": "resp = client.transform.get_transform(\n size=\"10\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.getTransform({\n size: 10,\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.get_transform(\n size: \"10\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->getTransform([\n \"size\" => \"10\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform?size=10\""
},
{
"lang": "Java",
"source": "client.transform().getTransform(g -> g\n .size(10)\n .transformId(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"put": {
"tags": [
"transform"
],
"summary": "Create a transform",
"description": "Creates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.\n\n## Required authorization\n\n* Index privileges: `create_index`,`read`,`index`,`view_index_metadata`\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-put-transform",
"parameters": [
{
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "defer_validation",
"description": "When the transform is created, a series of validations occur to ensure its success. For example, there is a\ncheck for the existence of the source indices and a check that the destination index is not part of the source\nindex pattern. You can use this parameter to skip the checks, for example when the source index does not exist\nuntil after the transform is created. The validations are always run when you start the transform, however, with\nthe exception of privilege checks.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"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"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dest": {
"description": "The destination for the transform.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Destination"
}
]
},
"description": {
"description": "Free text description of the transform.",
"type": "string"
},
"frequency": {
"description": "The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.",
"default": "1m",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"latest": {
"description": "The latest method transforms the data by finding the latest document for each unique key.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Latest"
}
]
},
"_meta": {
"description": "Defines optional transform metadata.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"pivot": {
"description": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Pivot"
}
]
},
"retention_policy": {
"description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
}
]
},
"settings": {
"description": "Defines optional transform settings.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Settings"
}
]
},
"source": {
"description": "The source of the data for the transform.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Source"
}
]
},
"sync": {
"description": "Defines the properties transforms require to run continuously.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.SyncContainer"
}
]
}
},
"required": [
"dest",
"source"
]
},
"examples": {
"PutTransformRequestExample1": {
"summary": "A pivot transform",
"description": "Run `PUT _transform/ecommerce_transform1` to create a transform that uses the pivot method.",
"value": "{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n}"
},
"PutTransformRequestExample2": {
"summary": "A latest transform",
"description": "Run `PUT _transform/ecommerce_transform2` to create a transform that uses the latest method.",
"value": "{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n \"latest\": {\n \"unique_key\": [\n \"customer_id\"\n ],\n \"sort\": \"order_date\"\n },\n \"description\": \"Latest order for each customer\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform2\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"PutTransformResponseExample1": {
"description": "A successful response when creating a transform.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT _transform/ecommerce_transform1\n{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.transform.put_transform(\n transform_id=\"ecommerce_transform1\",\n source={\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n pivot={\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": True\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n description=\"Maximum priced ecommerce data by customer_id in Asia\",\n dest={\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n frequency=\"5m\",\n sync={\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n retention_policy={\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.putTransform({\n transform_id: \"ecommerce_transform1\",\n source: {\n index: \"kibana_sample_data_ecommerce\",\n query: {\n term: {\n \"geoip.continent_name\": {\n value: \"Asia\",\n },\n },\n },\n },\n pivot: {\n group_by: {\n customer_id: {\n terms: {\n field: \"customer_id\",\n missing_bucket: true,\n },\n },\n },\n aggregations: {\n max_price: {\n max: {\n field: \"taxful_total_price\",\n },\n },\n },\n },\n description: \"Maximum priced ecommerce data by customer_id in Asia\",\n dest: {\n index: \"kibana_sample_data_ecommerce_transform1\",\n pipeline: \"add_timestamp_pipeline\",\n },\n frequency: \"5m\",\n sync: {\n time: {\n field: \"order_date\",\n delay: \"60s\",\n },\n },\n retention_policy: {\n time: {\n field: \"order_date\",\n max_age: \"30d\",\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.put_transform(\n transform_id: \"ecommerce_transform1\",\n body: {\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->putTransform([\n \"transform_id\" => \"ecommerce_transform1\",\n \"body\" => [\n \"source\" => [\n \"index\" => \"kibana_sample_data_ecommerce\",\n \"query\" => [\n \"term\" => [\n \"geoip.continent_name\" => [\n \"value\" => \"Asia\",\n ],\n ],\n ],\n ],\n \"pivot\" => [\n \"group_by\" => [\n \"customer_id\" => [\n \"terms\" => [\n \"field\" => \"customer_id\",\n \"missing_bucket\" => true,\n ],\n ],\n ],\n \"aggregations\" => [\n \"max_price\" => [\n \"max\" => [\n \"field\" => \"taxful_total_price\",\n ],\n ],\n ],\n ],\n \"description\" => \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\" => [\n \"index\" => \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\" => \"add_timestamp_pipeline\",\n ],\n \"frequency\" => \"5m\",\n \"sync\" => [\n \"time\" => [\n \"field\" => \"order_date\",\n \"delay\" => \"60s\",\n ],\n ],\n \"retention_policy\" => [\n \"time\" => [\n \"field\" => \"order_date\",\n \"max_age\" => \"30d\",\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"source\":{\"index\":\"kibana_sample_data_ecommerce\",\"query\":{\"term\":{\"geoip.continent_name\":{\"value\":\"Asia\"}}}},\"pivot\":{\"group_by\":{\"customer_id\":{\"terms\":{\"field\":\"customer_id\",\"missing_bucket\":true}}},\"aggregations\":{\"max_price\":{\"max\":{\"field\":\"taxful_total_price\"}}}},\"description\":\"Maximum priced ecommerce data by customer_id in Asia\",\"dest\":{\"index\":\"kibana_sample_data_ecommerce_transform1\",\"pipeline\":\"add_timestamp_pipeline\"},\"frequency\":\"5m\",\"sync\":{\"time\":{\"field\":\"order_date\",\"delay\":\"60s\"}},\"retention_policy\":{\"time\":{\"field\":\"order_date\",\"max_age\":\"30d\"}}}' \"$ELASTICSEARCH_URL/_transform/ecommerce_transform1\""
},
{
"lang": "Java",
"source": "client.transform().putTransform(p -> p\n .meta(Map.of())\n .description(\"Maximum priced ecommerce data by customer_id in Asia\")\n .dest(d -> d\n .index(\"kibana_sample_data_ecommerce_transform1\")\n .pipeline(\"add_timestamp_pipeline\")\n )\n .frequency(f -> f\n .time(\"5m\")\n )\n .pivot(pi -> pi\n .aggregations(\"max_price\", a -> a\n .max(m -> m\n .field(\"taxful_total_price\")\n )\n .aggregations(Map.of())\n .meta(Map.of())\n )\n .groupBy(\"customer_id\", g -> g\n .terms(t -> t\n .field(\"customer_id\")\n .missingBucket(true)\n .order(List.of())\n )\n )\n )\n .retentionPolicy(r -> r\n .time(t -> t\n .field(\"order_date\")\n .maxAge(m -> m\n .time(\"30d\")\n )\n )\n )\n .source(s -> s\n .index(\"kibana_sample_data_ecommerce\")\n .query(q -> q\n .term(te -> te\n .field(\"geoip.continent_name\")\n .value(FieldValue.of(\"Asia\"))\n )\n )\n .runtimeMappings(Map.of())\n )\n .sync(sy -> sy\n .time(ti -> ti\n .delay(d -> d\n .time(\"60s\")\n )\n .field(\"order_date\")\n )\n )\n .transformId(\"ecommerce_transform1\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"transform"
],
"summary": "Delete a transform",
"description": "\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-delete-transform",
"parameters": [
{
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "force",
"description": "If this value is false, the transform must be stopped before it can be deleted. If true, the transform is\ndeleted regardless of its current state.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "delete_dest_index",
"description": "If this value is true, the destination index is deleted together with the transform. If false, the destination\nindex will not be deleted",
"deprecated": false,
"schema": {
"type": "boolean"
},
"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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"DeleteTransformResponseExample1": {
"description": "A successful response when the transform is deleted.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE _transform/ecommerce_transform\n"
},
{
"lang": "Python",
"source": "resp = client.transform.delete_transform(\n transform_id=\"ecommerce_transform\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.deleteTransform({\n transform_id: \"ecommerce_transform\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.delete_transform(\n transform_id: \"ecommerce_transform\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->deleteTransform([\n \"transform_id\" => \"ecommerce_transform\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce_transform\""
},
{
"lang": "Java",
"source": "client.transform().deleteTransform(d -> d\n .transformId(\"ecommerce_transform\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/_node_stats": {
"get": {
"tags": [
"transform"
],
"summary": "Get node stats",
"description": "Get per-node information about transform usage.",
"operationId": "transform-get-node-stats",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transform.get_node_stats.TransformNodeFullStats"
}
}
}
}
},
"x-state": "Generally available; Added in 8.15.0",
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/{transform_id}/_stats": {
"get": {
"tags": [
"transform"
],
"summary": "Get transform stats",
"description": "Get usage information for transforms.\n\n## Required authorization\n\n* Index privileges: `read`,`view_index_metadata`\n* Cluster privileges: `monitor_transform`\n",
"operationId": "transform-get-transform-stats",
"parameters": [
{
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the ``, or by omitting the\n``.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
{
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere 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": "size",
"description": "Specifies the maximum number of transforms to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "Controls the time to wait for the stats",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"transforms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transform.get_transform_stats.TransformStats"
}
}
},
"required": [
"count",
"transforms"
]
},
"examples": {
"GetTransformStatsResponseExample1": {
"description": "A successful response that contains usage information for a transform.",
"value": "{\n \"count\": 1,\n \"transforms\": [\n {\n \"id\": \"ecommerce-customer-transform\",\n \"state\": \"started\",\n \"node\": {\n \"id\": \"cpTIGMsVQ8Gqwqlxxxxxxx\",\n \"name\": \"my.home\",\n \"ephemeral_id\": \"5-L21nFsQxxxxxxxxxx-xx\",\n \"transport_address\": \"127.0.0.1:9300\",\n \"attributes\": {}\n },\n \"stats\": {\n \"pages_processed\": 78,\n \"documents_processed\": 6027,\n \"documents_indexed\": 68,\n \"documents_deleted\": 22,\n \"delete_time_in_ms\": 214,\n \"trigger_count\": 168,\n \"index_time_in_ms\": 412,\n \"index_total\": 20,\n \"index_failures\": 0,\n \"search_time_in_ms\": 353,\n \"search_total\": 78,\n \"search_failures\": 0,\n \"processing_time_in_ms\": 8,\n \"processing_total\": 78,\n \"exponential_avg_checkpoint_duration_ms\": 97.30637923893185,\n \"exponential_avg_documents_indexed\": 2.2064915040974062,\n \"exponential_avg_documents_processed\": 179.89419945785045\n },\n \"checkpointing\": {\n \"last\": {\n \"checkpoint\": 20,\n \"timestamp_millis\": 1585344558220,\n \"time_upper_bound_millis\": 1585344498220\n },\n \"changes_last_detected_at\": 1585344558219\n },\n \"health\": {\n \"status\": \"green\"\n }\n }\n ]\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _transform/ecommerce-customer-transform/_stats\n"
},
{
"lang": "Python",
"source": "resp = client.transform.get_transform_stats(\n transform_id=\"ecommerce-customer-transform\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.getTransformStats({\n transform_id: \"ecommerce-customer-transform\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.get_transform_stats(\n transform_id: \"ecommerce-customer-transform\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->getTransformStats([\n \"transform_id\" => \"ecommerce-customer-transform\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce-customer-transform/_stats\""
},
{
"lang": "Java",
"source": "client.transform().getTransformStats(g -> g\n .transformId(\"ecommerce-customer-transform\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/{transform_id}/_preview": {
"post": {
"tags": [
"transform"
],
"summary": "Preview a transform\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_transform/_preview\n
\n \n POST\n /_transform/_preview\n
\n \n GET\n /_transform/{transform_id}/_preview\n
\n \n POST\n /_transform/{transform_id}/_preview\n
\n \n\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.\n\n## Required authorization\n\n* Index privileges: `read`,`view_index_metadata`\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-preview-transform",
"parameters": [
{
"$ref": "#/components/parameters/transform.preview_transform-transform_id"
},
{
"$ref": "#/components/parameters/transform.preview_transform-timeout"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/transform.preview_transform"
},
"responses": {
"200": {
"$ref": "#/components/responses/transform.preview_transform-200"
}
},
"x-state": "Generally available; Added in 7.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _transform/_preview\n{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.transform.preview_transform(\n source={\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n pivot={\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": True\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.previewTransform({\n source: {\n index: \"kibana_sample_data_ecommerce\",\n },\n pivot: {\n group_by: {\n customer_id: {\n terms: {\n field: \"customer_id\",\n missing_bucket: true,\n },\n },\n },\n aggregations: {\n max_price: {\n max: {\n field: \"taxful_total_price\",\n },\n },\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.preview_transform(\n body: {\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->previewTransform([\n \"body\" => [\n \"source\" => [\n \"index\" => \"kibana_sample_data_ecommerce\",\n ],\n \"pivot\" => [\n \"group_by\" => [\n \"customer_id\" => [\n \"terms\" => [\n \"field\" => \"customer_id\",\n \"missing_bucket\" => true,\n ],\n ],\n ],\n \"aggregations\" => [\n \"max_price\" => [\n \"max\" => [\n \"field\" => \"taxful_total_price\",\n ],\n ],\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"source\":{\"index\":\"kibana_sample_data_ecommerce\"},\"pivot\":{\"group_by\":{\"customer_id\":{\"terms\":{\"field\":\"customer_id\",\"missing_bucket\":true}}},\"aggregations\":{\"max_price\":{\"max\":{\"field\":\"taxful_total_price\"}}}}}' \"$ELASTICSEARCH_URL/_transform/_preview\""
},
{
"lang": "Java",
"source": "client.transform().previewTransform(p -> p\n .pivot(pi -> pi\n .aggregations(\"max_price\", a -> a\n .max(m -> m\n .field(\"taxful_total_price\")\n )\n .aggregations(Map.of())\n .meta(Map.of())\n )\n .groupBy(\"customer_id\", g -> g\n .terms(t -> t\n .field(\"customer_id\")\n .missingBucket(true)\n .order(List.of())\n )\n )\n )\n .source(s -> s\n .index(\"kibana_sample_data_ecommerce\")\n .runtimeMappings(Map.of())\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/{transform_id}/_reset": {
"post": {
"tags": [
"transform"
],
"summary": "Reset a transform",
"description": "Before you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-reset-transform",
"parameters": [
{
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "force",
"description": "If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform\nmust be stopped before it can be reset.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"ResetTransformResponseExample1": {
"description": "A successful response when the transform is reset.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.1.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _transform/ecommerce_transform/_reset\n"
},
{
"lang": "Python",
"source": "resp = client.transform.reset_transform(\n transform_id=\"ecommerce_transform\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.resetTransform({\n transform_id: \"ecommerce_transform\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.reset_transform(\n transform_id: \"ecommerce_transform\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->resetTransform([\n \"transform_id\" => \"ecommerce_transform\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce_transform/_reset\""
},
{
"lang": "Java",
"source": "client.transform().resetTransform(r -> r\n .transformId(\"ecommerce_transform\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/{transform_id}/_schedule_now": {
"post": {
"tags": [
"transform"
],
"summary": "Schedule a transform to start now",
"description": "Instantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-schedule-now-transform",
"parameters": [
{
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "timeout",
"description": "Controls the time to wait for the scheduling to take place",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "defer",
"description": "When true, defers the scheduling by the transform's configured sync delay\ninstead of triggering immediately. The transform will process new data after\nthe delay elapses rather than right away.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 9.4.0",
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"ScheduleNowTransformResponseExample1": {
"description": "A successful response when the transform is scheduled to run now.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 8.7.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _transform/ecommerce_transform/_schedule_now\n"
},
{
"lang": "Python",
"source": "resp = client.transform.schedule_now_transform(\n transform_id=\"ecommerce_transform\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.scheduleNowTransform({\n transform_id: \"ecommerce_transform\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.schedule_now_transform(\n transform_id: \"ecommerce_transform\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->scheduleNowTransform([\n \"transform_id\" => \"ecommerce_transform\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce_transform/_schedule_now\""
},
{
"lang": "Java",
"source": "client.transform().scheduleNowTransform(s -> s\n .transformId(\"ecommerce_transform\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/set_upgrade_mode": {
"post": {
"tags": [
"transform"
],
"summary": "Set upgrade_mode for transform indices",
"description": "Sets a cluster wide upgrade_mode setting that prepares transform\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your transform indices. In those circumstances,\nthere must be no transforms running. You can close the transforms,\ndo the upgrade, then open all the transforms again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the transforms\nand prevent new transforms from opening. You can also use this API\nduring upgrades that do not require you to reindex your transform\nindices, though stopping transforms is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\ntransform info API.\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-set-upgrade-mode",
"parameters": [
{
"in": "query",
"name": "enabled",
"description": "When `true`, it enables `upgrade_mode` which temporarily halts all\ntransform tasks and prohibits new transform tasks from\nstarting.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The time to wait for the request to be completed.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
}
},
"x-state": "Generally available; Added in 8.18.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _transform/set_upgrade_mode?enabled=true\n"
},
{
"lang": "Python",
"source": "resp = client.transform.set_upgrade_mode(\n enabled=True,\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.setUpgradeMode({\n enabled: \"true\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.set_upgrade_mode(\n enabled: \"true\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->setUpgradeMode([\n \"enabled\" => \"true\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/set_upgrade_mode?enabled=true\""
},
{
"lang": "Java",
"source": "client.transform().setUpgradeMode(s -> s\n .enabled(true)\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/{transform_id}/_start": {
"post": {
"tags": [
"transform"
],
"summary": "Start a transform",
"description": "When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.\n\n## Required authorization\n\n* Index privileges: `read`,`view_index_metadata`\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-start-transform",
"parameters": [
{
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"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": "from",
"description": "Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"StartTransformResponseExample1": {
"description": "A successful response when a transform starts.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _transform/ecommerce-customer-transform/_start\n"
},
{
"lang": "Python",
"source": "resp = client.transform.start_transform(\n transform_id=\"ecommerce-customer-transform\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.startTransform({\n transform_id: \"ecommerce-customer-transform\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.start_transform(\n transform_id: \"ecommerce-customer-transform\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->startTransform([\n \"transform_id\" => \"ecommerce-customer-transform\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce-customer-transform/_start\""
},
{
"lang": "Java",
"source": "client.transform().startTransform(s -> s\n .transformId(\"ecommerce-customer-transform\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/{transform_id}/_stop": {
"post": {
"tags": [
"transform"
],
"summary": "Stop transforms",
"description": "Stops one or more transforms.\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-stop-transform",
"parameters": [
{
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.\nTo stop all transforms, use `_all` or `*` as the identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"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;\ncontains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there\nare only partial matches.\n\nIf it is true, the API returns a successful acknowledgement message when there are no matches. When there are\nonly partial matches, the API stops the appropriate transforms.\n\nIf it is 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": "force",
"description": "If it is true, the API forcefully stops the transforms.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the\ntimeout expires, the request returns a timeout exception. However, the request continues processing and\neventually moves the transform to a STOPPED state.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_checkpoint",
"description": "If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,\nthe transform stops as soon as possible.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_completion",
"description": "If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns\nimmediately and the indexer is stopped asynchronously in the background.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"StopTransformResponseExample1": {
"description": "A successful response when a transform stops.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _transform/ecommerce_transform/_stop\n"
},
{
"lang": "Python",
"source": "resp = client.transform.stop_transform(\n transform_id=\"ecommerce_transform\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.stopTransform({\n transform_id: \"ecommerce_transform\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.stop_transform(\n transform_id: \"ecommerce_transform\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->stopTransform([\n \"transform_id\" => \"ecommerce_transform\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce_transform/_stop\""
},
{
"lang": "Java",
"source": "client.transform().stopTransform(s -> s\n .transformId(\"ecommerce_transform\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/{transform_id}/_update": {
"post": {
"tags": [
"transform"
],
"summary": "Update a transform",
"description": "Updates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.\n\n## Required authorization\n\n* Index privileges: `read`,`index`,`view_index_metadata`\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-update-transform",
"parameters": [
{
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "defer_validation",
"description": "When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dest": {
"description": "The destination for the transform.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Destination"
}
]
},
"description": {
"description": "Free text description of the transform.",
"type": "string"
},
"frequency": {
"description": "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.",
"default": "1m",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"_meta": {
"description": "Defines optional transform metadata.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"source": {
"description": "The source of the data for the transform.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Source"
}
]
},
"settings": {
"description": "Defines optional transform settings.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Settings"
}
]
},
"sync": {
"description": "Defines the properties transforms require to run continuously.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.SyncContainer"
}
]
},
"retention_policy": {
"description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.",
"oneOf": [
{
"$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"examples": {
"UpdateTransformRequestExample1": {
"description": "Run `POST _transform/simple-kibana-ecomm-pivot/_update` to update a transform that uses the pivot method.",
"value": "{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"15m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"authorization": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TransformAuthorization"
}
]
},
"create_time": {
"type": "number"
},
"description": {
"type": "string"
},
"dest": {
"allOf": [
{
"$ref": "#/components/schemas/_global.reindex.Destination"
}
]
},
"frequency": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"latest": {
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Latest"
}
]
},
"pivot": {
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Pivot"
}
]
},
"retention_policy": {
"allOf": [
{
"$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
}
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Settings"
}
]
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/_global.reindex.Source"
}
]
},
"sync": {
"allOf": [
{
"$ref": "#/components/schemas/transform._types.SyncContainer"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"_meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
},
"required": [
"create_time",
"description",
"dest",
"id",
"settings",
"source",
"version"
]
},
"examples": {
"UpdateTransformResponseExample1": {
"description": "A successful response when creating a transform.",
"value": "{\n \"id\": \"simple-kibana-ecomm-pivot\",\n \"authorization\": {\n \"roles\": [\n \"superuser\"\n ]\n },\n \"version\": \"10.0.0\",\n \"create_time\": 1712951576767,\n \"source\": {\n \"index\": [\n \"kibana_sample_data_ecommerce\"\n ],\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"15m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"settings\": {},\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.2.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _transform/simple-kibana-ecomm-pivot/_update\n{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"15m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.transform.update_transform(\n transform_id=\"simple-kibana-ecomm-pivot\",\n source={\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n description=\"Maximum priced ecommerce data by customer_id in Asia\",\n dest={\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n frequency=\"15m\",\n sync={\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.updateTransform({\n transform_id: \"simple-kibana-ecomm-pivot\",\n source: {\n index: \"kibana_sample_data_ecommerce\",\n query: {\n term: {\n \"geoip.continent_name\": {\n value: \"Asia\",\n },\n },\n },\n },\n description: \"Maximum priced ecommerce data by customer_id in Asia\",\n dest: {\n index: \"kibana_sample_data_ecommerce_transform_v2\",\n pipeline: \"add_timestamp_pipeline\",\n },\n frequency: \"15m\",\n sync: {\n time: {\n field: \"order_date\",\n delay: \"120s\",\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.transform.update_transform(\n transform_id: \"simple-kibana-ecomm-pivot\",\n body: {\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"15m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->updateTransform([\n \"transform_id\" => \"simple-kibana-ecomm-pivot\",\n \"body\" => [\n \"source\" => [\n \"index\" => \"kibana_sample_data_ecommerce\",\n \"query\" => [\n \"term\" => [\n \"geoip.continent_name\" => [\n \"value\" => \"Asia\",\n ],\n ],\n ],\n ],\n \"description\" => \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\" => [\n \"index\" => \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\" => \"add_timestamp_pipeline\",\n ],\n \"frequency\" => \"15m\",\n \"sync\" => [\n \"time\" => [\n \"field\" => \"order_date\",\n \"delay\" => \"120s\",\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"source\":{\"index\":\"kibana_sample_data_ecommerce\",\"query\":{\"term\":{\"geoip.continent_name\":{\"value\":\"Asia\"}}}},\"description\":\"Maximum priced ecommerce data by customer_id in Asia\",\"dest\":{\"index\":\"kibana_sample_data_ecommerce_transform_v2\",\"pipeline\":\"add_timestamp_pipeline\"},\"frequency\":\"15m\",\"sync\":{\"time\":{\"field\":\"order_date\",\"delay\":\"120s\"}}}' \"$ELASTICSEARCH_URL/_transform/simple-kibana-ecomm-pivot/_update\""
},
{
"lang": "Java",
"source": "client.transform().updateTransform(u -> u\n .meta(Map.of())\n .description(\"Maximum priced ecommerce data by customer_id in Asia\")\n .dest(d -> d\n .index(\"kibana_sample_data_ecommerce_transform_v2\")\n .pipeline(\"add_timestamp_pipeline\")\n )\n .frequency(f -> f\n .time(\"15m\")\n )\n .source(s -> s\n .index(\"kibana_sample_data_ecommerce\")\n .query(q -> q\n .term(t -> t\n .field(\"geoip.continent_name\")\n .value(FieldValue.of(\"Asia\"))\n )\n )\n .runtimeMappings(Map.of())\n )\n .sync(sy -> sy\n .time(t -> t\n .delay(d -> d\n .time(\"120s\")\n )\n .field(\"order_date\")\n )\n )\n .transformId(\"simple-kibana-ecomm-pivot\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_transform/_upgrade": {
"post": {
"tags": [
"transform"
],
"summary": "Upgrade all transforms",
"description": "Transforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
"operationId": "transform-upgrade-transforms",
"parameters": [
{
"in": "query",
"name": "dry_run",
"description": "When true, the request checks for updates but does not run them.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"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\nreturns an error.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"needs_update": {
"description": "The number of transforms that need to be upgraded.",
"type": "number"
},
"no_action": {
"description": "The number of transforms that don’t require upgrading.",
"type": "number"
},
"updated": {
"description": "The number of transforms that have been upgraded.",
"type": "number"
}
},
"required": [
"needs_update",
"no_action",
"updated"
]
},
"examples": {
"UpgradeTransformResponseExample1": {
"description": "A successful response contains a summary when all transforms are upgraded.",
"value": "{\n \"needs_update\": 0,\n \"updated\": 2,\n \"no_action\": 1\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 7.16.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _transform/_upgrade\n"
},
{
"lang": "Python",
"source": "resp = client.transform.upgrade_transforms()"
},
{
"lang": "JavaScript",
"source": "const response = await client.transform.upgradeTransforms();"
},
{
"lang": "Ruby",
"source": "response = client.transform.upgrade_transforms"
},
{
"lang": "PHP",
"source": "$resp = $client->transform()->upgradeTransforms();"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/_upgrade\""
},
{
"lang": "Java",
"source": "client.transform().upgradeTransforms(u -> u);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/{index}/_update/{id}": {
"post": {
"tags": [
"document"
],
"summary": "Update a document",
"description": "Update a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).\nFor usage examples such as partial updates, upserts, and scripted updates, see the External documentation.\n\n## Required authorization\n\n* Index privileges: `write`\n",
"externalDocs": {
"description": "More about updating a document",
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-document",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update.html"
},
"operationId": "update",
"parameters": [
{
"in": "path",
"name": "index",
"description": "The name of the target index.\nBy default, the index is created automatically if it doesn't exist.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
{
"in": "path",
"name": "id",
"description": "A unique identifier for the document to be updated.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "if_primary_term",
"description": "Only perform the operation if the document has this primary term.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "if_seq_no",
"description": "Only perform the operation if the document has this sequence number.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SequenceNumber"
},
"style": "form"
},
{
"in": "query",
"name": "include_source_on_error",
"description": "True or false if to include the document source in the error message in case of parsing errors.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "lang",
"description": "The script language.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "refresh",
"description": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
{
"in": "query",
"name": "require_alias",
"description": "If `true`, the destination must be an index alias.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "retry_on_conflict",
"description": "The number of times the operation should be retried when a conflict occurs.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "routing",
"description": "A custom value used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period to wait for the following operations: dynamic mapping updates and waiting for active shards.\nElasticsearch waits for at least the timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of copies of each shard that must be active before proceeding with the operation.\nSet to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1).\nThe default value of `1` means it waits for each primary shard to be active.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
{
"in": "query",
"name": "_source",
"description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
},
"style": "form"
},
{
"in": "query",
"name": "_source_excludes",
"description": "The source fields you want to exclude.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
{
"in": "query",
"name": "_source_includes",
"description": "The source fields you want to retrieve.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detect_noop": {
"description": "If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.",
"default": true,
"type": "boolean"
},
"doc": {
"description": "A partial update to an existing document.\nIf both `doc` and `script` are specified, `doc` is ignored.",
"type": "object"
},
"doc_as_upsert": {
"description": "If `true`, use the contents of 'doc' as the value of 'upsert'.\nNOTE: Using ingest pipelines with `doc_as_upsert` is not supported.",
"default": false,
"type": "boolean"
},
"script": {
"description": "The script to run to update the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"scripted_upsert": {
"description": "If `true`, run the script whether or not the document exists.",
"default": false,
"type": "boolean"
},
"_source": {
"description": "If `false`, turn off source retrieval.\nYou can also specify a comma-separated list of the fields you want to retrieve.",
"default": "true",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"upsert": {
"description": "If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.",
"type": "object"
}
}
},
"examples": {
"UpdateRequestExample1": {
"summary": "Update a counter with a script",
"description": "Run `POST test/_update/1` to increment a counter by using a script.",
"value": "{\n \"script\" : {\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\" : {\n \"count\" : 4\n }\n }\n}"
},
"UpdateRequestExample10": {
"summary": "Scripted upsert",
"description": "Run `POST test/_update/1` to perform a scripted upsert. When `scripted_upsert` is `true`, the script runs whether or not the document exists.\n",
"value": "{\n \"scripted_upsert\": true,\n \"script\": {\n \"source\": \"\"\"\n if ( ctx.op == 'create' ) {\n ctx._source.counter = params.count\n } else {\n ctx._source.counter += params.count\n }\n \"\"\",\n \"params\": {\n \"count\": 4\n }\n },\n \"upsert\": {}\n}"
},
"UpdateRequestExample11": {
"summary": "Doc as upsert",
"description": "Run `POST test/_update/1` to perform a doc as upsert. Instead of sending a partial `doc` plus an `upsert` doc, you can set `doc_as_upsert` to `true` to use the contents of `doc` as the `upsert` value.\n",
"value": "{\n \"doc\": {\n \"name\": \"new_name\"\n },\n \"doc_as_upsert\": true\n}"
},
"UpdateRequestExample2": {
"summary": "Add a tag with a script",
"description": "Run `POST test/_update/1` to use a script to add a tag to a list of tags. In this example, it is just a list, so the tag is added even it exists.\n",
"value": "{\n \"script\": {\n \"source\": \"ctx._source.tags.add(params.tag)\",\n \"lang\": \"painless\",\n \"params\": {\n \"tag\": \"blue\"\n }\n }\n}"
},
"UpdateRequestExample3": {
"summary": "Remove a tag with a script",
"description": "Run `POST test/_update/1` to use a script to remove a tag from a list of tags. The Painless function to remove a tag takes the array index of the element you want to remove. To avoid a possible runtime error, you first need to make sure the tag exists. If the list contains duplicates of the tag, this script just removes one occurrence.\n",
"value": "{\n \"script\": {\n \"source\": \"if (ctx._source.tags.contains(params.tag)) { ctx._source.tags.remove(ctx._source.tags.indexOf(params.tag)) }\",\n \"lang\": \"painless\",\n \"params\": {\n \"tag\": \"blue\"\n }\n }\n}"
},
"UpdateRequestExample4": {
"summary": "Add fields with a script",
"description": "Run `POST test/_update/1` to use a script to add a field `new_field` to the document.\n",
"value": "{\n \"script\" : \"ctx._source.new_field = 'value_of_new_field'\"\n}"
},
"UpdateRequestExample5": {
"summary": "Remove fields with a script",
"description": "Run `POST test/_update/1` to use a script to remove a field `new_field` from the document.\n",
"value": "{\n \"script\" : \"ctx._source.remove('new_field')\"\n}"
},
"UpdateRequestExample6": {
"summary": "Remove subfields with a script",
"description": "Run `POST test/_update/1` to use a script to remove a subfield from an object field.\n",
"value": "{\n \"script\": \"ctx._source['my-object'].remove('my-subfield')\"\n}"
},
"UpdateRequestExample7": {
"summary": "Change the operation with a script",
"description": "Run `POST test/_update/1` to change the operation that runs from within the script. For example, this request deletes the document if the `tags` field contains `green`, otherwise it does nothing (`noop`).\n",
"value": "{\n \"script\": {\n \"source\": \"if (ctx._source.tags.contains(params.tag)) { ctx.op = 'delete' } else { ctx.op = 'noop' }\",\n \"lang\": \"painless\",\n \"params\": {\n \"tag\": \"green\"\n }\n }\n}"
},
"UpdateRequestExample8": {
"summary": "Update part of a document",
"description": "Run `POST test/_update/1` to do a partial update that adds a new field to the existing document.\n",
"value": "{\n \"doc\": {\n \"name\": \"new_name\"\n }\n}"
},
"UpdateRequestExample9": {
"summary": "Upsert",
"description": "Run `POST test/_update/1` to perfom an upsert. If the document does not already exist, the contents of the upsert element are inserted as a new document. If the document exists, the script is run.\n",
"value": "{\n \"script\": {\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\": {\n \"count\": 4\n }\n },\n \"upsert\": {\n \"counter\": 1\n }\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_global.update.UpdateWriteResponseBase"
},
"examples": {
"UpdateResponseExample1": {
"summary": "Detect noop updates",
"description": "By default updates that don't change anything detect that they don't change anything and return `\"result\": \"noop\"`.\n",
"value": "{\n \"_shards\": {\n \"total\": 0,\n \"successful\": 0,\n \"failed\": 0\n },\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"_version\": 2,\n \"_primary_term\": 1,\n \"_seq_no\": 1,\n \"result\": \"noop\"\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST test/_update/1\n{\n \"script\" : {\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\" : {\n \"count\" : 4\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.update(\n index=\"test\",\n id=\"1\",\n script={\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\": {\n \"count\": 4\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.update({\n index: \"test\",\n id: 1,\n script: {\n source: \"ctx._source.counter += params.count\",\n lang: \"painless\",\n params: {\n count: 4,\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.update(\n index: \"test\",\n id: \"1\",\n body: {\n \"script\": {\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\": {\n \"count\": 4\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->update([\n \"index\" => \"test\",\n \"id\" => \"1\",\n \"body\" => [\n \"script\" => [\n \"source\" => \"ctx._source.counter += params.count\",\n \"lang\" => \"painless\",\n \"params\" => [\n \"count\" => 4,\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"script\":{\"source\":\"ctx._source.counter += params.count\",\"lang\":\"painless\",\"params\":{\"count\":4}}}' \"$ELASTICSEARCH_URL/test/_update/1\""
},
{
"lang": "Java",
"source": "client.update(u -> u\n .id(\"1\")\n .index(\"test\")\n .routing(List.of())\n .script(s -> s\n .source(so -> so\n .scriptString(\"ctx._source.counter += params.count\")\n )\n .params(\"count\", JsonData.fromJson(\"4\"))\n .lang(\"painless\")\n .options(Map.of())\n )\n,Void.class);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/{index}/_update_by_query": {
"post": {
"tags": [
"document"
],
"summary": "Update documents",
"description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `index` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Refreshing shards**\n\nSpecifying the `refresh` parameter refreshes all shards once the request completes.\nThis is different to the update API's `refresh` parameter, which causes only the shard\nthat received the request to be refreshed. Unlike the update API, it does not support\n`wait_for`.\n\n**Running update by query asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch\nperforms some preflight checks, launches the request, and returns a\n[task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.\n\n**Waiting for active shards**\n\n`wait_for_active_shards` controls how many copies of a shard must be active\nbefore proceeding with the request. See [`wait_for_active_shards`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards)\nfor details. `timeout` controls how long each write request waits for unavailable\nshards to become available. Both work exactly the way they work in the\n[Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk). Update by query uses scrolled searches, so you can also\nspecify the `scroll` parameter to control how long it keeps the search context\nalive, for example `?scroll=10m`. The default is 5 minutes.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to turn off throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is 1000, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with slices will cancel each sub-request.\n* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\nRefer to the linked documentation for examples of how to update documents using the `_update_by_query` API:\n\n## Required authorization\n\n* Index privileges: `read`,`write`\n",
"externalDocs": {
"description": "More about updating by query API",
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-by-query-api",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html"
},
"operationId": "update-by-query",
"parameters": [
{
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
{
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "analyzer",
"description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "analyze_wildcard",
"description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "conflicts",
"description": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.\n\nSupported values include:\n - `abort`: Stop reindexing if there are conflicts.\n - `proceed`: Continue reindexing even if there are conflicts.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Conflicts"
},
"style": "form"
},
{
"in": "query",
"name": "default_operator",
"description": "The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.query_dsl.Operator"
},
"style": "form"
},
{
"in": "query",
"name": "df",
"description": "The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"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": "from",
"description": "Skips the specified number of documents.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "lenient",
"description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "max_docs",
"description": "The maximum number of documents to process.\nIt defaults to all documents.\nWhen set to a value less than or equal to `scroll_size` and `conflicts` is set to `abort`, a scroll will not be used to retrieve the results for the operation.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "pipeline",
"description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "preference",
"description": "The node or shard the operation should be performed on.\nIt is random by default.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "q",
"description": "A query in the Lucene query string syntax.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "refresh",
"description": "If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes.\nThis is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "request_cache",
"description": "If `true`, the request cache is used for this request.\nIt defaults to the index-level setting.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "requests_per_second",
"description": "The maximum number of documents to update per second, across the entire update_by_query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "routing",
"description": "A custom value used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
{
"in": "query",
"name": "scroll",
"description": "The period to retain the search context for scrolling.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "scroll_size",
"description": "The size of the scroll request that powers the operation.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "search_timeout",
"description": "An explicit timeout for each search request.\nBy default, there is no timeout.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "search_type",
"description": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
{
"in": "query",
"name": "slices",
"description": "The number of slices this task should be divided into.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Slices"
},
"style": "form"
},
{
"in": "query",
"name": "sort",
"description": "A comma-separated list of : pairs.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
{
"in": "query",
"name": "stats",
"description": "The specific `tag` of the request for logging and statistical purposes.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
{
"in": "query",
"name": "terminate_after",
"description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
{
"in": "query",
"name": "timeout",
"description": "The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.\nBy default, it is one minute.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
{
"in": "query",
"name": "version",
"description": "If `true`, returns the document version as part of a hit.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "version_type",
"description": "Should the document increment the version number (internal) on hit or not (reindex)",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe `timeout` parameter controls how long each write request waits for unavailable shards to become available.\nBoth work exactly the way they work in the bulk API.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
{
"in": "query",
"name": "wait_for_completion",
"description": "If `true`, the request blocks until the operation is complete.\nIf `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"max_docs": {
"description": "The maximum number of documents to update.",
"type": "number"
},
"query": {
"description": "The documents to update using the Query DSL.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"script": {
"description": "The script to run to update the document source or metadata when updating.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"slice": {
"description": "Slice the request manually using the provided slice ID and total number of slices.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SlicedScroll"
}
]
},
"conflicts": {
"description": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.\n\nSupported values include:\n - `abort`: Stop reindexing if there are conflicts.\n - `proceed`: Continue reindexing even if there are conflicts.\n\n",
"default": "abort",
"allOf": [
{
"$ref": "#/components/schemas/_types.Conflicts"
}
]
}
}
},
"examples": {
"UpdateByQueryRequestExample1": {
"summary": "Update selected documents",
"description": "Run `POST my-index-000001/_update_by_query?conflicts=proceed` to update documents that match a query.\n",
"value": "{\n \"query\": { \n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
},
"UpdateByQueryRequestExample2": {
"summary": "Update the document source",
"description": "Run `POST my-index-000001/_update_by_query` with a script to update the document source. It increments the `count` field for all documents with a `user.id` of `kimchy` in `my-index-000001`.\n",
"value": "{\n \"script\": {\n \"source\": \"ctx._source.count++\",\n \"lang\": \"painless\"\n },\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
},
"UpdateByQueryRequestExample3": {
"summary": "Slice manually",
"description": "Run `POST my-index-000001/_update_by_query` to slice an update by query manually. Provide a slice ID and total number of slices to each request.\n",
"value": "{\n \"slice\": {\n \"id\": 0,\n \"max\": 2\n },\n \"script\": {\n \"source\": \"ctx._source['extra'] = 'test'\"\n }\n}"
},
"UpdateByQueryRequestExample4": {
"summary": "Slice automatically",
"description": "Run `POST my-index-000001/_update_by_query?refresh&slices=5` to use automatic slicing. It automatically parallelizes using sliced scroll to slice on `_id`.\n",
"value": "{\n \"script\": {\n \"source\": \"ctx._source['extra'] = 'test'\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"batches": {
"description": "The number of scroll responses pulled back by the update by query.",
"type": "number"
},
"failures": {
"description": "Array of failures if there were any unrecoverable errors during the process.\nIf this is non-empty then the request ended because of those failures.\nUpdate by query is implemented using batches.\nAny failure causes the entire process to end, but all failures in the current batch are collected into the array.\nYou can use the `conflicts` option to prevent reindex from ending when version conflicts occur.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.BulkIndexByScrollFailure"
}
},
"noops": {
"description": "The number of documents that were ignored because the script used for the update by query returned a noop value for `ctx.op`.",
"type": "number"
},
"deleted": {
"description": "The number of documents that were successfully deleted.",
"type": "number"
},
"requests_per_second": {
"description": "The number of requests per second effectively run during the update by query.",
"type": "number"
},
"retries": {
"description": "The number of retries attempted by update by query.\n`bulk` is the number of bulk actions retried.\n`search` is the number of search actions retried.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Retries"
}
]
},
"slices": {
"description": "Status of each slice if the update by query was sliced",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ReindexStatus"
}
},
"task": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TaskId"
}
]
},
"timed_out": {
"description": "If true, some requests timed out during the update by query.",
"type": "boolean"
},
"took": {
"description": "The number of milliseconds from start to end of the whole operation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total": {
"description": "The number of documents that were successfully processed.",
"type": "number"
},
"updated": {
"description": "The number of documents that were successfully updated.",
"type": "number"
},
"version_conflicts": {
"description": "The number of version conflicts that the update by query hit.",
"type": "number"
},
"throttled": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_millis": {
"description": "The number of milliseconds the request slept to conform to `requests_per_second`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"throttled_until": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_until_millis": {
"description": "This field should always be equal to zero in an _update_by_query response.\nIt only has meaning when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
}
}
}
}
}
},
"x-state": "Generally available; Added in 2.4.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST my-index-000001/_update_by_query?conflicts=proceed\n{\n \"query\": { \n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.update_by_query(\n index=\"my-index-000001\",\n conflicts=\"proceed\",\n query={\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.updateByQuery({\n index: \"my-index-000001\",\n conflicts: \"proceed\",\n query: {\n term: {\n \"user.id\": \"kimchy\",\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.update_by_query(\n index: \"my-index-000001\",\n conflicts: \"proceed\",\n body: {\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->updateByQuery([\n \"index\" => \"my-index-000001\",\n \"conflicts\" => \"proceed\",\n \"body\" => [\n \"query\" => [\n \"term\" => [\n \"user.id\" => \"kimchy\",\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":{\"term\":{\"user.id\":\"kimchy\"}}}' \"$ELASTICSEARCH_URL/my-index-000001/_update_by_query?conflicts=proceed\""
},
{
"lang": "Java",
"source": "client.updateByQuery(u -> u\n .conflicts(Conflicts.Proceed)\n .expandWildcards(List.of())\n .index(\"my-index-000001\")\n .query(q -> q\n .term(t -> t\n .field(\"user.id\")\n .value(FieldValue.of(\"kimchy\"))\n )\n )\n .routing(List.of())\n .sort(List.of())\n .stats(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_update_by_query/{task_id}/_rethrottle": {
"post": {
"tags": [
"document"
],
"summary": "Throttle an update by query operation",
"description": "Change the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.",
"operationId": "update-by-query-rethrottle",
"parameters": [
{
"in": "path",
"name": "task_id",
"description": "The ID for the task.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
{
"in": "query",
"name": "requests_per_second",
"description": "The maximum number of documents to update per second, across the entire update_by_query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.",
"required": true,
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.update_by_query_rethrottle.UpdateByQueryRethrottleNode"
}
}
},
"required": [
"nodes"
]
}
}
}
}
},
"x-state": "Generally available; Added in 6.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _update_by_query/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n"
},
{
"lang": "Python",
"source": "resp = client.update_by_query_rethrottle(\n task_id=\"r1A2WoRbTwKZ516z6NEs5A:36619\",\n requests_per_second=\"-1\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.updateByQueryRethrottle({\n task_id: \"r1A2WoRbTwKZ516z6NEs5A:36619\",\n requests_per_second: \"-1\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.update_by_query_rethrottle(\n task_id: \"r1A2WoRbTwKZ516z6NEs5A:36619\",\n requests_per_second: \"-1\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->updateByQueryRethrottle([\n \"task_id\" => \"r1A2WoRbTwKZ516z6NEs5A:36619\",\n \"requests_per_second\" => \"-1\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_update_by_query/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\""
},
{
"lang": "Java",
"source": "client.updateByQueryRethrottle(u -> u\n .requestsPerSecond(-1.0F)\n .taskId(\"r1A2WoRbTwKZ516z6NEs5A:36619\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/watch/{watch_id}/_ack/{action_id}": {
"post": {
"tags": [
"watcher"
],
"summary": "Acknowledge a watch\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_watcher/watch/{watch_id}/_ack\n
\n \n POST\n /_watcher/watch/{watch_id}/_ack\n
\n \n PUT\n /_watcher/watch/{watch_id}/_ack/{action_id}\n
\n \n POST\n /_watcher/watch/{watch_id}/_ack/{action_id}\n
\n \n\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\nTo demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"externalDocs": {
"description": "Learn more about actions",
"url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/actions#example",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-ack-watch.html"
},
"operationId": "watcher-ack-watch",
"parameters": [
{
"$ref": "#/components/parameters/watcher.ack_watch-watch_id"
},
{
"$ref": "#/components/parameters/watcher.ack_watch-action_id"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/watcher.ack_watch-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _watcher/watch/my_watch/_ack\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.ack_watch(\n watch_id=\"my_watch\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.ackWatch({\n watch_id: \"my_watch\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.watcher.ack_watch(\n watch_id: \"my_watch\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->ackWatch([\n \"watch_id\" => \"my_watch\",\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/watch/my_watch/_ack\""
},
{
"lang": "Java",
"source": "client.watcher().ackWatch(a -> a\n .actionId(List.of())\n .watchId(\"my_watch\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/watch/{watch_id}/_activate": {
"post": {
"tags": [
"watcher"
],
"summary": "Activate a watch\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_watcher/watch/{watch_id}/_activate\n
\n \n POST\n /_watcher/watch/{watch_id}/_activate\n
\n \n\nA watch can be either active or inactive.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"externalDocs": {
"description": "More about how Watcher works",
"url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-activate-watch.html"
},
"operationId": "watcher-activate-watch",
"parameters": [
{
"$ref": "#/components/parameters/watcher.activate_watch-watch_id"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/watcher.activate_watch-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT _watcher/watch/my_watch/_activate\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.activate_watch(\n watch_id=\"my_watch\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.activateWatch({\n watch_id: \"my_watch\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.watcher.activate_watch(\n watch_id: \"my_watch\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->activateWatch([\n \"watch_id\" => \"my_watch\",\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/watch/my_watch/_activate\""
},
{
"lang": "Java",
"source": "client.watcher().activateWatch(a -> a\n .watchId(\"my_watch\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/watch/{watch_id}/_deactivate": {
"post": {
"tags": [
"watcher"
],
"summary": "Deactivate a watch\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_watcher/watch/{watch_id}/_deactivate\n
\n \n POST\n /_watcher/watch/{watch_id}/_deactivate\n
\n \n\nA watch can be either active or inactive.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"externalDocs": {
"description": "More about how Watcher works",
"url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-deactivate-watch.html"
},
"operationId": "watcher-deactivate-watch",
"parameters": [
{
"$ref": "#/components/parameters/watcher.deactivate_watch-watch_id"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/watcher.deactivate_watch-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT _watcher/watch/my_watch/_deactivate\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.deactivate_watch(\n watch_id=\"my_watch\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.deactivateWatch({\n watch_id: \"my_watch\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.watcher.deactivate_watch(\n watch_id: \"my_watch\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->deactivateWatch([\n \"watch_id\" => \"my_watch\",\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/watch/my_watch/_deactivate\""
},
{
"lang": "Java",
"source": "client.watcher().deactivateWatch(d -> d\n .watchId(\"my_watch\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/watch/{id}": {
"get": {
"tags": [
"watcher"
],
"summary": "Get a watch",
"description": "\n\n## Required authorization\n\n* Cluster privileges: `monitor_watcher`\n",
"operationId": "watcher-get-watch",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The watch identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"found": {
"type": "boolean"
},
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.WatchStatus"
}
]
},
"watch": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.Watch"
}
]
},
"_primary_term": {
"type": "number"
},
"_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"found",
"_id"
]
},
"examples": {
"GetWatchResponseExample1": {
"description": "A successful response from `GET _watcher/watch/my_watch`.",
"value": "{\n \"found\": true,\n \"_id\": \"my_watch\",\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"_version\": 1,\n \"status\": { \n \"version\": 1,\n \"state\": {\n \"active\": true,\n \"timestamp\": \"2015-05-26T18:21:08.630Z\"\n },\n \"actions\": {\n \"test_index\": {\n \"ack\": {\n \"timestamp\": \"2015-05-26T18:21:08.630Z\",\n \"state\": \"awaits_successful_execution\"\n }\n }\n }\n },\n \"watch\": {\n \"input\": {\n \"simple\": {\n \"payload\": {\n \"send\": \"yes\"\n }\n }\n },\n \"condition\": {\n \"always\": {}\n },\n \"trigger\": {\n \"schedule\": {\n \"hourly\": {\n \"minute\": [0, 5]\n }\n }\n },\n \"actions\": {\n \"test_index\": {\n \"index\": {\n \"index\": \"test\"\n }\n }\n }\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available; Added in 5.6.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _watcher/watch/my_watch\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.get_watch(\n id=\"my_watch\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.getWatch({\n id: \"my_watch\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.watcher.get_watch(\n id: \"my_watch\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->getWatch([\n \"id\" => \"my_watch\",\n]);"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/watch/my_watch\""
},
{
"lang": "Java",
"source": "client.watcher().getWatch(g -> g\n .id(\"my_watch\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"post": {
"tags": [
"watcher"
],
"summary": "Create or update a watch\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_watcher/watch/{id}\n
\n \n POST\n /_watcher/watch/{id}\n
\n \n\nWhen a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine.\nTypically for the `schedule` trigger, the scheduler is the trigger engine.\n\nIMPORTANT: You must use Kibana or this API to create a watch.\nDo not add a watch directly to the `.watches` index by using the Elasticsearch index API.\nIf Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index.\n\nWhen you add a watch you can also define its initial active state by setting the *active* parameter.\n\nWhen Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges.\nIf the user is able to read index `a`, but not index `b`, the same will apply when the watch runs.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"operationId": "watcher-put-watch",
"parameters": [
{
"$ref": "#/components/parameters/watcher.put_watch-id"
},
{
"$ref": "#/components/parameters/watcher.put_watch-active"
},
{
"$ref": "#/components/parameters/watcher.put_watch-if_primary_term"
},
{
"$ref": "#/components/parameters/watcher.put_watch-if_seq_no"
},
{
"$ref": "#/components/parameters/watcher.put_watch-version"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/watcher.put_watch"
},
"responses": {
"200": {
"$ref": "#/components/responses/watcher.put_watch-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT _watcher/watch/my-watch\n{\n \"trigger\" : {\n \"schedule\" : { \"cron\" : \"0 0/1 * * * ?\" }\n },\n \"input\" : {\n \"search\" : {\n \"request\" : {\n \"indices\" : [\n \"logstash*\"\n ],\n \"body\" : {\n \"query\" : {\n \"bool\" : {\n \"must\" : {\n \"match\": {\n \"response\": 404\n }\n },\n \"filter\" : {\n \"range\": {\n \"@timestamp\": {\n \"from\": \"{{ctx.trigger.scheduled_time}}||-5m\",\n \"to\": \"{{ctx.trigger.triggered_time}}\"\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"condition\" : {\n \"compare\" : { \"ctx.payload.hits.total\" : { \"gt\" : 0 }}\n },\n \"actions\" : {\n \"email_admin\" : {\n \"email\" : {\n \"to\" : \"admin@domain.host.com\",\n \"subject\" : \"404 recently encountered\"\n }\n }\n }\n}"
},
{
"lang": "Python",
"source": "resp = client.watcher.put_watch(\n id=\"my-watch\",\n trigger={\n \"schedule\": {\n \"cron\": \"0 0/1 * * * ?\"\n }\n },\n input={\n \"search\": {\n \"request\": {\n \"indices\": [\n \"logstash*\"\n ],\n \"body\": {\n \"query\": {\n \"bool\": {\n \"must\": {\n \"match\": {\n \"response\": 404\n }\n },\n \"filter\": {\n \"range\": {\n \"@timestamp\": {\n \"from\": \"{{ctx.trigger.scheduled_time}}||-5m\",\n \"to\": \"{{ctx.trigger.triggered_time}}\"\n }\n }\n }\n }\n }\n }\n }\n }\n },\n condition={\n \"compare\": {\n \"ctx.payload.hits.total\": {\n \"gt\": 0\n }\n }\n },\n actions={\n \"email_admin\": {\n \"email\": {\n \"to\": \"admin@domain.host.com\",\n \"subject\": \"404 recently encountered\"\n }\n }\n },\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.putWatch({\n id: \"my-watch\",\n trigger: {\n schedule: {\n cron: \"0 0/1 * * * ?\",\n },\n },\n input: {\n search: {\n request: {\n indices: [\"logstash*\"],\n body: {\n query: {\n bool: {\n must: {\n match: {\n response: 404,\n },\n },\n filter: {\n range: {\n \"@timestamp\": {\n from: \"{{ctx.trigger.scheduled_time}}||-5m\",\n to: \"{{ctx.trigger.triggered_time}}\",\n },\n },\n },\n },\n },\n },\n },\n },\n },\n condition: {\n compare: {\n \"ctx.payload.hits.total\": {\n gt: 0,\n },\n },\n },\n actions: {\n email_admin: {\n email: {\n to: \"admin@domain.host.com\",\n subject: \"404 recently encountered\",\n },\n },\n },\n});"
},
{
"lang": "Ruby",
"source": "response = client.watcher.put_watch(\n id: \"my-watch\",\n body: {\n \"trigger\": {\n \"schedule\": {\n \"cron\": \"0 0/1 * * * ?\"\n }\n },\n \"input\": {\n \"search\": {\n \"request\": {\n \"indices\": [\n \"logstash*\"\n ],\n \"body\": {\n \"query\": {\n \"bool\": {\n \"must\": {\n \"match\": {\n \"response\": 404\n }\n },\n \"filter\": {\n \"range\": {\n \"@timestamp\": {\n \"from\": \"{{ctx.trigger.scheduled_time}}||-5m\",\n \"to\": \"{{ctx.trigger.triggered_time}}\"\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"condition\": {\n \"compare\": {\n \"ctx.payload.hits.total\": {\n \"gt\": 0\n }\n }\n },\n \"actions\": {\n \"email_admin\": {\n \"email\": {\n \"to\": \"admin@domain.host.com\",\n \"subject\": \"404 recently encountered\"\n }\n }\n }\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->putWatch([\n \"id\" => \"my-watch\",\n \"body\" => [\n \"trigger\" => [\n \"schedule\" => [\n \"cron\" => \"0 0/1 * * * ?\",\n ],\n ],\n \"input\" => [\n \"search\" => [\n \"request\" => [\n \"indices\" => array(\n \"logstash*\",\n ),\n \"body\" => [\n \"query\" => [\n \"bool\" => [\n \"must\" => [\n \"match\" => [\n \"response\" => 404,\n ],\n ],\n \"filter\" => [\n \"range\" => [\n \"@timestamp\" => [\n \"from\" => \"{{ctx.trigger.scheduled_time}}||-5m\",\n \"to\" => \"{{ctx.trigger.triggered_time}}\",\n ],\n ],\n ],\n ],\n ],\n ],\n ],\n ],\n ],\n \"condition\" => [\n \"compare\" => [\n \"ctx.payload.hits.total\" => [\n \"gt\" => 0,\n ],\n ],\n ],\n \"actions\" => [\n \"email_admin\" => [\n \"email\" => [\n \"to\" => \"admin@domain.host.com\",\n \"subject\" => \"404 recently encountered\",\n ],\n ],\n ],\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"trigger\":{\"schedule\":{\"cron\":\"0 0/1 * * * ?\"}},\"input\":{\"search\":{\"request\":{\"indices\":[\"logstash*\"],\"body\":{\"query\":{\"bool\":{\"must\":{\"match\":{\"response\":404}},\"filter\":{\"range\":{\"@timestamp\":{\"from\":\"{{ctx.trigger.scheduled_time}}||-5m\",\"to\":\"{{ctx.trigger.triggered_time}}\"}}}}}}}}},\"condition\":{\"compare\":{\"ctx.payload.hits.total\":{\"gt\":0}}},\"actions\":{\"email_admin\":{\"email\":{\"to\":\"admin@domain.host.com\",\"subject\":\"404 recently encountered\"}}}}' \"$ELASTICSEARCH_URL/_watcher/watch/my-watch\""
},
{
"lang": "Java",
"source": "client.watcher().putWatch(p -> p\n .actions(\"email_admin\", a -> a\n .email(e -> e\n .bcc(List.of())\n .cc(List.of())\n .replyTo(List.of())\n .subject(\"404 recently encountered\")\n .to(\"admin@domain.host.com\")\n .attachments(Map.of())\n )\n )\n .condition(c -> c\n .compare(NamedValue.of(\"ctx.payload.hits.total\",Pair.of(ConditionOp.Gt,FieldValue.of(0))))\n )\n .id(\"my-watch\")\n .input(i -> i\n .search(s -> s\n .extract(List.of())\n .request(r -> r\n .body(b -> b\n .query(q -> q\n .bool(bo -> bo\n .filter(f -> f\n .range(ra -> ra\n .untyped(u -> u\n .field(\"@timestamp\")\n )\n )\n )\n .must(m -> m\n .match(ma -> ma\n .field(\"response\")\n .query(FieldValue.of(404))\n )\n )\n .mustNot(List.of())\n .should(List.of())\n )\n )\n )\n .indices(\"logstash*\")\n )\n )\n )\n .metadata(Map.of())\n .trigger(t -> t\n .schedule(sc -> sc\n .cron(\"0 0/1 * * * ?\")\n )\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"delete": {
"tags": [
"watcher"
],
"summary": "Delete a watch",
"description": "When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again.\n\nDeleting a watch does not delete any watch execution records related to this watch from the watch history.\n\nIMPORTANT: Deleting a watch must be done by using only this API.\nDo not delete the watch directly from the `.watches` index using the Elasticsearch delete document API\nWhen Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"operationId": "watcher-delete-watch",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The watch identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"found": {
"type": "boolean"
},
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"found",
"_id",
"_version"
]
},
"examples": {
"DeleteWatchResponseExample1": {
"description": "A successful response from `DELETE _watcher/watch/my_watch`.",
"value": "{\n \"found\": true,\n \"_id\": \"my_watch\",\n \"_version\": 2\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "DELETE _watcher/watch/my_watch\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.delete_watch(\n id=\"my_watch\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.deleteWatch({\n id: \"my_watch\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.watcher.delete_watch(\n id: \"my_watch\"\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->deleteWatch([\n \"id\" => \"my_watch\",\n]);"
},
{
"lang": "curl",
"source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/watch/my_watch\""
},
{
"lang": "Java",
"source": "client.watcher().deleteWatch(d -> d\n .id(\"my_watch\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/watch/{id}/_execute": {
"post": {
"tags": [
"watcher"
],
"summary": "Run a watch\n",
"description": "**All methods and paths for this operation:**\n\n\n PUT\n /_watcher/watch/_execute\n
\n \n POST\n /_watcher/watch/_execute\n
\n \n PUT\n /_watcher/watch/{id}/_execute\n
\n \n POST\n /_watcher/watch/{id}/_execute\n
\n \n\nThis API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.\n\nFor testing and debugging purposes, you also have fine-grained control on how the watch runs.\nYou can run the watch without running all of its actions or alternatively by simulating them.\nYou can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.\n\nYou can use the run watch API to run watches that are not yet registered by specifying the watch definition inline.\nThis serves as great tool for testing and debugging your watches prior to adding them to Watcher.\n\nWhen Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches.\nIf your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch.\n\nWhen using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.\nRefer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"externalDocs": {
"description": "More about executing a watch",
"url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/execute-watch",
"x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-execute-watch.html"
},
"operationId": "watcher-execute-watch",
"parameters": [
{
"$ref": "#/components/parameters/watcher.execute_watch-id"
},
{
"$ref": "#/components/parameters/watcher.execute_watch-debug"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/watcher.execute_watch"
},
"responses": {
"200": {
"$ref": "#/components/responses/watcher.execute_watch-200"
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _watcher/watch/my_watch/_execute\n{\n \"trigger_data\" : { \n \"triggered_time\" : \"now\",\n \"scheduled_time\" : \"now\"\n },\n \"alternative_input\" : { \n \"foo\" : \"bar\"\n },\n \"ignore_condition\" : true, \n \"action_modes\" : {\n \"my-action\" : \"force_simulate\" \n },\n \"record_execution\" : true \n}"
},
{
"lang": "Python",
"source": "resp = client.watcher.execute_watch(\n id=\"my_watch\",\n trigger_data={\n \"triggered_time\": \"now\",\n \"scheduled_time\": \"now\"\n },\n alternative_input={\n \"foo\": \"bar\"\n },\n ignore_condition=True,\n action_modes={\n \"my-action\": \"force_simulate\"\n },\n record_execution=True,\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.executeWatch({\n id: \"my_watch\",\n trigger_data: {\n triggered_time: \"now\",\n scheduled_time: \"now\",\n },\n alternative_input: {\n foo: \"bar\",\n },\n ignore_condition: true,\n action_modes: {\n \"my-action\": \"force_simulate\",\n },\n record_execution: true,\n});"
},
{
"lang": "Ruby",
"source": "response = client.watcher.execute_watch(\n id: \"my_watch\",\n body: {\n \"trigger_data\": {\n \"triggered_time\": \"now\",\n \"scheduled_time\": \"now\"\n },\n \"alternative_input\": {\n \"foo\": \"bar\"\n },\n \"ignore_condition\": true,\n \"action_modes\": {\n \"my-action\": \"force_simulate\"\n },\n \"record_execution\": true\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->executeWatch([\n \"id\" => \"my_watch\",\n \"body\" => [\n \"trigger_data\" => [\n \"triggered_time\" => \"now\",\n \"scheduled_time\" => \"now\",\n ],\n \"alternative_input\" => [\n \"foo\" => \"bar\",\n ],\n \"ignore_condition\" => true,\n \"action_modes\" => [\n \"my-action\" => \"force_simulate\",\n ],\n \"record_execution\" => true,\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"trigger_data\":{\"triggered_time\":\"now\",\"scheduled_time\":\"now\"},\"alternative_input\":{\"foo\":\"bar\"},\"ignore_condition\":true,\"action_modes\":{\"my-action\":\"force_simulate\"},\"record_execution\":true}' \"$ELASTICSEARCH_URL/_watcher/watch/my_watch/_execute\""
},
{
"lang": "Java",
"source": "client.watcher().executeWatch(e -> e\n .actionModes(\"my-action\", ActionExecutionMode.ForceSimulate)\n .alternativeInput(\"foo\", JsonData.fromJson(\"\\\"bar\\\"\"))\n .id(\"my_watch\")\n .ignoreCondition(true)\n .recordExecution(true)\n .triggerData(t -> t\n .scheduledTime(DateTime.of(\"now\"))\n .triggeredTime(DateTime.of(\"now\"))\n )\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/settings": {
"get": {
"tags": [
"watcher"
],
"summary": "Get Watcher index settings",
"description": "Get settings for the Watcher internal index (`.watches`).\nOnly a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.",
"operationId": "watcher-get-settings",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
}
},
"required": [
"index"
]
},
"examples": {
"WatcherGetSettingsResponseExample1": {
"description": "A successful response with two index settings.",
"value": "{\n \"index\": {\n \"auto_expand_replicas\": \"0-4\",\n \"number_of_replicas\": 0\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_watcher/settings\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.get_settings()"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.getSettings();"
},
{
"lang": "Ruby",
"source": "response = client.watcher.get_settings"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->getSettings();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/settings\""
},
{
"lang": "Java",
"source": "client.watcher().getSettings(g -> g);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
},
"put": {
"tags": [
"watcher"
],
"summary": "Update Watcher index settings",
"description": "Update settings for the Watcher internal index (`.watches`).\nOnly a subset of settings can be modified.\nThis includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`,\n`index.routing.allocation.include.*` and `index.routing.allocation.require.*`.\nModification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the\nWatcher shards must always be in the `data_content` tier.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"operationId": "watcher-update-settings",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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": "timeout",
"description": "The period to wait for a response.\nIf 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"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index.auto_expand_replicas": {
"type": "string"
},
"index.number_of_replicas": {
"type": "number"
}
}
},
"examples": {
"WatcherUpdateSettingsRequestExample1": {
"value": "{\n \"index.auto_expand_replicas\": \"0-4\"\n}"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledged": {
"type": "boolean"
}
},
"required": [
"acknowledged"
]
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "PUT /_watcher/settings\n{\n \"index.auto_expand_replicas\": \"0-4\"\n}"
},
{
"lang": "Python",
"source": "resp = client.watcher.update_settings(\n index.auto_expand_replicas=\"0-4\",\n)"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.updateSettings({\n \"index.auto_expand_replicas\": \"0-4\",\n});"
},
{
"lang": "Ruby",
"source": "response = client.watcher.update_settings(\n body: {\n \"index.auto_expand_replicas\": \"0-4\"\n }\n)"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->updateSettings([\n \"body\" => [\n \"index.auto_expand_replicas\" => \"0-4\",\n ],\n]);"
},
{
"lang": "curl",
"source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"index.auto_expand_replicas\":\"0-4\"}' \"$ELASTICSEARCH_URL/_watcher/settings\""
},
{
"lang": "Java",
"source": "client.watcher().updateSettings(u -> u\n .indexAutoExpandReplicas(\"0-4\")\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/_query/watches": {
"post": {
"tags": [
"watcher"
],
"summary": "Query watches\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_watcher/_query/watches\n
\n \n POST\n /_watcher/_query/watches\n
\n \n\nGet all registered watches in a paginated manner and optionally filter watches by a query.\n\nNote that only the `_id` and `metadata.*` fields are queryable or sortable.\n\n## Required authorization\n\n* Cluster privileges: `monitor_watcher`\n",
"operationId": "watcher-query-watches",
"requestBody": {
"$ref": "#/components/requestBodies/watcher.query_watches"
},
"responses": {
"200": {
"$ref": "#/components/responses/watcher.query_watches-200"
}
},
"x-state": "Generally available; Added in 7.11.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_watcher/_query/watches\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.query_watches()"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.queryWatches();"
},
{
"lang": "Ruby",
"source": "response = client.watcher.query_watches"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->queryWatches();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/_query/watches\""
},
{
"lang": "Java",
"source": "client.watcher().queryWatches(q -> q\n .searchAfter(List.of())\n .sort(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/_start": {
"post": {
"tags": [
"watcher"
],
"summary": "Start the watch service",
"description": "Start the Watcher service if it is not already running.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"operationId": "watcher-start",
"parameters": [
{
"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": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"WatcherStartResponseExample1": {
"description": "A successful response from `POST _watcher/_start`.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _watcher/_start\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.start()"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.start();"
},
{
"lang": "Ruby",
"source": "response = client.watcher.start"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->start();"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/_start\""
},
{
"lang": "Java",
"source": "client.watcher().start(s -> s);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/stats/{metric}": {
"get": {
"tags": [
"watcher"
],
"summary": "Get Watcher statistics\n",
"description": "**All methods and paths for this operation:**\n\n\n GET\n /_watcher/stats\n
\n \n GET\n /_watcher/stats/{metric}\n
\n \n\nThis API always returns basic metrics.\nYou retrieve more metrics by using the metric parameter.\n\n## Required authorization\n\n* Cluster privileges: `monitor_watcher`\n",
"operationId": "watcher-stats",
"parameters": [
{
"$ref": "#/components/parameters/watcher.stats-metric"
},
{
"$ref": "#/components/parameters/watcher.stats-emit_stacktraces"
},
{
"$ref": "#/components/parameters/watcher.stats-metric_"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/watcher.stats-200"
}
},
"x-state": "Generally available; Added in 5.5.0",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET _watcher/stats\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.stats()"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.stats();"
},
{
"lang": "Ruby",
"source": "response = client.watcher.stats"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->stats();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/stats\""
},
{
"lang": "Java",
"source": "client.watcher().stats(s -> s\n .metric(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_watcher/_stop": {
"post": {
"tags": [
"watcher"
],
"summary": "Stop the watch service",
"description": "Stop the Watcher service if it is running.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n",
"operationId": "watcher-stop",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"WatcherStopResponseExample1": {
"description": "A successful response from `POST _watcher/_stop`.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "POST _watcher/_stop\n"
},
{
"lang": "Python",
"source": "resp = client.watcher.stop()"
},
{
"lang": "JavaScript",
"source": "const response = await client.watcher.stop();"
},
{
"lang": "Ruby",
"source": "response = client.watcher.stop"
},
{
"lang": "PHP",
"source": "$resp = $client->watcher()->stop();"
},
{
"lang": "curl",
"source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_watcher/_stop\""
},
{
"lang": "Java",
"source": "client.watcher().stop(s -> s);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_xpack": {
"get": {
"tags": [
"xpack"
],
"summary": "Get information",
"description": "The information provided by the API includes:\n\n* Build information including the build number and timestamp.\n* License information about the currently installed license.\n* Feature information for the features that are currently enabled and available under the current license.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
"operationId": "xpack-info",
"parameters": [
{
"in": "query",
"name": "categories",
"description": "A comma-separated list of the information categories to include in the response.\nFor example, `build,license,features`.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/xpack.info.XPackCategory"
}
},
"style": "form"
},
{
"in": "query",
"name": "accept_enterprise",
"description": "If used, this otherwise ignored parameter must be set to true",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "human",
"description": "Defines whether additional human-readable information is included in the response.\nIn particular, it adds descriptions and a tag line.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"build": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.BuildInformation"
}
]
},
"features": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Features"
}
]
},
"license": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.MinimalLicenseInformation"
}
]
},
"tagline": {
"type": "string"
}
},
"required": [
"build",
"features",
"license",
"tagline"
]
},
"examples": {
"XPackInfoResponseExample1": {
"description": "A successful response from `GET /_xpack`.",
"value": "{\n \"build\" : {\n \"hash\" : \"2798b1a3ce779b3611bb53a0082d4d741e4d3168\",\n \"date\" : \"2015-04-07T13:34:42Z\"\n },\n \"license\" : {\n \"uid\" : \"893361dc-9749-4997-93cb-xxx\",\n \"type\" : \"trial\",\n \"mode\" : \"trial\",\n \"status\" : \"active\",\n \"expiry_date_in_millis\" : 1542665112332\n },\n \"features\" : {\n \"ccr\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"aggregate_metric\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"analytics\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"archive\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"enrich\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"graph\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ilm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"logstash\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ml\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"esql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"monitoring\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"rollup\": {\n \"available\": true,\n \"enabled\": true\n },\n \"searchable_snapshots\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"security\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"slm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"spatial\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"eql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"sql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"transform\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"voting_only\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"watcher\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"data_streams\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"data_tiers\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"enterprise_search\": {\n \"available\": true,\n \"enabled\": true\n },\n \"universal_profiling\": {\n \"available\": true,\n \"enabled\": true\n },\n \"logsdb\": {\n \"available\": true,\n \"enabled\": false\n }\n },\n \"tagline\" : \"You know, for X\"\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_xpack\n"
},
{
"lang": "Python",
"source": "resp = client.xpack.info()"
},
{
"lang": "JavaScript",
"source": "const response = await client.xpack.info();"
},
{
"lang": "Ruby",
"source": "response = client.xpack.info"
},
{
"lang": "PHP",
"source": "$resp = $client->xpack()->info();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_xpack\""
},
{
"lang": "Java",
"source": "client.xpack().info(i -> i\n .categories(List.of())\n);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
},
"/_xpack/usage": {
"get": {
"tags": [
"xpack"
],
"summary": "Get usage information",
"description": "Get information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
"operationId": "xpack-usage",
"parameters": [
{
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregate_metric": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"analytics": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Analytics"
}
]
},
"archive": {
"x-state": "Generally available; Added in 8.2.0",
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Archive"
}
]
},
"watcher": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Watcher"
}
]
},
"ccr": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Ccr"
}
]
},
"data_frame": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"data_science": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"data_streams": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.DataStreams"
}
]
},
"data_tiers": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.DataTiers"
}
]
},
"enrich": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"eql": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Eql"
}
]
},
"flattened": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Flattened"
}
]
},
"graph": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"gpu_vector_indexing": {
"x-state": "Generally available; Added in 9.3.2",
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.GpuVectorIndexing"
}
]
},
"health_api": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.HealthStatistics"
}
]
},
"ilm": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Ilm"
}
]
},
"logstash": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"ml": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MachineLearning"
}
]
},
"monitoring": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Monitoring"
}
]
},
"rollup": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"runtime_fields": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.RuntimeFieldTypes"
}
]
},
"spatial": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"searchable_snapshots": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.SearchableSnapshots"
}
]
},
"security": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Security"
}
]
},
"slm": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Slm"
}
]
},
"sql": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Sql"
}
]
},
"transform": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
},
"vectors": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Vector"
}
]
},
"voting_only": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
}
},
"required": [
"aggregate_metric",
"analytics",
"archive",
"watcher",
"ccr",
"data_tiers",
"eql",
"graph",
"ilm",
"logstash",
"ml",
"monitoring",
"rollup",
"spatial",
"searchable_snapshots",
"security",
"slm",
"sql",
"transform",
"voting_only"
]
},
"examples": {
"XPackUsageResponseExample1": {
"description": "An abbreviated response from `GET /_xpack/usage`.",
"value": "{\n \"security\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"monitoring\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"collection_enabled\" : false,\n \"enabled_exporters\" : {\n \"local\" : 1\n }\n },\n \"watcher\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"execution\" : {\n \"actions\" : {\n \"_all\" : {\n \"total\" : 0,\n \"total_time_in_ms\" : 0\n }\n }\n },\n \"watch\" : {\n \"input\" : {\n \"_all\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n },\n \"trigger\" : {\n \"_all\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n }\n },\n \"count\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n },\n \"graph\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ml\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"jobs\" : {\n \"_all\" : {\n \"count\" : 0,\n \"detectors\" : { },\n \"created_by\" : { },\n \"model_size\" : { },\n \"forecasts\" : {\n \"total\" : 0,\n \"forecasted_jobs\" : 0\n }\n }\n },\n \"datafeeds\" : {\n \"_all\" : {\n \"count\" : 0\n }\n },\n \"data_frame_analytics_jobs\" : {\n \"_all\" : {\n \"count\" : 0\n },\n \"analysis_counts\": { },\n \"memory_usage\": {\n \"peak_usage_bytes\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n }\n }\n },\n \"inference\" : {\n \"ingest_processors\" : {\n \"_all\" : {\n \"num_docs_processed\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n },\n \"pipelines\" : {\n \"count\" : 0\n },\n \"num_failures\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n },\n \"time_ms\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n }\n }\n },\n \"trained_models\" : {\n \"_all\" : {\n \"count\": 1\n },\n \"count\": {\n \"total\": 1,\n \"prepackaged\": 1,\n \"other\": 0\n },\n \"model_size_bytes\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n },\n \"estimated_operations\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n }\n },\n \"deployments\": {\n \"count\": 0,\n \"inference_counts\": {\n \"total\": 0.0,\n \"min\": 0.0,\n \"avg\": 0.0,\n \"max\": 0.0\n },\n \"stats_by_model\": [],\n \"model_sizes_bytes\": {\n \"total\": 0.0,\n \"min\": 0.0,\n \"avg\": 0.0,\n \"max\": 0.0\n },\n \"time_ms\": {\n \"avg\": 0.0\n }\n }\n },\n \"node_count\" : 1,\n \"memory\": {\n anomaly_detectors_memory_bytes: 0,\n data_frame_analytics_memory_bytes: 0,\n pytorch_inference_memory_bytes: 0,\n total_used_memory_bytes: 0\n }\n },\n \"inference\": {\n \"available\" : true,\n \"enabled\" : true,\n \"models\" : [ ]\n },\n \"logstash\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"eql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"esql\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"features\" : {\n \"eval\" : 0,\n \"stats\" : 0,\n \"dissect\": 0,\n \"grok\" : 0,\n \"limit\" : 0,\n \"where\" : 0,\n \"sort\" : 0,\n \"drop\" : 0,\n \"show\" : 0,\n \"rename\" : 0,\n \"mv_expand\" : 0,\n \"keep\" : 0,\n \"enrich\" : 0,\n \"from\" : 0,\n \"row\" : 0\n },\n \"queries\" : {\n \"rest\" : {\n \"total\" : 0,\n \"failed\" : 0\n },\n \"kibana\" : {\n \"total\" : 0,\n \"failed\" : 0\n },\n \"_all\" : {\n \"total\" : 0,\n \"failed\" : 0\n }\n }\n },\n \"sql\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"features\" : {\n \"having\" : 0,\n \"subselect\" : 0,\n \"limit\" : 0,\n \"orderby\" : 0,\n \"where\" : 0,\n \"join\" : 0,\n \"groupby\" : 0,\n \"command\" : 0,\n \"local\" : 0\n },\n \"queries\" : {\n \"rest\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"cli\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"canvas\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"jdbc\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc32\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc64\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"_all\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"translate\" : {\n \"count\" : 0\n }\n }\n },\n \"rollup\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ilm\" : {\n \"policy_count\" : 3,\n \"policy_stats\" : [ ]\n },\n \"slm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ccr\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"follower_indices_count\" : 0,\n \"auto_follow_patterns_count\" : 0\n },\n \"transform\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"voting_only\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"searchable_snapshots\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"indices_count\" : 0,\n \"full_copy_indices_count\" : 0,\n \"shared_cache_indices_count\" : 0\n },\n \"spatial\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"analytics\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"stats\": {\n \"boxplot_usage\" : 0,\n \"top_metrics_usage\" : 0,\n \"normalize_usage\" : 0,\n \"cumulative_cardinality_usage\" : 0,\n \"t_test_usage\" : 0,\n \"rate_usage\" : 0,\n \"string_stats_usage\" : 0,\n \"moving_percentiles_usage\" : 0,\n \"multi_terms_usage\" : 0\n }\n },\n \"data_streams\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"data_streams\" : 0,\n \"indices_count\" : 0\n },\n \"data_lifecycle\" : {\n \"available\": true,\n \"enabled\": true,\n \"count\": 0,\n \"default_rollover_used\": true,\n \"data_retention\": {\n \"configured_data_streams\": 0\n },\n \"effective_retention\": {\n \"retained_data_streams\": 0\n },\n \"global_retention\": {\n \"default\": {\n \"defined\": false\n },\n \"max\": {\n \"defined\": false\n }\n }\n },\n \"data_tiers\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"data_warm\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_frozen\" : {\n \"node_count\" : 1,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_cold\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_content\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_hot\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n }\n },\n \"aggregate_metric\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"archive\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"indices_count\" : 0\n },\n \"health_api\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"invocations\": {\n \"total\": 0\n }\n },\n \"remote_clusters\": {\n \"size\": 0,\n \"mode\": {\n \"proxy\": 0,\n \"sniff\": 0\n },\n \"security\": {\n \"cert\": 0,\n \"api_key\": 0\n }\n },\n \"enterprise_search\" : {\n \"available\": true,\n \"enabled\": true,\n \"search_applications\" : {\n \"count\": 0\n },\n \"analytics_collections\": {\n \"count\": 0\n },\n \"query_rulesets\": {\n \"total_rule_count\": 0,\n \"total_count\": 0,\n \"min_rule_count\": 0,\n \"max_rule_count\": 0\n }\n },\n \"universal_profiling\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"logsdb\": {\n \"available\": true,\n \"enabled\": false,\n \"indices_count\": 0,\n \"indices_with_synthetic_source\": 0,\n \"num_docs\": 0,\n \"size_in_bytes\": 0,\n \"has_custom_cutoff_date\": false\n }\n}"
}
}
}
}
}
},
"x-state": "Generally available",
"x-codeSamples": [
{
"lang": "Console",
"source": "GET /_xpack/usage\n"
},
{
"lang": "Python",
"source": "resp = client.xpack.usage()"
},
{
"lang": "JavaScript",
"source": "const response = await client.xpack.usage();"
},
{
"lang": "Ruby",
"source": "response = client.xpack.usage"
},
{
"lang": "PHP",
"source": "$resp = $client->xpack()->usage();"
},
{
"lang": "curl",
"source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_xpack/usage\""
},
{
"lang": "Java",
"source": "client.xpack().usage(u -> u);\n"
}
],
"x-metaTags": [
{
"content": "Elasticsearch",
"name": "product_name"
}
]
}
}
},
"components": {
"schemas": {
"_types.Id": {
"type": "string"
},
"_types.AcknowledgedResponseBase": {
"type": "object",
"properties": {
"acknowledged": {
"description": "For a successful response, this value is always true. On failure, an exception is returned instead.",
"type": "boolean"
}
},
"required": [
"acknowledged"
]
},
"_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\n`d` (days). Also accepts \"0\" without a unit and \"-1\" to indicate an unspecified value.",
"type": "string"
},
"async_search._types.AsyncSearchDocumentResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/async_search._types.AsyncSearchResponseBase"
},
{
"type": "object",
"properties": {
"response": {
"allOf": [
{
"$ref": "#/components/schemas/async_search._types.AsyncSearch"
}
]
}
},
"required": [
"response"
]
}
]
},
"async_search._types.AsyncSearch": {
"type": "object",
"properties": {
"aggregations": {
"description": "Partial aggregations results, coming from the shards that have already completed running the query.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.Aggregate"
}
},
"_clusters": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ClusterStatistics"
}
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"hits": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HitsMetadata"
}
]
},
"max_score": {
"type": "number"
},
"num_reduce_phases": {
"description": "Indicates how many reductions of the results have been performed.\nIf this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response.",
"type": "number"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Profile"
}
]
},
"pit_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_scroll_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScrollId"
}
]
},
"_shards": {
"description": "Indicates how many shards have run the query.\nNote that in order for shard results to be included in the search response, they need to be reduced first.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"suggest": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Suggest"
}
}
},
"terminated_early": {
"type": "boolean"
},
"timed_out": {
"type": "boolean"
},
"took": {
"type": "number"
}
},
"required": [
"hits",
"_shards",
"timed_out",
"took"
]
},
"_types.aggregations.Aggregate": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations"
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CardinalityAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.HdrPercentilesAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.HdrPercentileRanksAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.TDigestPercentilesAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.TDigestPercentileRanksAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.PercentilesBucketAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.MinAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.MaxAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.SumAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.AvgAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.WeightedAvgAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ValueCountAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.SimpleValueAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.DerivativeAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.BucketMetricValueAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ChangePointAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.StatsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.StatsBucketAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.CartesianBoundsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.CartesianCentroidAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.GeoBoundsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.GeoCentroidAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.HistogramAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.AutoDateHistogramAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.StringTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.LongTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.DoubleTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.UnmappedTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.LongRareTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.StringRareTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.UnmappedRareTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.MissingAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.NestedAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ReverseNestedAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.GlobalAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.FilterAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ChildrenAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ParentAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.SamplerAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.UnmappedSamplerAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.GeoHashGridAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.GeoHexGridAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.RangeAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.DateRangeAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.GeoDistanceAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.IpRangeAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.IpPrefixAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.FiltersAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.SignificantLongTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.SignificantStringTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.UnmappedSignificantTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.TimeSeriesAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ScriptedMetricAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.TopHitsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.InferenceAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.StringStatsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.BoxPlotAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.TopMetricsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.TTestAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.RateAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.CumulativeCardinalityAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.MatrixStatsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.GeoLineAggregate"
}
],
"x-model": true
},
"_types.aggregations.CardinalityAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"value": {
"type": "number"
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.aggregations.AggregateBase": {
"type": "object",
"properties": {
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
}
},
"_types.Metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"_types.aggregations.HdrPercentilesAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.PercentilesAggregateBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"values": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Percentiles"
}
]
}
},
"required": [
"values"
]
}
]
},
"_types.aggregations.Percentiles": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.aggregations.KeyedPercentiles"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.ArrayPercentilesItem"
}
}
]
},
"_types.aggregations.KeyedPercentiles": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
}
},
"_types.aggregations.ArrayPercentilesItem": {
"type": "object",
"properties": {
"key": {
"type": "number"
},
"value": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"value_as_string": {
"type": "string"
}
},
"required": [
"key",
"value"
]
},
"_types.aggregations.HdrPercentileRanksAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.TDigestPercentilesAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.TDigestPercentileRanksAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.PercentilesBucketAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MedianAbsoluteDeviationAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.SingleMetricAggregateBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"value": {
"description": "The metric value. A missing value generally means that there was no data to aggregate,\nunless specified otherwise.",
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"value_as_string": {
"type": "string"
}
},
"required": [
"value"
]
}
]
},
"_types.aggregations.MinAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MaxAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.SumAggregate": {
"description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.AvgAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.WeightedAvgAggregate": {
"description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.ValueCountAggregate": {
"description": "Value count aggregation result. `value` is always present.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.SimpleValueAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.DerivativeAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object",
"properties": {
"normalized_value": {
"type": "number"
},
"normalized_value_as_string": {
"type": "string"
}
}
}
],
"x-model": true
},
"_types.aggregations.BucketMetricValueAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
},
{
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"keys"
]
}
],
"x-model": true
},
"_types.aggregations.ChangePointAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ChangeType"
}
]
},
"bucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ChangePointBucket"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.aggregations.ChangeType": {
"type": "object",
"properties": {
"dip": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Dip"
}
]
},
"distribution_change": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.DistributionChange"
}
]
},
"indeterminable": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Indeterminable"
}
]
},
"non_stationary": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.NonStationary"
}
]
},
"spike": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Spike"
}
]
},
"stationary": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Stationary"
}
]
},
"step_change": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.StepChange"
}
]
},
"trend_change": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TrendChange"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.aggregations.Dip": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AbstractChangePoint"
},
{
"type": "object"
}
]
},
"_types.aggregations.AbstractChangePoint": {
"type": "object",
"properties": {
"p_value": {
"type": "number"
},
"change_point": {
"type": "number"
}
},
"required": [
"p_value",
"change_point"
]
},
"_types.aggregations.DistributionChange": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AbstractChangePoint"
},
{
"type": "object"
}
]
},
"_types.aggregations.Indeterminable": {
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"required": [
"reason"
]
},
"_types.aggregations.NonStationary": {
"type": "object",
"properties": {
"p_value": {
"type": "number"
},
"r_value": {
"type": "number"
},
"trend": {
"type": "string"
}
},
"required": [
"p_value",
"r_value",
"trend"
]
},
"_types.aggregations.Spike": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AbstractChangePoint"
},
{
"type": "object"
}
]
},
"_types.aggregations.Stationary": {
"type": "object"
},
"_types.aggregations.StepChange": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AbstractChangePoint"
},
{
"type": "object"
}
]
},
"_types.aggregations.TrendChange": {
"type": "object",
"properties": {
"p_value": {
"type": "number"
},
"r_value": {
"type": "number"
},
"change_point": {
"type": "number"
}
},
"required": [
"p_value",
"r_value",
"change_point"
]
},
"_types.aggregations.ChangePointBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
}
]
}
},
"required": [
"key"
]
}
]
},
"_types.FieldValue": {
"description": "A field value.",
"oneOf": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"nullable": true,
"type": "string"
}
]
},
"_types.aggregations.MultiBucketBase": {
"description": "Base type for multi-bucket aggregation results that can hold sub-aggregations results.",
"type": "object",
"properties": {
"doc_count": {
"type": "number"
}
},
"required": [
"doc_count"
]
},
"_types.aggregations.StatsAggregate": {
"description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"count": {
"type": "number"
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"avg": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"sum": {
"type": "number"
},
"min_as_string": {
"type": "string"
},
"max_as_string": {
"type": "string"
},
"avg_as_string": {
"type": "string"
},
"sum_as_string": {
"type": "string"
}
},
"required": [
"count",
"min",
"max",
"avg",
"sum"
]
}
],
"x-model": true
},
"_types.aggregations.StatsBucketAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.StatsAggregate"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.ExtendedStatsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.StatsAggregate"
},
{
"type": "object",
"properties": {
"sum_of_squares": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"variance": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"variance_population": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"variance_sampling": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"std_deviation": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"std_deviation_population": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"std_deviation_sampling": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"std_deviation_bounds": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.StandardDeviationBounds"
}
]
},
"sum_of_squares_as_string": {
"type": "string"
},
"variance_as_string": {
"type": "string"
},
"variance_population_as_string": {
"type": "string"
},
"variance_sampling_as_string": {
"type": "string"
},
"std_deviation_as_string": {
"type": "string"
},
"std_deviation_bounds_as_string": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.StandardDeviationBoundsAsString"
}
]
}
},
"required": [
"sum_of_squares",
"variance",
"variance_population",
"variance_sampling",
"std_deviation",
"std_deviation_population",
"std_deviation_sampling"
]
}
],
"x-model": true
},
"_types.aggregations.StandardDeviationBounds": {
"type": "object",
"properties": {
"upper": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"lower": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"upper_population": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"lower_population": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"upper_sampling": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"lower_sampling": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
}
},
"required": [
"upper",
"lower",
"upper_population",
"lower_population",
"upper_sampling",
"lower_sampling"
]
},
"_types.aggregations.StandardDeviationBoundsAsString": {
"type": "object",
"properties": {
"upper": {
"type": "string"
},
"lower": {
"type": "string"
},
"upper_population": {
"type": "string"
},
"lower_population": {
"type": "string"
},
"upper_sampling": {
"type": "string"
},
"lower_sampling": {
"type": "string"
}
},
"required": [
"upper",
"lower",
"upper_population",
"lower_population",
"upper_sampling",
"lower_sampling"
]
},
"_types.aggregations.ExtendedStatsBucketAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregate"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.CartesianBoundsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"bounds": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TopLeftBottomRightGeoBounds"
}
]
}
}
}
]
},
"_types.TopLeftBottomRightGeoBounds": {
"type": "object",
"properties": {
"top_left": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
},
"bottom_right": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
}
},
"required": [
"top_left",
"bottom_right"
]
},
"_types.GeoLocation": {
"description": "A latitude/longitude as a 2 dimensional point. It can be represented in various ways:\n- as a `{lat, long}` object\n- as a geo hash value\n- as a `[lon, lat]` array\n- as a string in `\", \"` or WKT point formats",
"oneOf": [
{
"$ref": "#/components/schemas/_types.LatLonGeoLocation"
},
{
"$ref": "#/components/schemas/_types.GeoHashLocation"
},
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "string"
}
]
},
"_types.LatLonGeoLocation": {
"type": "object",
"properties": {
"lat": {
"description": "Latitude",
"type": "number"
},
"lon": {
"description": "Longitude",
"type": "number"
}
},
"required": [
"lat",
"lon"
]
},
"_types.GeoHashLocation": {
"type": "object",
"properties": {
"geohash": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoHash"
}
]
}
},
"required": [
"geohash"
]
},
"_types.GeoHash": {
"type": "string"
},
"_types.aggregations.CartesianCentroidAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"count": {
"type": "number"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/_types.CartesianPoint"
}
]
}
},
"required": [
"count"
]
}
]
},
"_types.CartesianPoint": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"_types.aggregations.GeoBoundsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"bounds": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoBounds"
}
]
}
}
}
],
"x-model": true
},
"_types.GeoBounds": {
"description": "A geo bounding box. It can be represented in various ways:\n- as 4 top/bottom/left/right coordinates\n- as 2 top_left / bottom_right points\n- as 2 top_right / bottom_left points\n- as a WKT bounding box",
"oneOf": [
{
"$ref": "#/components/schemas/_types.CoordsGeoBounds"
},
{
"$ref": "#/components/schemas/_types.TopLeftBottomRightGeoBounds"
},
{
"$ref": "#/components/schemas/_types.TopRightBottomLeftGeoBounds"
},
{
"$ref": "#/components/schemas/_types.WktGeoBounds"
}
]
},
"_types.CoordsGeoBounds": {
"type": "object",
"properties": {
"top": {
"type": "number"
},
"bottom": {
"type": "number"
},
"left": {
"type": "number"
},
"right": {
"type": "number"
}
},
"required": [
"top",
"bottom",
"left",
"right"
]
},
"_types.TopRightBottomLeftGeoBounds": {
"type": "object",
"properties": {
"top_right": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
},
"bottom_left": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
}
},
"required": [
"top_right",
"bottom_left"
]
},
"_types.WktGeoBounds": {
"type": "object",
"properties": {
"wkt": {
"type": "string"
}
},
"required": [
"wkt"
]
},
"_types.aggregations.GeoCentroidAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"count": {
"type": "number"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
}
},
"required": [
"count"
]
}
],
"x-model": true
},
"_types.aggregations.HistogramAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseHistogramBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseHistogramBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsHistogramBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsHistogramBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.HistogramBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.HistogramBucket"
}
}
]
},
"_types.aggregations.HistogramBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key_as_string": {
"type": "string"
},
"key": {
"type": "number"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.DateHistogramAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseDateHistogramBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseDateHistogramBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsDateHistogramBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsDateHistogramBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.DateHistogramBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.DateHistogramBucket"
}
}
]
},
"_types.aggregations.DateHistogramBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key_as_string": {
"type": "string"
},
"key": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"key"
]
}
]
},
"_types.EpochTimeUnitMillis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitMillis"
}
]
},
"_types.UnitMillis": {
"description": "Time unit for milliseconds",
"type": "number"
},
"_types.aggregations.AutoDateHistogramAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseDateHistogramBucket"
},
{
"type": "object",
"properties": {
"interval": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationLarge"
}
]
}
},
"required": [
"interval"
]
}
],
"x-model": true
},
"_types.DurationLarge": {
"description": "A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and\n`y` (year)",
"type": "string"
},
"_types.aggregations.VariableWidthHistogramAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVariableWidthHistogramBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseVariableWidthHistogramBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsVariableWidthHistogramBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsVariableWidthHistogramBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramBucket"
}
}
]
},
"_types.aggregations.VariableWidthHistogramBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"min": {
"type": "number"
},
"key": {
"type": "number"
},
"max": {
"type": "number"
},
"min_as_string": {
"type": "string"
},
"key_as_string": {
"type": "string"
},
"max_as_string": {
"type": "string"
}
},
"required": [
"min",
"key",
"max"
]
}
]
},
"_types.aggregations.StringTermsAggregate": {
"description": "Result of a `terms` aggregation when the field is a string.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseStringTermsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.TermsAggregateBaseStringTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseStringTermsBucket"
},
{
"type": "object",
"properties": {
"doc_count_error_upper_bound": {
"type": "number"
},
"sum_other_doc_count": {
"type": "number"
}
}
}
]
},
"_types.aggregations.MultiBucketAggregateBaseStringTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsStringTermsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsStringTermsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.StringTermsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.StringTermsBucket"
}
}
]
},
"_types.aggregations.StringTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
}
]
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.TermsBucketBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"doc_count_error_upper_bound": {
"type": "number"
}
}
}
]
},
"_types.aggregations.LongTermsAggregate": {
"description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseLongTermsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.TermsAggregateBaseLongTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseLongTermsBucket"
},
{
"type": "object",
"properties": {
"doc_count_error_upper_bound": {
"type": "number"
},
"sum_other_doc_count": {
"type": "number"
}
}
}
]
},
"_types.aggregations.MultiBucketAggregateBaseLongTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsLongTermsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsLongTermsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.LongTermsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.LongTermsBucket"
}
}
]
},
"_types.aggregations.LongTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "number"
},
"key_as_string": {
"type": "string"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.DoubleTermsAggregate": {
"description": "Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseDoubleTermsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.TermsAggregateBaseDoubleTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseDoubleTermsBucket"
},
{
"type": "object",
"properties": {
"doc_count_error_upper_bound": {
"type": "number"
},
"sum_other_doc_count": {
"type": "number"
}
}
}
]
},
"_types.aggregations.MultiBucketAggregateBaseDoubleTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsDoubleTermsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsDoubleTermsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.DoubleTermsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.DoubleTermsBucket"
}
}
]
},
"_types.aggregations.DoubleTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "number"
},
"key_as_string": {
"type": "string"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.UnmappedTermsAggregate": {
"description": "Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseVoid"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.TermsAggregateBaseVoid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVoid"
},
{
"type": "object",
"properties": {
"doc_count_error_upper_bound": {
"type": "number"
},
"sum_other_doc_count": {
"type": "number"
}
}
}
]
},
"_types.aggregations.MultiBucketAggregateBaseVoid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsVoid"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsVoid": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_spec_utils.Void"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_spec_utils.Void"
}
}
]
},
"_spec_utils.Void": {
"description": "The absence of any type. This is commonly used in APIs that don't return a body.\n\nAlthough \"void\" is generally used for the unit type that has only one value, this is to be interpreted as\nthe bottom type that has no value at all. Most languages have a unit type, but few have a bottom type.\n\nSee https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type",
"type": "object"
},
"_types.aggregations.LongRareTermsAggregate": {
"description": "Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseLongRareTermsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseLongRareTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsLongRareTermsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsLongRareTermsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.LongRareTermsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.LongRareTermsBucket"
}
}
]
},
"_types.aggregations.LongRareTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "number"
},
"key_as_string": {
"type": "string"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.StringRareTermsAggregate": {
"description": "Result of the `rare_terms` aggregation when the field is a string.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseStringRareTermsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseStringRareTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsStringRareTermsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsStringRareTermsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.StringRareTermsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.StringRareTermsBucket"
}
}
]
},
"_types.aggregations.StringRareTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.UnmappedRareTermsAggregate": {
"description": "Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVoid"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiTermsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseMultiTermsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.TermsAggregateBaseMultiTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseMultiTermsBucket"
},
{
"type": "object",
"properties": {
"doc_count_error_upper_bound": {
"type": "number"
},
"sum_other_doc_count": {
"type": "number"
}
}
}
]
},
"_types.aggregations.MultiBucketAggregateBaseMultiTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsMultiTermsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsMultiTermsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.MultiTermsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.MultiTermsBucket"
}
}
]
},
"_types.aggregations.MultiTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.FieldValue"
}
},
"key_as_string": {
"type": "string"
},
"doc_count_error_upper_bound": {
"type": "number"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.MissingAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.SingleBucketAggregateBase": {
"description": "Base type for single-bucket aggregation results that can hold sub-aggregations results.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"doc_count": {
"type": "number"
}
},
"required": [
"doc_count"
]
}
]
},
"_types.aggregations.NestedAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.ReverseNestedAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.GlobalAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.FilterAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.ChildrenAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.ParentAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.SamplerAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.UnmappedSamplerAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.GeoHashGridAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseGeoHashGridBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseGeoHashGridBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsGeoHashGridBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsGeoHashGridBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.GeoHashGridBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.GeoHashGridBucket"
}
}
]
},
"_types.aggregations.GeoHashGridBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoHash"
}
]
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.GeoTileGridAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseGeoTileGridBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseGeoTileGridBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsGeoTileGridBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsGeoTileGridBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.GeoTileGridBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.GeoTileGridBucket"
}
}
]
},
"_types.aggregations.GeoTileGridBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoTile"
}
]
}
},
"required": [
"key"
]
}
]
},
"_types.GeoTile": {
"description": "A map tile reference, represented as `{zoom}/{x}/{y}`",
"type": "string"
},
"_types.aggregations.GeoHexGridAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseGeoHexGridBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseGeoHexGridBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsGeoHexGridBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsGeoHexGridBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.GeoHexGridBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.GeoHexGridBucket"
}
}
]
},
"_types.aggregations.GeoHexGridBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoHexCell"
}
]
}
},
"required": [
"key"
]
}
]
},
"_types.GeoHexCell": {
"description": "A map hex cell (H3) reference",
"type": "string"
},
"_types.aggregations.RangeAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseRangeBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseRangeBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsRangeBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsRangeBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.RangeBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.RangeBucket"
}
}
]
},
"_types.aggregations.RangeBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"from": {
"type": "number"
},
"to": {
"type": "number"
},
"from_as_string": {
"type": "string"
},
"to_as_string": {
"type": "string"
},
"key": {
"description": "The bucket key. Present if the aggregation is _not_ keyed",
"type": "string"
}
}
}
]
},
"_types.aggregations.DateRangeAggregate": {
"description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.RangeAggregate"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.GeoDistanceAggregate": {
"description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.RangeAggregate"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.IpRangeAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseIpRangeBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseIpRangeBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsIpRangeBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsIpRangeBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.IpRangeBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.IpRangeBucket"
}
}
]
},
"_types.aggregations.IpRangeBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
}
}
}
]
},
"_types.aggregations.IpPrefixAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseIpPrefixBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseIpPrefixBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsIpPrefixBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsIpPrefixBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.IpPrefixBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.IpPrefixBucket"
}
}
]
},
"_types.aggregations.IpPrefixBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"is_ipv6": {
"type": "boolean"
},
"key": {
"type": "string"
},
"prefix_length": {
"type": "number"
},
"netmask": {
"type": "string"
}
},
"required": [
"is_ipv6",
"key",
"prefix_length"
]
}
]
},
"_types.aggregations.FiltersAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseFiltersBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseFiltersBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsFiltersBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsFiltersBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.FiltersBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.FiltersBucket"
}
}
]
},
"_types.aggregations.FiltersBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
}
}
}
]
},
"_types.aggregations.AdjacencyMatrixAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseAdjacencyMatrixBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseAdjacencyMatrixBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsAdjacencyMatrixBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsAdjacencyMatrixBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixBucket"
}
}
]
},
"_types.aggregations.AdjacencyMatrixBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.SignificantLongTermsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregateBaseSignificantLongTermsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.SignificantTermsAggregateBaseSignificantLongTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseSignificantLongTermsBucket"
},
{
"type": "object",
"properties": {
"bg_count": {
"type": "number"
},
"doc_count": {
"type": "number"
}
}
}
]
},
"_types.aggregations.MultiBucketAggregateBaseSignificantLongTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsSignificantLongTermsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsSignificantLongTermsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.SignificantLongTermsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.SignificantLongTermsBucket"
}
}
]
},
"_types.aggregations.SignificantLongTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SignificantTermsBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "number"
},
"key_as_string": {
"type": "string"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.SignificantTermsBucketBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"score": {
"type": "number"
},
"bg_count": {
"type": "number"
}
},
"required": [
"score",
"bg_count"
]
}
]
},
"_types.aggregations.SignificantStringTermsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregateBaseSignificantStringTermsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.SignificantTermsAggregateBaseSignificantStringTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseSignificantStringTermsBucket"
},
{
"type": "object",
"properties": {
"bg_count": {
"type": "number"
},
"doc_count": {
"type": "number"
}
}
}
]
},
"_types.aggregations.MultiBucketAggregateBaseSignificantStringTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsSignificantStringTermsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsSignificantStringTermsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.SignificantStringTermsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.SignificantStringTermsBucket"
}
}
]
},
"_types.aggregations.SignificantStringTermsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SignificantTermsBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.UnmappedSignificantTermsAggregate": {
"description": "Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregateBaseVoid"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.SignificantTermsAggregateBaseVoid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVoid"
},
{
"type": "object",
"properties": {
"bg_count": {
"type": "number"
},
"doc_count": {
"type": "number"
}
}
}
]
},
"_types.aggregations.CompositeAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseCompositeBucket"
},
{
"type": "object",
"properties": {
"after_key": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.CompositeAggregateKey": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.FieldValue"
}
},
"_types.aggregations.MultiBucketAggregateBaseCompositeBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsCompositeBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsCompositeBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.CompositeBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.CompositeBucket"
}
}
]
},
"_types.aggregations.CompositeBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey"
}
]
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.FrequentItemSetsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseFrequentItemSetsBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseFrequentItemSetsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsFrequentItemSetsBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsFrequentItemSetsBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsBucket"
}
}
]
},
"_types.aggregations.FrequentItemSetsBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"support": {
"type": "number"
}
},
"required": [
"key",
"support"
]
}
]
},
"_types.aggregations.TimeSeriesAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseTimeSeriesBucket"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MultiBucketAggregateBaseTimeSeriesBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"buckets": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsTimeSeriesBucket"
}
]
}
},
"required": [
"buckets"
]
}
]
},
"_types.aggregations.BucketsTimeSeriesBucket": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.TimeSeriesBucket"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.TimeSeriesBucket"
}
}
]
},
"_types.aggregations.TimeSeriesBucket": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
},
{
"type": "object",
"properties": {
"key": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.FieldValue"
}
}
},
"required": [
"key"
]
}
]
},
"_types.aggregations.ScriptedMetricAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"value": {
"type": "object"
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.aggregations.TopHitsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"hits": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HitsMetadata"
}
]
}
},
"required": [
"hits"
]
}
],
"x-model": true
},
"_global.search._types.HitsMetadata": {
"type": "object",
"properties": {
"total": {
"description": "Total hit count information, present only if `track_total_hits` wasn't `false` in the search request.",
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.TotalHits"
},
{
"type": "number"
}
]
},
"hits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Hit"
}
},
"max_score": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
}
},
"required": [
"hits"
]
},
"_global.search._types.TotalHits": {
"type": "object",
"properties": {
"relation": {
"description": "\n\nSupported values include:\n - `eq`: Accurate\n - `gte`: Lower bound, including returned events or sequences\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.TotalHitsRelation"
}
]
},
"value": {
"type": "number"
}
},
"required": [
"relation",
"value"
]
},
"_global.search._types.TotalHitsRelation": {
"type": "string",
"enum": [
"eq",
"gte"
]
},
"_global.search._types.Hit": {
"type": "object",
"properties": {
"_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_score": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"_explanation": {
"allOf": [
{
"$ref": "#/components/schemas/_global.explain.Explanation"
}
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"highlight": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"inner_hits": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.search._types.InnerHitsResult"
}
},
"matched_queries": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"additionalProperties": {
"type": "number"
}
}
]
},
"_nested": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.NestedIdentity"
}
]
},
"_ignored": {
"type": "array",
"items": {
"type": "string"
}
},
"ignored_field_values": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "object"
}
}
},
"_shard": {
"type": "string"
},
"_node": {
"type": "string"
},
"_routing": {
"type": "string"
},
"_source": {
"type": "object"
},
"_rank": {
"type": "number"
},
"_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"_primary_term": {
"type": "number"
},
"_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
}
},
"required": [
"_index"
]
},
"_types.IndexName": {
"type": "string"
},
"_global.explain.Explanation": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.explain.ExplanationDetail"
}
},
"value": {
"type": "number"
}
},
"required": [
"description",
"details",
"value"
]
},
"_global.explain.ExplanationDetail": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.explain.ExplanationDetail"
}
},
"value": {
"type": "number"
}
},
"required": [
"description",
"value"
]
},
"_global.search._types.InnerHitsResult": {
"type": "object",
"properties": {
"hits": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HitsMetadata"
}
]
}
},
"required": [
"hits"
]
},
"_global.search._types.NestedIdentity": {
"type": "object",
"properties": {
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"offset": {
"type": "number"
},
"_nested": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.NestedIdentity"
}
]
}
},
"required": [
"field",
"offset"
]
},
"_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.SequenceNumber": {
"type": "number"
},
"_types.VersionNumber": {
"type": "number"
},
"_types.SortResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.FieldValue"
}
},
"_types.aggregations.InferenceAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
}
]
},
"feature_importance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.InferenceFeatureImportance"
}
},
"top_classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.InferenceTopClassEntry"
}
},
"warning": {
"type": "string"
}
}
}
],
"x-model": true
},
"_types.aggregations.InferenceFeatureImportance": {
"type": "object",
"properties": {
"feature_name": {
"type": "string"
},
"importance": {
"type": "number"
},
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.InferenceClassImportance"
}
}
},
"required": [
"feature_name"
]
},
"_types.aggregations.InferenceClassImportance": {
"type": "object",
"properties": {
"class_name": {
"type": "string"
},
"importance": {
"type": "number"
}
},
"required": [
"class_name",
"importance"
]
},
"_types.aggregations.InferenceTopClassEntry": {
"type": "object",
"properties": {
"class_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
}
]
},
"class_probability": {
"type": "number"
},
"class_score": {
"type": "number"
}
},
"required": [
"class_name",
"class_probability",
"class_score"
]
},
"_types.aggregations.StringStatsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"count": {
"type": "number"
},
"min_length": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"max_length": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"avg_length": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"entropy": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"distribution": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "number"
}
},
{
"nullable": true,
"type": "string"
}
]
},
"min_length_as_string": {
"type": "string"
},
"max_length_as_string": {
"type": "string"
},
"avg_length_as_string": {
"type": "string"
}
},
"required": [
"count",
"min_length",
"max_length",
"avg_length",
"entropy"
]
}
],
"x-model": true
},
"_types.aggregations.BoxPlotAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
},
"q1": {
"type": "number"
},
"q2": {
"type": "number"
},
"q3": {
"type": "number"
},
"lower": {
"type": "number"
},
"upper": {
"type": "number"
},
"min_as_string": {
"type": "string"
},
"max_as_string": {
"type": "string"
},
"q1_as_string": {
"type": "string"
},
"q2_as_string": {
"type": "string"
},
"q3_as_string": {
"type": "string"
},
"lower_as_string": {
"type": "string"
},
"upper_as_string": {
"type": "string"
}
},
"required": [
"min",
"max",
"q1",
"q2",
"q3",
"lower",
"upper"
]
}
],
"x-model": true
},
"_types.aggregations.TopMetricsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"top": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.TopMetrics"
}
}
},
"required": [
"top"
]
}
],
"x-model": true
},
"_types.aggregations.TopMetrics": {
"type": "object",
"properties": {
"sort": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
},
{
"nullable": true,
"type": "string"
}
]
}
},
"metrics": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"required": [
"sort",
"metrics"
]
},
"_types.aggregations.TTestAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"value_as_string": {
"type": "string"
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.aggregations.RateAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"value": {
"type": "number"
},
"value_as_string": {
"type": "string"
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.aggregations.CumulativeCardinalityAggregate": {
"description": "Result of the `cumulative_cardinality` aggregation",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"value": {
"type": "number"
},
"value_as_string": {
"type": "string"
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.aggregations.MatrixStatsAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"doc_count": {
"type": "number"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.MatrixStatsFields"
}
}
},
"required": [
"doc_count"
]
}
],
"x-model": true
},
"_types.aggregations.MatrixStatsFields": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"count": {
"type": "number"
},
"mean": {
"type": "number"
},
"variance": {
"type": "number"
},
"skewness": {
"type": "number"
},
"kurtosis": {
"type": "number"
},
"covariance": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"correlation": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"name",
"count",
"mean",
"variance",
"skewness",
"kurtosis",
"covariance",
"correlation"
]
},
"_types.aggregations.GeoLineAggregate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"geometry": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLine"
}
]
},
"properties": {
"type": "object"
}
},
"required": [
"type",
"geometry",
"properties"
]
}
],
"x-model": true
},
"_types.GeoLine": {
"description": "A GeoJson GeoLine.",
"type": "object",
"properties": {
"type": {
"description": "Always `\"LineString\"`",
"type": "string"
},
"coordinates": {
"description": "Array of `[lon, lat]` coordinates",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"required": [
"type",
"coordinates"
]
},
"_types.ClusterStatistics": {
"type": "object",
"properties": {
"skipped": {
"type": "number"
},
"successful": {
"type": "number"
},
"total": {
"type": "number"
},
"running": {
"type": "number"
},
"partial": {
"type": "number"
},
"failed": {
"type": "number"
},
"details": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ClusterDetails"
}
}
},
"required": [
"skipped",
"successful",
"total",
"running",
"partial",
"failed"
]
},
"_types.ClusterDetails": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ClusterSearchStatus"
}
]
},
"indices": {
"type": "string"
},
"took": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"timed_out": {
"type": "boolean"
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ShardFailure"
}
}
},
"required": [
"status",
"indices",
"timed_out"
]
},
"_types.ClusterSearchStatus": {
"type": "string",
"enum": [
"running",
"successful",
"partial",
"skipped",
"failed"
]
},
"_types.DurationValueUnitMillis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitMillis"
}
]
},
"_types.ShardStatistics": {
"type": "object",
"properties": {
"failed": {
"description": "The number of shards the operation or search attempted to run on but failed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"successful": {
"description": "The number of shards the operation or search succeeded on.",
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"total": {
"description": "The number of shards the operation or search will run on overall.",
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ShardFailure"
}
},
"skipped": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
}
},
"required": [
"failed",
"successful",
"total"
]
},
"_types.uint": {
"type": "number"
},
"_types.ShardFailure": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"node": {
"type": "string"
},
"reason": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"shard": {
"type": "number"
},
"status": {
"type": "string"
},
"primary": {
"type": "boolean"
}
},
"required": [
"reason"
]
},
"_types.ErrorCause": {
"description": "Cause and details about a request failure. This class defines the properties common to all error types.\nAdditional details are also provided, that depend on the error type.",
"type": "object",
"properties": {
"type": {
"description": "The type of error",
"type": "string"
},
"reason": {
"description": "A human-readable explanation of the error, in English.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"stack_trace": {
"description": "The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.",
"type": "string"
},
"caused_by": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"root_cause": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
},
"suppressed": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
}
},
"required": [
"type"
]
},
"_global.search._types.Profile": {
"type": "object",
"properties": {
"shards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.ShardProfile"
}
},
"request": {
"description": "When profiling is enabled, the original query source and target indices from the coordinating request.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SearchRequestCoordinatorMetadata"
}
]
}
},
"required": [
"shards"
]
},
"_global.search._types.ShardProfile": {
"type": "object",
"properties": {
"aggregations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.AggregationProfile"
}
},
"cluster": {
"type": "string"
},
"dfs": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.DfsProfile"
}
]
},
"fetch": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FetchProfile"
}
]
},
"id": {
"type": "string"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"node_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
}
]
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.SearchProfile"
}
},
"shard_id": {
"type": "number"
}
},
"required": [
"aggregations",
"cluster",
"id",
"index",
"node_id",
"searches",
"shard_id"
]
},
"_global.search._types.AggregationProfile": {
"type": "object",
"properties": {
"breakdown": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.AggregationBreakdown"
}
]
},
"description": {
"type": "string"
},
"time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"type": {
"type": "string"
},
"debug": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug"
}
]
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.AggregationProfile"
}
}
},
"required": [
"breakdown",
"description",
"time_in_nanos",
"type"
]
},
"_global.search._types.AggregationBreakdown": {
"type": "object",
"properties": {
"build_aggregation": {
"type": "number"
},
"build_aggregation_count": {
"type": "number"
},
"build_leaf_collector": {
"type": "number"
},
"build_leaf_collector_count": {
"type": "number"
},
"collect": {
"type": "number"
},
"collect_count": {
"type": "number"
},
"initialize": {
"type": "number"
},
"initialize_count": {
"type": "number"
},
"post_collection": {
"type": "number"
},
"post_collection_count": {
"type": "number"
},
"reduce": {
"type": "number"
},
"reduce_count": {
"type": "number"
}
},
"required": [
"build_aggregation",
"build_aggregation_count",
"build_leaf_collector",
"build_leaf_collector_count",
"collect",
"collect_count",
"initialize",
"initialize_count",
"reduce",
"reduce_count"
]
},
"_types.DurationValueUnitNanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitNanos"
}
]
},
"_types.UnitNanos": {
"description": "Time unit for nanoseconds",
"type": "number"
},
"_global.search._types.AggregationProfileDebug": {
"type": "object",
"properties": {
"segments_with_multi_valued_ords": {
"type": "number"
},
"collection_strategy": {
"type": "string"
},
"segments_with_single_valued_ords": {
"type": "number"
},
"total_buckets": {
"type": "number"
},
"built_buckets": {
"type": "number"
},
"result_strategy": {
"type": "string"
},
"has_filter": {
"type": "boolean"
},
"delegate": {
"type": "string"
},
"delegate_debug": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug"
}
]
},
"chars_fetched": {
"type": "number"
},
"extract_count": {
"type": "number"
},
"extract_ns": {
"type": "number"
},
"values_fetched": {
"type": "number"
},
"collect_analyzed_ns": {
"type": "number"
},
"collect_analyzed_count": {
"type": "number"
},
"surviving_buckets": {
"type": "number"
},
"ordinals_collectors_used": {
"type": "number"
},
"ordinals_collectors_overhead_too_high": {
"type": "number"
},
"string_hashing_collectors_used": {
"type": "number"
},
"numeric_collectors_used": {
"type": "number"
},
"empty_collectors_used": {
"type": "number"
},
"deferred_aggregators": {
"type": "array",
"items": {
"type": "string"
}
},
"segments_with_doc_count_field": {
"type": "number"
},
"segments_with_deleted_docs": {
"type": "number"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.AggregationProfileDelegateDebugFilter"
}
},
"segments_counted": {
"type": "number"
},
"segments_collected": {
"type": "number"
},
"map_reducer": {
"type": "string"
},
"brute_force_used": {
"type": "number"
},
"dynamic_pruning_attempted": {
"type": "number"
},
"dynamic_pruning_used": {
"type": "number"
},
"skipped_due_to_no_data": {
"type": "number"
}
}
},
"_global.search._types.AggregationProfileDelegateDebugFilter": {
"type": "object",
"properties": {
"results_from_metadata": {
"type": "number"
},
"query": {
"type": "string"
},
"specialized_for": {
"type": "string"
},
"segments_counted_in_constant_time": {
"type": "number"
}
}
},
"_global.search._types.DfsProfile": {
"type": "object",
"properties": {
"statistics": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.DfsStatisticsProfile"
}
]
},
"knn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.DfsKnnProfile"
}
}
}
},
"_global.search._types.DfsStatisticsProfile": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"breakdown": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.DfsStatisticsBreakdown"
}
]
},
"debug": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.DfsStatisticsProfile"
}
}
},
"required": [
"type",
"description",
"time_in_nanos",
"breakdown"
]
},
"_global.search._types.DfsStatisticsBreakdown": {
"type": "object",
"properties": {
"collection_statistics": {
"type": "number"
},
"collection_statistics_count": {
"type": "number"
},
"create_weight": {
"type": "number"
},
"create_weight_count": {
"type": "number"
},
"rewrite": {
"type": "number"
},
"rewrite_count": {
"type": "number"
},
"term_statistics": {
"type": "number"
},
"term_statistics_count": {
"type": "number"
}
},
"required": [
"collection_statistics",
"collection_statistics_count",
"create_weight",
"create_weight_count",
"rewrite",
"rewrite_count",
"term_statistics",
"term_statistics_count"
]
},
"_global.search._types.DfsKnnProfile": {
"type": "object",
"properties": {
"vector_operations_count": {
"type": "number"
},
"query": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.KnnQueryProfileResult"
}
},
"rewrite_time": {
"type": "number"
},
"collector": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.KnnCollectorResult"
}
}
},
"required": [
"query",
"rewrite_time",
"collector"
]
},
"_global.search._types.KnnQueryProfileResult": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"breakdown": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.KnnQueryProfileBreakdown"
}
]
},
"debug": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.KnnQueryProfileResult"
}
}
},
"required": [
"type",
"description",
"time_in_nanos",
"breakdown"
]
},
"_global.search._types.KnnQueryProfileBreakdown": {
"type": "object",
"properties": {
"advance": {
"type": "number"
},
"advance_count": {
"type": "number"
},
"build_scorer": {
"type": "number"
},
"build_scorer_count": {
"type": "number"
},
"compute_max_score": {
"type": "number"
},
"compute_max_score_count": {
"type": "number"
},
"count_weight": {
"type": "number"
},
"count_weight_count": {
"type": "number"
},
"create_weight": {
"type": "number"
},
"create_weight_count": {
"type": "number"
},
"match": {
"type": "number"
},
"match_count": {
"type": "number"
},
"next_doc": {
"type": "number"
},
"next_doc_count": {
"type": "number"
},
"score": {
"type": "number"
},
"score_count": {
"type": "number"
},
"set_min_competitive_score": {
"type": "number"
},
"set_min_competitive_score_count": {
"type": "number"
},
"shallow_advance": {
"type": "number"
},
"shallow_advance_count": {
"type": "number"
}
},
"required": [
"advance",
"advance_count",
"build_scorer",
"build_scorer_count",
"compute_max_score",
"compute_max_score_count",
"count_weight",
"count_weight_count",
"create_weight",
"create_weight_count",
"match",
"match_count",
"next_doc",
"next_doc_count",
"score",
"score_count",
"set_min_competitive_score",
"set_min_competitive_score_count",
"shallow_advance",
"shallow_advance_count"
]
},
"_global.search._types.KnnCollectorResult": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"reason": {
"type": "string"
},
"time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.KnnCollectorResult"
}
}
},
"required": [
"name",
"reason",
"time_in_nanos"
]
},
"_global.search._types.FetchProfile": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"breakdown": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FetchProfileBreakdown"
}
]
},
"debug": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FetchProfileDebug"
}
]
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.FetchProfile"
}
}
},
"required": [
"type",
"description",
"time_in_nanos",
"breakdown"
]
},
"_global.search._types.FetchProfileBreakdown": {
"type": "object",
"properties": {
"load_source": {
"type": "number"
},
"load_source_count": {
"type": "number"
},
"load_stored_fields": {
"type": "number"
},
"load_stored_fields_count": {
"type": "number"
},
"next_reader": {
"type": "number"
},
"next_reader_count": {
"type": "number"
},
"process_count": {
"type": "number"
},
"process": {
"type": "number"
}
}
},
"_global.search._types.FetchProfileDebug": {
"type": "object",
"properties": {
"stored_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"fast_path": {
"type": "number"
}
}
},
"_types.NodeId": {
"type": "string"
},
"_global.search._types.SearchProfile": {
"type": "object",
"properties": {
"collector": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Collector"
}
},
"query": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.QueryProfile"
}
},
"rewrite_time": {
"type": "number"
}
},
"required": [
"collector",
"query",
"rewrite_time"
]
},
"_global.search._types.Collector": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"reason": {
"type": "string"
},
"time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Collector"
}
}
},
"required": [
"name",
"reason",
"time_in_nanos"
]
},
"_global.search._types.QueryProfile": {
"type": "object",
"properties": {
"breakdown": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.QueryBreakdown"
}
]
},
"description": {
"type": "string"
},
"time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"type": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.QueryProfile"
}
}
},
"required": [
"breakdown",
"description",
"time_in_nanos",
"type"
]
},
"_global.search._types.QueryBreakdown": {
"type": "object",
"properties": {
"advance": {
"type": "number"
},
"advance_count": {
"type": "number"
},
"build_scorer": {
"type": "number"
},
"build_scorer_count": {
"type": "number"
},
"create_weight": {
"type": "number"
},
"create_weight_count": {
"type": "number"
},
"match": {
"type": "number"
},
"match_count": {
"type": "number"
},
"shallow_advance": {
"type": "number"
},
"shallow_advance_count": {
"type": "number"
},
"next_doc": {
"type": "number"
},
"next_doc_count": {
"type": "number"
},
"score": {
"type": "number"
},
"score_count": {
"type": "number"
},
"compute_max_score": {
"type": "number"
},
"compute_max_score_count": {
"type": "number"
},
"count_weight": {
"type": "number"
},
"count_weight_count": {
"type": "number"
},
"set_min_competitive_score": {
"type": "number"
},
"set_min_competitive_score_count": {
"type": "number"
}
},
"required": [
"advance",
"advance_count",
"build_scorer",
"build_scorer_count",
"create_weight",
"create_weight_count",
"match",
"match_count",
"shallow_advance",
"shallow_advance_count",
"next_doc",
"next_doc_count",
"score",
"score_count",
"compute_max_score",
"compute_max_score_count",
"count_weight",
"count_weight_count",
"set_min_competitive_score",
"set_min_competitive_score_count"
]
},
"_global.search._types.SearchRequestCoordinatorMetadata": {
"description": "Coordinator snapshot of the original search request, serialized under `profile.request` when profiling is enabled.\nIntroduced in Elasticsearch 9.5; omitted when the cluster contains mixed-version nodes that do not serialize this metadata.",
"type": "object",
"properties": {
"source": {
"description": "Original query source from the search request (`SearchSourceBuilder` as JSON).",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SearchRequestBody"
}
]
},
"indices": {
"description": "Target index expressions from the request (before index resolution).",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
}
},
"_global.search._types.SearchRequestBody": {
"type": "object",
"properties": {
"aggregations": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations"
},
"description": "Defines the aggregations that are run as part of the search request.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"collapse": {
"description": "Collapses search results the values of the specified field.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FieldCollapse"
}
]
},
"explain": {
"description": "If `true`, the request returns detailed information about score computation as part of a hit.",
"default": false,
"type": "boolean"
},
"ext": {
"description": "Configuration of search extensions defined by Elasticsearch plugins.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"from": {
"description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"default": 0,
"type": "number"
},
"highlight": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting"
},
"description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Highlight"
}
]
},
"track_total_hits": {
"description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.",
"default": "10000",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.TrackHits"
}
]
},
"indices_boost": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores"
},
"description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "number"
},
"minProperties": 1,
"maxProperties": 1
}
},
"docvalue_fields": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields"
},
"description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"knn": {
"externalDocs": {
"url": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn"
},
"description": "The approximate kNN search to run.",
"x-state": "Generally available; Added in 8.4.0",
"oneOf": [
{
"$ref": "#/components/schemas/_types.KnnSearch"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.KnnSearch"
}
}
]
},
"rank": {
"description": "The Reciprocal Rank Fusion (RRF) to use.",
"x-state": "Generally available; Added in 8.8.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.RankContainer"
}
]
},
"min_score": {
"description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results or results collected by aggregations.",
"type": "number"
},
"post_filter": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/filter-search-results"
},
"description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"profile": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-profile"
},
"description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.",
"default": false,
"type": "boolean"
},
"query": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl"
},
"description": "The search definition using the Query DSL.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"rescore": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/rescore-search-results"
},
"description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.",
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.Rescore"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Rescore"
}
}
]
},
"retriever": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers"
},
"description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.",
"x-state": "Generally available; Added in 8.14.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"script_fields": {
"description": "Retrieve a script evaluation (based on different fields) for each hit.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ScriptField"
}
},
"search_after": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after"
},
"description": "Used to retrieve the next page of hits using a set of sort values from the previous page.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
},
"size": {
"description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.",
"default": 10,
"type": "number"
},
"slice": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#slice-scroll"
},
"description": "Split a scrolled search into multiple slices that can be consumed independently.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SlicedScroll"
}
]
},
"sort": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results"
},
"description": "A comma-separated list of : pairs.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"_source": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering"
},
"description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"fields": {
"description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"suggest": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-suggesters"
},
"description": "Defines a suggester that provides similar looking terms based on a provided text.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Suggester"
}
]
},
"terminate_after": {
"description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.",
"default": 0,
"type": "number"
},
"timeout": {
"description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
"type": "string"
},
"track_scores": {
"description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.",
"default": false,
"type": "boolean"
},
"version": {
"description": "If `true`, the request returns the document version as part of a hit.",
"default": false,
"type": "boolean"
},
"seq_no_primary_term": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control"
},
"description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.",
"type": "boolean"
},
"stored_fields": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields"
},
"description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"pit": {
"description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.PointInTimeReference"
}
]
},
"runtime_mappings": {
"externalDocs": {
"url": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request"
},
"description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"stats": {
"description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"_types.aggregations.AggregationContainer": {
"allOf": [
{
"type": "object",
"properties": {
"aggregations": {
"description": "Sub-aggregations for this aggregation.\nOnly applies to bucket aggregations.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
}
},
{
"type": "object",
"properties": {
"adjacency_matrix": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation"
},
"description": "A bucket aggregation returning a form of adjacency matrix.\nThe request provides a collection of named filter expressions, similar to the `filters` aggregation.\nEach bucket in the response represents a non-empty cell in the matrix of intersecting filters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation"
}
]
},
"auto_date_histogram": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation"
},
"description": "A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AutoDateHistogramAggregation"
}
]
},
"avg": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation"
},
"description": "A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AverageAggregation"
}
]
},
"avg_bucket": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation"
},
"description": "A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.\nThe specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AverageBucketAggregation"
}
]
},
"boxplot": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation"
},
"description": "A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BoxplotAggregation"
}
]
},
"bucket_script": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation"
},
"description": "A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketScriptAggregation"
}
]
},
"bucket_selector": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation"
},
"description": "A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketSelectorAggregation"
}
]
},
"bucket_sort": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation"
},
"description": "A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketSortAggregation"
}
]
},
"bucket_count_ks_test": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation"
},
"description": "A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test (\"K-S test\") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.",
"x-state": "Experimental",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketKsAggregation"
}
]
},
"bucket_correlation": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation"
},
"description": "A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.",
"x-state": "Experimental",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketCorrelationAggregation"
}
]
},
"cardinality": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation"
},
"description": "A single-value metrics aggregation that calculates an approximate count of distinct values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation"
}
]
},
"cartesian_bounds": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cartesian-bounds-aggregation"
},
"description": "A metric aggregation that computes the spatial bounding box containing all values for a Point or Shape field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CartesianBoundsAggregation"
}
]
},
"cartesian_centroid": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cartesian-centroid-aggregation"
},
"description": "A metric aggregation that computes the weighted centroid from all coordinate values for point and shape fields.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CartesianCentroidAggregation"
}
]
},
"categorize_text": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation"
},
"description": "A multi-bucket aggregation that groups semi-structured text into buckets.",
"x-state": "Experimental",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CategorizeTextAggregation"
}
]
},
"change_point": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-change-point-aggregation"
},
"description": "A sibling pipeline that detects, spikes, dips, and change points in a metric.\nGiven a distribution of values provided by the sibling multi-bucket aggregation,\nthis aggregation indicates the bucket of any spike or dip and/or the bucket at which\nthe largest change in the distribution of values, if they are statistically significant.\nThere must be at least 22 bucketed values. Fewer than 1,000 is preferred.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ChangePointAggregation"
}
]
},
"children": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation"
},
"description": "A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ChildrenAggregation"
}
]
},
"composite": {
"description": "A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregation"
}
]
},
"cumulative_cardinality": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation"
},
"description": "A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation"
}
]
},
"cumulative_sum": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation"
},
"description": "A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CumulativeSumAggregation"
}
]
},
"date_histogram": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation"
},
"description": "A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation"
}
]
},
"date_range": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation"
},
"description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation"
}
]
},
"derivative": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation"
},
"description": "A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.DerivativeAggregation"
}
]
},
"diversified_sampler": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation"
},
"description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.\nSimilar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation"
}
]
},
"extended_stats": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation"
},
"description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregation"
}
]
},
"extended_stats_bucket": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation"
},
"description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation"
}
]
},
"frequent_item_sets": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation"
},
"description": "A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsAggregation"
}
]
},
"filter": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation"
},
"description": "A single bucket aggregation that narrows the set of documents to those that match a query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"filters": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation"
},
"description": "A multi-bucket aggregation where each bucket contains the documents that match a query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FiltersAggregation"
}
]
},
"geo_bounds": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation"
},
"description": "A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoBoundsAggregation"
}
]
},
"geo_centroid": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation"
},
"description": "A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoCentroidAggregation"
}
]
},
"geo_distance": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation"
},
"description": "A multi-bucket aggregation that works on `geo_point` fields.\nEvaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoDistanceAggregation"
}
]
},
"geohash_grid": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation"
},
"description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell is labeled using a geohash which is of user-definable precision.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoHashGridAggregation"
}
]
},
"geo_line": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line"
},
"description": "Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation"
}
]
},
"geotile_grid": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation"
},
"description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a map tile as used by many online map sites.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation"
}
]
},
"geohex_grid": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation"
},
"description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a H3 cell index and is labeled using the H3Index representation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeohexGridAggregation"
}
]
},
"global": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation"
},
"description": "Defines a single bucket of all the documents within the search execution context.\nThis context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GlobalAggregation"
}
]
},
"histogram": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation"
},
"description": "A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.HistogramAggregation"
}
]
},
"ip_range": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation"
},
"description": "A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.IpRangeAggregation"
}
]
},
"ip_prefix": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation"
},
"description": "A bucket aggregation that groups documents based on the network or sub-network of an IP address.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.IpPrefixAggregation"
}
]
},
"inference": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation"
},
"description": "A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.InferenceAggregation"
}
]
},
"line": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation"
}
]
},
"matrix_stats": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation"
},
"description": "A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MatrixStatsAggregation"
}
]
},
"max": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation"
},
"description": "A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MaxAggregation"
}
]
},
"max_bucket": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation"
},
"description": "A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MaxBucketAggregation"
}
]
},
"median_absolute_deviation": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation"
},
"description": "A single-value aggregation that approximates the median absolute deviation of its search results.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation"
}
]
},
"min": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation"
},
"description": "A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MinAggregation"
}
]
},
"min_bucket": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation"
},
"description": "A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MinBucketAggregation"
}
]
},
"missing": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation"
},
"description": "A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MissingAggregation"
}
]
},
"moving_avg": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregation"
}
]
},
"moving_percentiles": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation"
},
"description": "Given an ordered series of percentiles, \"slides\" a window across those percentiles and computes cumulative percentiles.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MovingPercentilesAggregation"
}
]
},
"moving_fn": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation"
},
"description": "Given an ordered series of data, \"slides\" a window across the data and runs a custom script on each window of data.\nFor convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MovingFunctionAggregation"
}
]
},
"multi_terms": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation"
},
"description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregation"
}
]
},
"nested": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation"
},
"description": "A special single bucket aggregation that enables aggregating nested documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.NestedAggregation"
}
]
},
"normalize": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation"
},
"description": "A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.NormalizeAggregation"
}
]
},
"parent": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation"
},
"description": "A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ParentAggregation"
}
]
},
"percentile_ranks": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation"
},
"description": "A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentileRanksAggregation"
}
]
},
"percentiles": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation"
},
"description": "A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentilesAggregation"
}
]
},
"percentiles_bucket": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation"
},
"description": "A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentilesBucketAggregation"
}
]
},
"range": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation"
},
"description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.RangeAggregation"
}
]
},
"rare_terms": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation"
},
"description": "A multi-bucket value source based aggregation which finds \"rare\" terms — terms that are at the long-tail of the distribution and are not frequent.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.RareTermsAggregation"
}
]
},
"rate": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation"
},
"description": "Calculates a rate of documents or a field in each bucket.\nCan only be used inside a `date_histogram` or `composite` aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.RateAggregation"
}
]
},
"reverse_nested": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation"
},
"description": "A special single bucket aggregation that enables aggregating on parent documents from nested documents.\nShould only be defined inside a `nested` aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ReverseNestedAggregation"
}
]
},
"random_sampler": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation"
},
"description": "A single bucket aggregation that randomly includes documents in the aggregated results.\nSampling provides significant speed improvement at the cost of accuracy.",
"x-state": "Experimental; Added in 8.1.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.RandomSamplerAggregation"
}
]
},
"sampler": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation"
},
"description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SamplerAggregation"
}
]
},
"scripted_metric": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation"
},
"description": "A metric aggregation that uses scripts to provide a metric output.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ScriptedMetricAggregation"
}
]
},
"serial_diff": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation"
},
"description": "An aggregation that subtracts values in a time series from themselves at different time lags or periods.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SerialDifferencingAggregation"
}
]
},
"significant_terms": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation"
},
"description": "Returns interesting or unusual occurrences of terms in a set.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregation"
}
]
},
"significant_text": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation"
},
"description": "Returns interesting or unusual occurrences of free-text terms in a set.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SignificantTextAggregation"
}
]
},
"stats": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation"
},
"description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.StatsAggregation"
}
]
},
"stats_bucket": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation"
},
"description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.StatsBucketAggregation"
}
]
},
"string_stats": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation"
},
"description": "A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.StringStatsAggregation"
}
]
},
"sum": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation"
},
"description": "A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SumAggregation"
}
]
},
"sum_bucket": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation"
},
"description": "A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SumBucketAggregation"
}
]
},
"terms": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation"
},
"description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregation"
}
]
},
"time_series": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation"
},
"description": "The time series aggregation queries data created using a time series index.\nThis is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.",
"x-state": "Experimental",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TimeSeriesAggregation"
}
]
},
"top_hits": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation"
},
"description": "A metric aggregation that returns the top matching documents per bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TopHitsAggregation"
}
]
},
"t_test": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation"
},
"description": "A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TTestAggregation"
}
]
},
"top_metrics": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics"
},
"description": "A metric aggregation that selects metrics from the document with the largest or smallest sort value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TopMetricsAggregation"
}
]
},
"value_count": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation"
},
"description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation"
}
]
},
"weighted_avg": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation"
},
"description": "A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.WeightedAverageAggregation"
}
]
},
"variable_width_histogram": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation"
},
"description": "A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"_types.aggregations.AdjacencyMatrixAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"filters": {
"description": "Filters used to create buckets.\nAt least one filter is required.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
},
"separator": {
"description": "Separator used to concatenate filter names. Defaults to &.",
"type": "string"
}
}
}
]
},
"_types.query_dsl.QueryContainer": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl"
},
"description": "An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.",
"type": "object",
"properties": {
"bool": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query"
},
"description": "matches documents matching boolean combinations of other queries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.BoolQuery"
}
]
},
"boosting": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query"
},
"description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.BoostingQuery"
}
]
},
"common": {
"deprecated": true,
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.CommonTermsQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"combined_fields": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query"
},
"description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.",
"x-state": "Generally available; Added in 7.13.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsQuery"
}
]
},
"constant_score": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query"
},
"description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ConstantScoreQuery"
}
]
},
"dis_max": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query"
},
"description": "Returns documents matching one or more wrapped queries, called query clauses or clauses.\nIf a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DisMaxQuery"
}
]
},
"distance_feature": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query"
},
"description": "Boosts the relevance score of documents closer to a provided origin date or point.\nFor example, you can use this query to give more weight to documents closer to a certain date or location.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQuery"
}
]
},
"exists": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query"
},
"description": "Returns documents that contain an indexed value for a field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ExistsQuery"
}
]
},
"function_score": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query"
},
"description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.FunctionScoreQuery"
}
]
},
"fuzzy": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query"
},
"description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.FuzzyQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"geo_bounding_box": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query"
},
"description": "Matches geo_point and geo_shape values that intersect a bounding box.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery"
}
]
},
"geo_distance": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query"
},
"description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.GeoDistanceQuery"
}
]
},
"geo_grid": {
"description": "Matches `geo_point` and `geo_shape` values that intersect a grid cell from a GeoGrid aggregation.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.GeoGridQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"geo_polygon": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.GeoPolygonQuery"
}
]
},
"geo_shape": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query"
},
"description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.GeoShapeQuery"
}
]
},
"has_child": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query"
},
"description": "Returns parent documents whose joined child documents match a provided query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.HasChildQuery"
}
]
},
"has_parent": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query"
},
"description": "Returns child documents whose joined parent document matches a provided query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.HasParentQuery"
}
]
},
"ids": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query"
},
"description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IdsQuery"
}
]
},
"intervals": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query"
},
"description": "Returns documents based on the order and proximity of matching terms.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.IntervalsQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"knn": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query"
},
"description": "Finds the k nearest vectors to a query vector, as measured by a similarity\nmetric. knn query finds nearest vectors through approximate search on indexed\ndense_vectors.",
"allOf": [
{
"$ref": "#/components/schemas/_types.KnnQuery"
}
]
},
"match": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query"
},
"description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.MatchQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"match_all": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query"
},
"description": "Matches all documents, giving them all a `_score` of 1.0.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery"
}
]
},
"match_bool_prefix": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query"
},
"description": "Analyzes its input and constructs a `bool` query from the terms.\nEach term except the last is used in a `term` query.\nThe last term is used in a prefix query.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.MatchBoolPrefixQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"match_none": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query"
},
"description": "Matches no documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MatchNoneQuery"
}
]
},
"match_phrase": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase"
},
"description": "Analyzes the text and creates a phrase query out of the analyzed text.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.MatchPhraseQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"match_phrase_prefix": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix"
},
"description": "Returns documents that contain the words of a provided text, in the same order as provided.\nThe last term of the provided text is treated as a prefix, matching any words that begin with that term.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.MatchPhrasePrefixQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"more_like_this": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query"
},
"description": "Returns documents that are \"like\" a given set of documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MoreLikeThisQuery"
}
]
},
"multi_match": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query"
},
"description": "Enables you to search for a provided text, number, date or boolean value across multiple fields.\nThe provided text is analyzed before matching.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MultiMatchQuery"
}
]
},
"nested": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query"
},
"description": "Wraps another query to search nested fields.\nIf an object matches the search, the nested query returns the root parent document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.NestedQuery"
}
]
},
"parent_id": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query"
},
"description": "Returns child documents joined to a specific parent document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ParentIdQuery"
}
]
},
"percolate": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query"
},
"description": "Matches queries stored in an index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.PercolateQuery"
}
]
},
"pinned": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query"
},
"description": "Promotes selected documents to rank higher than those matching a given query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.PinnedQuery"
}
]
},
"prefix": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query"
},
"description": "Returns documents that contain a specific prefix in a provided field.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.PrefixQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"query_string": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query"
},
"description": "Returns documents based on a provided query string, using a parser with a strict syntax.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryStringQuery"
}
]
},
"range": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query"
},
"description": "Returns documents that contain terms within a provided range.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.RangeQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"rank_feature": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query"
},
"description": "Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureQuery"
}
]
},
"regexp": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query"
},
"description": "Returns documents that contain terms matching a regular expression.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.RegexpQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"rule": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RuleQuery"
}
]
},
"script": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query"
},
"description": "Filters documents based on a provided script.\nThe script query is typically used in a filter context.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ScriptQuery"
}
]
},
"script_score": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query"
},
"description": "Uses a script to provide a custom score for returned documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ScriptScoreQuery"
}
]
},
"semantic": {
"description": "A semantic query to semantic_text field types",
"x-state": "Generally available; Added in 8.15.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SemanticQuery"
}
]
},
"shape": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query"
},
"description": "Queries documents that contain fields indexed using the `shape` type.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ShapeQuery"
}
]
},
"simple_query_string": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query"
},
"description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery"
}
]
},
"span_containing": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query"
},
"description": "Returns matches which enclose another span query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery"
}
]
},
"span_field_masking": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query"
},
"description": "Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery"
}
]
},
"span_first": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query"
},
"description": "Matches spans near the beginning of a field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery"
}
]
},
"span_multi": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query"
},
"description": "Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery"
}
]
},
"span_near": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query"
},
"description": "Matches spans which are near one another.\nYou can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery"
}
]
},
"span_not": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query"
},
"description": "Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery"
}
]
},
"span_or": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query"
},
"description": "Matches the union of its span clauses.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery"
}
]
},
"span_term": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query"
},
"description": "Matches spans containing a term.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.SpanTermQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"span_within": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query"
},
"description": "Returns matches which are enclosed inside another span query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery"
}
]
},
"sparse_vector": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query"
},
"description": "Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.",
"x-state": "Generally available; Added in 8.15.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SparseVectorQuery"
}
]
},
"term": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query"
},
"description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.TermQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"terms": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query"
},
"description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.TermsQuery"
}
]
},
"terms_set": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query"
},
"description": "Returns documents that contain a minimum number of exact terms in a provided field.\nTo return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.TermsSetQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"text_expansion": {
"deprecated": true,
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query"
},
"description": "Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.",
"x-state": "Generally available; Added in 8.8.0",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.TextExpansionQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"weighted_tokens": {
"deprecated": true,
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query"
},
"description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.",
"x-state": "Generally available; Added in 8.13.0",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.WeightedTokensQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"wildcard": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query"
},
"description": "Returns documents that contain terms matching a wildcard pattern.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.WildcardQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"wrapper": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query"
},
"description": "A query that accepts any other query as base64 encoded string.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.WrapperQuery"
}
]
},
"type": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.TypeQuery"
}
]
}
},
"minProperties": 1,
"maxProperties": 1,
"x-model": true
},
"_types.query_dsl.BoolQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"filter": {
"description": "The clause (query) must appear in matching documents.\nHowever, unlike `must`, the score of the query will be ignored.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
},
"minimum_should_match": {
"description": "Specifies the number or percentage of `should` clauses returned documents must match.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"must": {
"description": "The clause (query) must appear in matching documents and will contribute to the score.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
},
"must_not": {
"description": "The clause (query) must not appear in the matching documents.\nBecause scoring is ignored, a score of `0` is returned for all documents.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
},
"should": {
"description": "The clause (query) should appear in the matching document.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
}
}
}
],
"x-model": true
},
"_types.MinimumShouldMatch": {
"description": "The minimum number of terms that should match as integer, percentage or range",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"_types.query_dsl.QueryBase": {
"type": "object",
"properties": {
"boost": {
"description": "Floating point number used to decrease or increase the relevance scores of the query.\nBoost values are relative to the default value of 1.0.\nA boost value between 0 and 1.0 decreases the relevance score.\nA value greater than 1.0 increases the relevance score.",
"default": 1,
"type": "number"
},
"_name": {
"type": "string"
}
},
"x-model": true
},
"_types.query_dsl.BoostingQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"negative_boost": {
"description": "Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query.",
"type": "number"
},
"negative": {
"description": "Query used to decrease the relevance score of matching documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"positive": {
"description": "Any returned documents must match this query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"negative_boost",
"negative",
"positive"
]
}
],
"x-model": true
},
"_types.query_dsl.CommonTermsQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"cutoff_frequency": {
"type": "number"
},
"high_freq_operator": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Operator"
}
]
},
"low_freq_operator": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Operator"
}
]
},
"minimum_should_match": {
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"query": {
"type": "string"
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.Operator": {
"type": "string",
"enum": [
"and",
"AND",
"or",
"OR"
]
},
"_types.query_dsl.CombinedFieldsQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"fields": {
"description": "List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"query": {
"description": "Text to search for in the provided `fields`.\nThe `combined_fields` query analyzes the provided text before performing a search.",
"type": "string"
},
"auto_generate_synonyms_phrase_query": {
"description": "If true, match phrase queries are automatically created for multi-term synonyms.",
"default": true,
"type": "boolean"
},
"operator": {
"description": "Boolean logic used to interpret text in the query value.",
"default": "or",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsOperator"
}
]
},
"minimum_should_match": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match"
},
"description": "Minimum number of clauses that must match for a document to be returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"zero_terms_query": {
"description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `none`: No documents are returned if the analyzer removes all tokens.\n - `all`: Returns all documents, similar to a `match_all` query.\n\n",
"default": "none",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms"
}
]
}
},
"required": [
"fields",
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.CombinedFieldsOperator": {
"type": "string",
"enum": [
"or",
"and"
]
},
"_types.query_dsl.CombinedFieldsZeroTerms": {
"type": "string",
"enum": [
"none",
"all"
]
},
"_types.query_dsl.ConstantScoreQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"filter": {
"description": "Filter query you wish to run. Any returned documents must match this query.\nFilter queries do not calculate relevance scores.\nTo speed up performance, Elasticsearch automatically caches frequently used filter queries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"filter"
]
}
],
"x-model": true
},
"_types.query_dsl.DisMaxQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"queries": {
"description": "One or more query clauses.\nReturned documents must match one or more of these queries.\nIf a document matches multiple queries, Elasticsearch uses the highest relevance score.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
},
"tie_breaker": {
"description": "Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.",
"default": 0,
"type": "number"
}
},
"required": [
"queries"
]
}
],
"x-model": true
},
"_types.query_dsl.DistanceFeatureQuery": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query"
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.UntypedDistanceFeatureQuery"
},
{
"$ref": "#/components/schemas/_types.query_dsl.GeoDistanceFeatureQuery"
},
{
"$ref": "#/components/schemas/_types.query_dsl.DateDistanceFeatureQuery"
}
],
"x-model": true
},
"_types.query_dsl.UntypedDistanceFeatureQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQueryBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.DistanceFeatureQueryBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"origin": {
"description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.",
"type": "object"
},
"pivot": {
"description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.",
"type": "object"
},
"field": {
"description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"origin",
"pivot",
"field"
]
}
],
"x-model": true
},
"_types.query_dsl.GeoDistanceFeatureQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"origin": {
"description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
},
"pivot": {
"description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Distance"
}
]
},
"field": {
"description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"origin",
"pivot",
"field"
]
}
],
"x-model": true
},
"_types.Distance": {
"type": "string"
},
"_types.query_dsl.DateDistanceFeatureQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"origin": {
"description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateMath"
}
]
},
"pivot": {
"description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"field": {
"description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"origin",
"pivot",
"field"
]
}
],
"x-model": true
},
"_types.DateMath": {
"type": "string"
},
"_types.query_dsl.ExistsQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "Name of the field you wish to search.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
],
"x-model": true
},
"_types.query_dsl.FunctionScoreQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"boost_mode": {
"description": "Defines how he newly computed score is combined with the score of the query\n\nSupported values include:\n - `multiply`: Query score and function score are multiplied\n - `replace`: Only the function score is used.\nThe query score is ignored.\n - `sum`: Query score and function score are added\n - `avg`: Query score and function score are averaged\n - `max`: Max of query score and function score\n - `min`: Min of query score and function score\n\n",
"default": "multiply",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.FunctionBoostMode"
}
]
},
"functions": {
"description": "One or more functions that compute a new score for each document returned by the query.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FunctionScoreContainer"
}
},
"max_boost": {
"description": "Restricts the new score to not exceed the provided limit.",
"type": "number"
},
"min_score": {
"description": "Excludes documents that do not meet the provided score threshold.",
"type": "number"
},
"query": {
"description": "A query that determines the documents for which a new score is computed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"score_mode": {
"description": "Specifies how the computed scores are combined\n\nSupported values include:\n - `multiply`: Scores are multiplied.\n - `sum`: Scores are summed.\n - `avg`: Scores are averaged.\n - `first`: The first function that has a matching filter is applied.\n - `max`: Maximum score is used.\n - `min`: Minimum score is used.\n\n",
"default": "multiply",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.FunctionScoreMode"
}
]
}
}
}
],
"x-model": true
},
"_types.query_dsl.FunctionBoostMode": {
"type": "string",
"enum": [
"multiply",
"replace",
"sum",
"avg",
"max",
"min"
]
},
"_types.query_dsl.FunctionScoreContainer": {
"allOf": [
{
"type": "object",
"properties": {
"filter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"weight": {
"type": "number"
},
"_name": {
"description": "A name to identify which function matched and influenced the score.",
"x-state": "Generally available; Added in 9.4.0",
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"exp": {
"description": "Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DecayFunction"
}
]
},
"gauss": {
"description": "Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DecayFunction"
}
]
},
"linear": {
"description": "Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DecayFunction"
}
]
},
"field_value_factor": {
"description": "Function allows you to use a field from a document to influence the score.\nIt’s similar to using the script_score function, however, it avoids the overhead of scripting.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction"
}
]
},
"random_score": {
"description": "Generates scores that are uniformly distributed from 0 up to but not including 1.\nIn case you want scores to be reproducible, it is possible to provide a `seed` and `field`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RandomScoreFunction"
}
]
},
"script_score": {
"description": "Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ScriptScoreFunction"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
],
"x-model": true
},
"_types.query_dsl.DecayFunction": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.UntypedDecayFunction"
},
{
"$ref": "#/components/schemas/_types.query_dsl.DateDecayFunction"
},
{
"$ref": "#/components/schemas/_types.query_dsl.NumericDecayFunction"
},
{
"$ref": "#/components/schemas/_types.query_dsl.GeoDecayFunction"
}
],
"x-model": true
},
"_types.query_dsl.UntypedDecayFunction": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DecayFunctionBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.DecayFunctionBase": {
"type": "object",
"properties": {
"multi_value_mode": {
"description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n - `min`: Distance is the minimum distance.\n - `max`: Distance is the maximum distance.\n - `avg`: Distance is the average distance.\n - `sum`: Distance is the sum of all distances.\n\n",
"default": "min",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MultiValueMode"
}
]
}
},
"x-model": true
},
"_types.query_dsl.MultiValueMode": {
"type": "string",
"enum": [
"min",
"max",
"avg",
"sum"
],
"x-model": true
},
"_types.query_dsl.DateDecayFunction": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DecayFunctionBaseDateMathDuration"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.DecayFunctionBaseDateMathDuration": {
"type": "object",
"properties": {
"multi_value_mode": {
"description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n - `min`: Distance is the minimum distance.\n - `max`: Distance is the maximum distance.\n - `avg`: Distance is the average distance.\n - `sum`: Distance is the sum of all distances.\n\n",
"default": "min",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MultiValueMode"
}
]
}
},
"x-model": true
},
"_types.query_dsl.NumericDecayFunction": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DecayFunctionBasedoubledouble"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.DecayFunctionBasedoubledouble": {
"type": "object",
"properties": {
"multi_value_mode": {
"description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n - `min`: Distance is the minimum distance.\n - `max`: Distance is the maximum distance.\n - `avg`: Distance is the average distance.\n - `sum`: Distance is the sum of all distances.\n\n",
"default": "min",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MultiValueMode"
}
]
}
},
"x-model": true
},
"_types.query_dsl.GeoDecayFunction": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.DecayFunctionBaseGeoLocationDistance"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.DecayFunctionBaseGeoLocationDistance": {
"type": "object",
"properties": {
"multi_value_mode": {
"description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n - `min`: Distance is the minimum distance.\n - `max`: Distance is the maximum distance.\n - `avg`: Distance is the average distance.\n - `sum`: Distance is the sum of all distances.\n\n",
"default": "min",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MultiValueMode"
}
]
}
},
"x-model": true
},
"_types.query_dsl.FieldValueFactorScoreFunction": {
"type": "object",
"properties": {
"field": {
"description": "Field to be extracted from the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"factor": {
"description": "Optional factor to multiply the field value with.",
"default": 1,
"type": "number"
},
"missing": {
"description": "Value used if the document doesn’t have that field.\nThe modifier and factor are still applied to it as though it were read from the document.",
"type": "number"
},
"modifier": {
"description": "Modifier to apply to the field value.\n\nSupported values include:\n - `none`: Do not apply any multiplier to the field value.\n - `log`: Take the common logarithm of the field value.\nBecause this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `log1p` instead.\n - `log1p`: Add 1 to the field value and take the common logarithm.\n - `log2p`: Add 2 to the field value and take the common logarithm.\n - `ln`: Take the natural logarithm of the field value.\nBecause this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `ln1p` instead.\n - `ln1p`: Add 1 to the field value and take the natural logarithm.\n - `ln2p`: Add 2 to the field value and take the natural logarithm.\n - `square`: Square the field value (multiply it by itself).\n - `sqrt`: Take the square root of the field value.\n - `reciprocal`: Reciprocate the field value, same as `1/x` where `x` is the field’s value.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorModifier"
}
]
}
},
"required": [
"field"
],
"x-model": true
},
"_types.query_dsl.FieldValueFactorModifier": {
"type": "string",
"enum": [
"none",
"log",
"log1p",
"log2p",
"ln",
"ln1p",
"ln2p",
"square",
"sqrt",
"reciprocal"
]
},
"_types.query_dsl.RandomScoreFunction": {
"type": "object",
"properties": {
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"seed": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
}
},
"x-model": true
},
"_types.query_dsl.ScriptScoreFunction": {
"type": "object",
"properties": {
"script": {
"description": "A script that computes a score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"script"
],
"x-model": true
},
"_types.Script": {
"type": "object",
"properties": {
"source": {
"description": "The script source.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSource"
}
]
},
"id": {
"description": "The `id` for a stored script.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"params": {
"description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"lang": {
"description": "Specifies the language the script is written in.\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
"default": "painless",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptLanguage"
}
]
},
"options": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"_types.ScriptSource": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/_global.search._types.SearchRequestBody"
}
]
},
"_types.ScriptLanguage": {
"anyOf": [
{
"type": "string",
"enum": [
"painless",
"expression",
"mustache",
"java"
]
},
{
"type": "string"
}
]
},
"_types.query_dsl.FunctionScoreMode": {
"type": "string",
"enum": [
"multiply",
"sum",
"avg",
"first",
"max",
"min"
]
},
"_types.query_dsl.FuzzyQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"max_expansions": {
"description": "Maximum number of variations created.",
"default": 50,
"type": "number"
},
"prefix_length": {
"description": "Number of beginning characters left unchanged when creating expansions.",
"default": 0,
"type": "number"
},
"rewrite": {
"description": "Number of beginning characters left unchanged when creating expansions.",
"default": "constant_score",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"transpositions": {
"description": "Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).",
"default": true,
"type": "boolean"
},
"fuzziness": {
"description": "Maximum edit distance allowed for matching.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fuzziness"
}
]
},
"value": {
"description": "Term you wish to find in the provided field.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.MultiTermQueryRewrite": {
"type": "string"
},
"_types.Fuzziness": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"_types.query_dsl.GeoBoundingBoxQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"type": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.GeoExecution"
}
]
},
"validation_method": {
"description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.\n\nSupported values include:\n - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n - `strict`\n\n",
"default": "'strict'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod"
}
]
},
"ignore_unmapped": {
"description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.",
"default": false,
"type": "boolean"
}
}
}
],
"x-model": true
},
"_types.query_dsl.GeoExecution": {
"type": "string",
"enum": [
"memory",
"indexed"
]
},
"_types.query_dsl.GeoValidationMethod": {
"type": "string",
"enum": [
"coerce",
"ignore_malformed",
"strict"
]
},
"_types.query_dsl.GeoDistanceQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"distance": {
"description": "The radius of the circle centred on the specified location.\nPoints which fall into this circle are considered to be matches.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Distance"
}
]
},
"distance_type": {
"description": "How to compute the distance.\nSet to `plane` for a faster calculation that's inaccurate on long distances and close to the poles.\n\nSupported values include:\n - `arc`: The `arc` calculation is the most accurate.\n - `plane`: The `plane` calculation is faster but less accurate.\n\n",
"default": "'arc'",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoDistanceType"
}
]
},
"validation_method": {
"description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.\n\nSupported values include:\n - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n - `strict`\n\n",
"default": "'strict'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod"
}
]
},
"ignore_unmapped": {
"description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.",
"default": false,
"type": "boolean"
}
},
"required": [
"distance"
]
}
],
"x-model": true
},
"_types.GeoDistanceType": {
"type": "string",
"enum": [
"arc",
"plane"
]
},
"_types.query_dsl.GeoGridQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"geotile": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoTile"
}
]
},
"geohash": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoHash"
}
]
},
"geohex": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoHexCell"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"_types.query_dsl.GeoPolygonQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"validation_method": {
"description": "\n\nSupported values include:\n - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n - `strict`\n\n",
"default": "'strict'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod"
}
]
},
"ignore_unmapped": {
"type": "boolean"
}
}
}
],
"x-model": true
},
"_types.query_dsl.GeoShapeQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"ignore_unmapped": {
"description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.",
"default": false,
"type": "boolean"
}
}
}
],
"x-model": true
},
"_types.query_dsl.HasChildQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"ignore_unmapped": {
"description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.",
"default": false,
"type": "boolean"
},
"inner_hits": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits"
},
"description": "If defined, each search hit will contain inner hits.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.InnerHits"
}
]
},
"max_children": {
"description": "Maximum number of child documents that match the query allowed for a returned parent document.\nIf the parent document exceeds this limit, it is excluded from the search results.",
"type": "number"
},
"min_children": {
"description": "Minimum number of child documents that match the query required to match the query for a returned parent document.\nIf the parent document does not meet this limit, it is excluded from the search results.",
"type": "number"
},
"query": {
"description": "Query you wish to run on child documents of the `type` field.\nIf a child document matches the search, the query returns the parent document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"score_mode": {
"description": "Indicates how scores for matching child documents affect the root parent document’s relevance score.",
"default": "'none'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode"
}
]
},
"type": {
"description": "Name of the child relationship mapped for the `join` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RelationName"
}
]
}
},
"required": [
"query",
"type"
]
}
],
"x-model": true
},
"_global.search._types.InnerHits": {
"type": "object",
"properties": {
"name": {
"description": "The name for the particular inner hit definition in the response.\nUseful when a search request contains multiple inner hits.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"size": {
"description": "The maximum number of hits to return per `inner_hits`.",
"default": 3,
"type": "number"
},
"from": {
"description": "Inner hit starting document offset.",
"default": 0,
"type": "number"
},
"collapse": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FieldCollapse"
}
]
},
"docvalue_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"explain": {
"type": "boolean"
},
"highlight": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Highlight"
}
]
},
"ignore_unmapped": {
"type": "boolean"
},
"script_fields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ScriptField"
}
},
"seq_no_primary_term": {
"type": "boolean"
},
"field": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"sort": {
"description": "How the inner hits should be sorted per `inner_hits`.\nBy default, inner hits are sorted by score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"_source": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"stored_fields": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"track_scores": {
"default": false,
"type": "boolean"
},
"version": {
"type": "boolean"
}
}
},
"_types.Name": {
"type": "string"
},
"_global.search._types.FieldCollapse": {
"type": "object",
"properties": {
"field": {
"description": "The field to collapse the result set on",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"inner_hits": {
"description": "The number of inner hits and their sort order",
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.InnerHits"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.InnerHits"
}
}
]
},
"max_concurrent_group_searches": {
"description": "The number of concurrent requests allowed to retrieve the inner_hits per group",
"type": "number"
},
"collapse": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FieldCollapse"
}
]
}
},
"required": [
"field"
],
"x-model": true,
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results"
}
},
"_types.query_dsl.FieldAndFormat": {
"description": "A reference to a field with formatting instructions on how to return the value",
"type": "object",
"properties": {
"field": {
"description": "A wildcard pattern. The request returns values for field names matching this pattern.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"format": {
"description": "The format in which the values are returned.",
"type": "string"
},
"include_unmapped": {
"type": "boolean"
}
},
"required": [
"field"
]
},
"_global.search._types.Highlight": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HighlightBase"
},
{
"type": "object",
"properties": {
"encoder": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HighlighterEncoder"
}
]
},
"fields": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.search._types.HighlightField"
},
"minProperties": 1,
"maxProperties": 1
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.search._types.HighlightField"
},
"minProperties": 1,
"maxProperties": 1
}
}
]
}
},
"required": [
"fields"
]
}
]
},
"_global.search._types.HighlighterEncoder": {
"type": "string",
"enum": [
"default",
"html"
]
},
"_global.search._types.HighlightField": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HighlightBase"
},
{
"type": "object",
"properties": {
"fragment_offset": {
"type": "number"
},
"matched_fields": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
}
}
}
]
},
"_types.Fields": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Field"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
}
]
},
"_global.search._types.HighlightBase": {
"type": "object",
"properties": {
"type": {
"description": "\n\nSupported values include:\n - `plain`: The `plain` highlighter uses the standard Lucene highlighter\n - `fvh`: The fvh highlighter uses the Lucene Fast Vector highlighter.\n - `unified`: The unified highlighter uses the Lucene Unified Highlighter.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HighlighterType"
}
]
},
"boundary_chars": {
"description": "A string that contains each boundary character.",
"default": ".,!? \\t\\n",
"type": "string"
},
"boundary_max_scan": {
"description": "How far to scan for boundary characters.",
"default": 20,
"type": "number"
},
"boundary_scanner": {
"description": "Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter.\n\nSupported values include:\n - `chars`: Use the characters specified by `boundary_chars` as highlighting boundaries.\nThe `boundary_max_scan` setting controls how far to scan for boundary characters.\nOnly valid for the `fvh` highlighter.\n - `sentence`: Break highlighted fragments at the next sentence boundary, as determined by Java’s `BreakIterator`.\nYou can specify the locale to use with `boundary_scanner_locale`.\nWhen used with the `unified` highlighter, the `sentence` scanner splits sentences bigger than `fragment_size` at the first word boundary next to fragment_size.\nYou can set `fragment_size` to `0` to never split any sentence.\n - `word`: Break highlighted fragments at the next word boundary, as determined by Java’s `BreakIterator`.\nYou can specify the locale to use with `boundary_scanner_locale`.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.BoundaryScanner"
}
]
},
"boundary_scanner_locale": {
"description": "Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`.",
"default": "Locale.ROOT",
"type": "string"
},
"force_source": {
"deprecated": true,
"type": "boolean"
},
"fragmenter": {
"description": "Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter.",
"default": "span",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HighlighterFragmenter"
}
]
},
"fragment_size": {
"description": "The size of the highlighted fragment in characters.",
"default": 100,
"type": "number"
},
"highlight_filter": {
"type": "boolean"
},
"highlight_query": {
"description": "Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"max_fragment_length": {
"type": "number"
},
"max_analyzed_offset": {
"description": "If set to a non-negative value, highlighting stops at this defined maximum limit.\nThe rest of the text is not processed, thus not highlighted and no error is returned\nThe `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting.",
"type": "number"
},
"no_match_size": {
"description": "The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.",
"default": 0,
"type": "number"
},
"number_of_fragments": {
"description": "The maximum number of fragments to return.\nIf the number of fragments is set to `0`, no fragments are returned.\nInstead, the entire field contents are highlighted and returned.\nThis can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.\nIf `number_of_fragments` is `0`, `fragment_size` is ignored.",
"default": 5,
"type": "number"
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"order": {
"description": "Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores.",
"default": "none",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HighlighterOrder"
}
]
},
"phrase_limit": {
"description": "Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter.",
"default": 256,
"type": "number"
},
"post_tags": {
"description": "Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `` and `` tags.",
"type": "array",
"items": {
"type": "string"
}
},
"pre_tags": {
"description": "Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `` and `` tags.",
"type": "array",
"items": {
"type": "string"
}
},
"require_field_match": {
"description": "By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields.",
"default": true,
"type": "boolean"
},
"tags_schema": {
"description": "Set to `styled` to use the built-in tag schema.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HighlighterTagsSchema"
}
]
}
}
},
"_global.search._types.HighlighterType": {
"anyOf": [
{
"type": "string",
"enum": [
"plain",
"fvh",
"unified"
]
},
{
"type": "string"
}
]
},
"_global.search._types.BoundaryScanner": {
"type": "string",
"enum": [
"chars",
"sentence",
"word"
]
},
"_global.search._types.HighlighterFragmenter": {
"type": "string",
"enum": [
"simple",
"span"
]
},
"_global.search._types.HighlighterOrder": {
"type": "string",
"enum": [
"score"
]
},
"_global.search._types.HighlighterTagsSchema": {
"type": "string",
"enum": [
"styled"
]
},
"_types.ScriptField": {
"type": "object",
"properties": {
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"ignore_failure": {
"type": "boolean"
}
},
"required": [
"script"
]
},
"_types.Sort": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.SortCombinations"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.SortCombinations"
}
}
]
},
"_types.SortCombinations": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Field"
},
{
"$ref": "#/components/schemas/_types.SortOptions"
}
]
},
"_types.SortOptions": {
"type": "object",
"properties": {
"_score": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScoreSort"
}
]
},
"_doc": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScoreSort"
}
]
},
"_geo_distance": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoDistanceSort"
}
]
},
"_script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSort"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.ScoreSort": {
"type": "object",
"properties": {
"order": {
"description": "\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortOrder"
}
]
}
}
},
"_types.SortOrder": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"_types.GeoDistanceSort": {
"type": "object",
"properties": {
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SortMode"
}
]
},
"distance_type": {
"description": "\n\nSupported values include:\n - `arc`: The `arc` calculation is the most accurate.\n - `plane`: The `plane` calculation is faster but less accurate.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoDistanceType"
}
]
},
"ignore_unmapped": {
"type": "boolean"
},
"order": {
"description": "\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortOrder"
}
]
},
"unit": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DistanceUnit"
}
]
},
"nested": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NestedSortValue"
}
]
}
}
},
"_types.SortMode": {
"type": "string",
"enum": [
"min",
"max",
"sum",
"avg",
"median"
]
},
"_types.DistanceUnit": {
"type": "string",
"enum": [
"in",
"ft",
"yd",
"mi",
"nmi",
"km",
"m",
"cm",
"mm"
]
},
"_types.NestedSortValue": {
"type": "object",
"properties": {
"filter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"max_children": {
"type": "number"
},
"nested": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NestedSortValue"
}
]
},
"path": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"path"
]
},
"_types.ScriptSort": {
"type": "object",
"properties": {
"order": {
"description": "\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortOrder"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSortType"
}
]
},
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SortMode"
}
]
},
"nested": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NestedSortValue"
}
]
}
},
"required": [
"script"
]
},
"_types.ScriptSortType": {
"type": "string",
"enum": [
"string",
"number",
"version"
]
},
"_global.search._types.SourceConfig": {
"description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/_global.search._types.SourceFilter"
}
]
},
"_global.search._types.SourceFilter": {
"type": "object",
"properties": {
"exclude_vectors": {
"description": "If `true`, vector fields are excluded from the returned source.\n\nThis option takes precedence over `includes`: any vector field will\nremain excluded even if it matches an `includes` rule.",
"type": "boolean"
},
"excludes": {
"description": "A list of fields to exclude from the returned source.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"includes": {
"description": "A list of fields to include in the returned source.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
}
}
},
"_types.query_dsl.ChildScoreMode": {
"type": "string",
"enum": [
"none",
"avg",
"sum",
"max",
"min"
]
},
"_types.RelationName": {
"type": "string"
},
"_types.query_dsl.HasParentQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"ignore_unmapped": {
"description": "Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.\nYou can use this parameter to query multiple indices that may not contain the `parent_type`.",
"default": false,
"type": "boolean"
},
"inner_hits": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits"
},
"description": "If defined, each search hit will contain inner hits.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.InnerHits"
}
]
},
"parent_type": {
"description": "Name of the parent relationship mapped for the `join` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RelationName"
}
]
},
"query": {
"description": "Query you wish to run on parent documents of the `parent_type` field.\nIf a parent document matches the search, the query returns its child documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"score": {
"description": "Indicates whether the relevance score of a matching parent document is aggregated into its child documents.",
"default": false,
"type": "boolean"
}
},
"required": [
"parent_type",
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.IdsQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"values": {
"description": "An array of document IDs.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Ids"
}
]
}
}
}
],
"x-model": true
},
"_types.Ids": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Id"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
}
]
},
"_types.query_dsl.IntervalsQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query"
},
"type": "object",
"properties": {
"all_of": {
"description": "Returns matches that span a combination of other rules.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf"
}
]
},
"any_of": {
"description": "Returns intervals produced by any of its sub-rules.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf"
}
]
},
"fuzzy": {
"description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy"
}
]
},
"match": {
"description": "Matches analyzed text.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch"
}
]
},
"prefix": {
"description": "Matches terms that start with a specified set of characters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix"
}
]
},
"range": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsRange"
}
]
},
"regexp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp"
}
]
},
"wildcard": {
"description": "Matches terms using a wildcard pattern.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
],
"x-model": true
},
"_types.query_dsl.IntervalsAllOf": {
"type": "object",
"properties": {
"intervals": {
"description": "An array of rules to combine. All rules must produce a match in a document for the overall source to match.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
},
"max_gaps": {
"description": "Maximum number of positions between the matching terms.\nIntervals produced by the rules further apart than this are not considered matches.",
"default": -1,
"type": "number"
},
"ordered": {
"description": "If `true`, intervals produced by the rules should appear in the order in which they are specified.",
"default": false,
"type": "boolean"
},
"filter": {
"description": "Rule used to filter returned intervals.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter"
}
]
}
},
"required": [
"intervals"
],
"x-model": true
},
"_types.query_dsl.IntervalsContainer": {
"type": "object",
"properties": {
"all_of": {
"description": "Returns matches that span a combination of other rules.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf"
}
]
},
"any_of": {
"description": "Returns intervals produced by any of its sub-rules.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf"
}
]
},
"fuzzy": {
"description": "Matches analyzed text.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy"
}
]
},
"match": {
"description": "Matches analyzed text.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch"
}
]
},
"prefix": {
"description": "Matches terms that start with a specified set of characters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix"
}
]
},
"range": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsRange"
}
]
},
"regexp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp"
}
]
},
"wildcard": {
"description": "Matches terms using a wildcard pattern.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard"
}
]
}
},
"minProperties": 1,
"maxProperties": 1,
"x-model": true
},
"_types.query_dsl.IntervalsAnyOf": {
"type": "object",
"properties": {
"intervals": {
"description": "An array of rules to match.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
},
"filter": {
"description": "Rule used to filter returned intervals.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter"
}
]
}
},
"required": [
"intervals"
],
"x-model": true
},
"_types.query_dsl.IntervalsFilter": {
"type": "object",
"properties": {
"after": {
"description": "Query used to return intervals that follow an interval from the `filter` rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
]
},
"before": {
"description": "Query used to return intervals that occur before an interval from the `filter` rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
]
},
"contained_by": {
"description": "Query used to return intervals contained by an interval from the `filter` rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
]
},
"containing": {
"description": "Query used to return intervals that contain an interval from the `filter` rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
]
},
"not_contained_by": {
"description": "Query used to return intervals that are **not** contained by an interval from the `filter` rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
]
},
"not_containing": {
"description": "Query used to return intervals that do **not** contain an interval from the `filter` rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
]
},
"not_overlapping": {
"description": "Query used to return intervals that do **not** overlap with an interval from the `filter` rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
]
},
"overlapping": {
"description": "Query used to return intervals that overlap with an interval from the `filter` rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
}
]
},
"script": {
"description": "Script used to return matching documents.\nThis script must return a boolean value: `true` or `false`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"minProperties": 1,
"maxProperties": 1,
"x-model": true
},
"_types.query_dsl.IntervalsFuzzy": {
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to normalize the term.",
"type": "string"
},
"fuzziness": {
"description": "Maximum edit distance allowed for matching.",
"default": "auto",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fuzziness"
}
]
},
"prefix_length": {
"description": "Number of beginning characters left unchanged when creating expansions.",
"default": 0,
"type": "number"
},
"term": {
"description": "The term to match.",
"type": "string"
},
"transpositions": {
"description": "Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).",
"default": true,
"type": "boolean"
},
"use_field": {
"description": "If specified, match intervals from this field rather than the top-level field.\nThe `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"term"
],
"x-model": true
},
"_types.query_dsl.IntervalsMatch": {
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to analyze terms in the query.",
"type": "string"
},
"max_gaps": {
"description": "Maximum number of positions between the matching terms.\nTerms further apart than this are not considered matches.",
"default": -1,
"type": "number"
},
"ordered": {
"description": "If `true`, matching terms must appear in their specified order.",
"default": false,
"type": "boolean"
},
"query": {
"description": "Text you wish to find in the provided field.",
"type": "string"
},
"use_field": {
"description": "If specified, match intervals from this field rather than the top-level field.\nThe `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"filter": {
"description": "An optional interval filter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter"
}
]
}
},
"required": [
"query"
],
"x-model": true
},
"_types.query_dsl.IntervalsPrefix": {
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to analyze the `prefix`.",
"type": "string"
},
"prefix": {
"description": "Beginning characters of terms you wish to find in the top-level field.",
"type": "string"
},
"use_field": {
"description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"prefix"
],
"x-model": true
},
"_types.query_dsl.IntervalsRange": {
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to analyze the `prefix`.",
"type": "string"
},
"gte": {
"description": "Lower term, either gte or gt must be provided.",
"type": "string"
},
"gt": {
"description": "Lower term, either gte or gt must be provided.",
"type": "string"
},
"lte": {
"description": "Upper term, either lte or lt must be provided.",
"type": "string"
},
"lt": {
"description": "Upper term, either lte or lt must be provided.",
"type": "string"
},
"use_field": {
"description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
}
},
"_types.query_dsl.IntervalsRegexp": {
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to analyze the `prefix`.",
"type": "string"
},
"pattern": {
"description": "Regex pattern.",
"type": "string"
},
"use_field": {
"description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"pattern"
]
},
"_types.query_dsl.IntervalsWildcard": {
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to analyze the `pattern`.\nDefaults to the top-level field's analyzer.",
"type": "string"
},
"pattern": {
"description": "Wildcard pattern used to find matching terms.",
"type": "string"
},
"use_field": {
"description": "If specified, match intervals from this field rather than the top-level field.\nThe `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"pattern"
],
"x-model": true
},
"_types.KnnQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The name of the vector field to search against",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"query_vector": {
"description": "The query vector",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryVector"
}
]
},
"query_vector_builder": {
"description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryVectorBuilder"
}
]
},
"num_candidates": {
"description": "The number of nearest neighbor candidates to consider per shard",
"type": "number"
},
"visit_percentage": {
"description": "The percentage of vectors to explore per shard while doing knn search with bbq_disk",
"x-state": "Generally available; Added in 9.2.0",
"type": "number"
},
"k": {
"description": "The final number of nearest neighbors to return as top hits",
"type": "number"
},
"filter": {
"description": "Filters for the kNN search query",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
},
"similarity": {
"description": "The minimum similarity for a vector to be considered a match",
"type": "number"
},
"rescore_vector": {
"description": "Apply oversampling and rescoring to quantized vectors",
"x-state": "Generally available; Added in 8.18.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.RescoreVector"
}
]
}
},
"required": [
"field"
]
}
],
"x-model": true
},
"_types.QueryVector": {
"type": "array",
"items": {
"type": "number"
}
},
"_types.QueryVectorBuilder": {
"type": "object",
"properties": {
"embedding": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Embedding"
}
]
},
"text_embedding": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TextEmbedding"
}
]
},
"lookup": {
"description": "Lookup a vector from an existing document.\nMust reference a dense_vector field and a single value.",
"x-state": "Generally available; Added in 9.4.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.LookupQueryVectorBuilder"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.Embedding": {
"type": "object",
"properties": {
"inference_id": {
"type": "string"
},
"input": {
"allOf": [
{
"$ref": "#/components/schemas/_types.KnnEmbeddingInput"
}
]
},
"timeout": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"input"
]
},
"_types.KnnEmbeddingInput": {
"description": "Knn embedding input.\nEither a string, an object or array of objects",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/_types.InferenceStringGroup"
}
]
},
"_types.InferenceStringGroup": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.InferenceString"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.InferenceString"
}
}
]
},
"_types.InferenceString": {
"type": "object",
"properties": {
"type": {
"description": "The type of data that the value represents.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingContentType"
}
]
},
"format": {
"description": "The format of the data. If null, the default data format for the given type is used.",
"oneOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingContentFormat"
},
{
"nullable": true,
"type": "string"
}
]
},
"value": {
"description": "String which may be raw text, or the string representation of some other data such as an image in base64.",
"type": "string"
}
},
"required": [
"type",
"value"
]
},
"inference._types.EmbeddingContentType": {
"type": "string",
"enum": [
"text",
"image",
"audio",
"video",
"pdf"
]
},
"inference._types.EmbeddingContentFormat": {
"type": "string",
"enum": [
"text",
"base64"
]
},
"_types.TextEmbedding": {
"type": "object",
"properties": {
"model_id": {
"description": "Model ID is required for all dense_vector fields but\nmay be inferred for semantic_text fields",
"x-state": "Generally available; Added in 8.18.0",
"type": "string"
},
"model_text": {
"description": "The text to be converted into a vector by the specified model",
"type": "string"
}
},
"required": [
"model_text"
]
},
"_types.LookupQueryVectorBuilder": {
"type": "object",
"properties": {
"id": {
"description": "The ID of the document to fetch the vector from",
"type": "string"
},
"index": {
"description": "The name of the index to fetch the document from",
"type": "string"
},
"path": {
"description": "The name of the field containing the vector",
"type": "string"
},
"routing": {
"description": "The routing value to use when fetching the document",
"type": "string"
}
},
"required": [
"id",
"index",
"path"
]
},
"_types.RescoreVector": {
"type": "object",
"properties": {
"oversample": {
"description": "Applies the specified oversample factor to k on the approximate kNN search",
"type": "number"
}
},
"required": [
"oversample"
]
},
"_types.query_dsl.MatchQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to convert the text in the query value into tokens.",
"type": "string"
},
"auto_generate_synonyms_phrase_query": {
"description": "If `true`, match phrase queries are automatically created for multi-term synonyms.",
"default": true,
"type": "boolean"
},
"cutoff_frequency": {
"deprecated": true,
"type": "number"
},
"fuzziness": {
"description": "Maximum edit distance allowed for matching.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fuzziness"
}
]
},
"fuzzy_rewrite": {
"description": "Method used to rewrite the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"fuzzy_transpositions": {
"description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).",
"default": true,
"type": "boolean"
},
"lenient": {
"description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.",
"default": false,
"type": "boolean"
},
"max_expansions": {
"description": "Maximum number of terms to which the query will expand.",
"default": 50,
"type": "number"
},
"minimum_should_match": {
"description": "Minimum number of clauses that must match for a document to be returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"operator": {
"description": "Boolean logic used to interpret text in the query value.",
"default": "'or'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Operator"
}
]
},
"prefix_length": {
"description": "Number of beginning characters left unchanged for fuzzy matching.",
"default": 0,
"type": "number"
},
"query": {
"description": "Text, number, boolean value or date you wish to find in the provided field.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"zero_terms_query": {
"description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `all`: Returns all documents, similar to a `match_all` query.\n - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n",
"default": "'none'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery"
}
]
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.ZeroTermsQuery": {
"type": "string",
"enum": [
"all",
"none"
]
},
"_types.query_dsl.MatchAllQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.MatchBoolPrefixQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to convert the text in the query value into tokens.",
"type": "string"
},
"fuzziness": {
"description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fuzziness"
}
]
},
"fuzzy_rewrite": {
"description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"fuzzy_transpositions": {
"description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.",
"default": true,
"type": "boolean"
},
"max_expansions": {
"description": "Maximum number of terms to which the query will expand.\nCan be applied to the term subqueries constructed for all terms but the final term.",
"default": 50,
"type": "number"
},
"minimum_should_match": {
"description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"operator": {
"description": "Boolean logic used to interpret text in the query value.\nApplied to the constructed bool query.",
"default": "'or'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Operator"
}
]
},
"prefix_length": {
"description": "Number of beginning characters left unchanged for fuzzy matching.\nCan be applied to the term subqueries constructed for all terms but the final term.",
"default": 0,
"type": "number"
},
"query": {
"description": "Terms you wish to find in the provided field.\nThe last term is used in a prefix query.",
"type": "string"
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.MatchNoneQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.MatchPhraseQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to convert the text in the query value into tokens.",
"type": "string"
},
"query": {
"description": "Query terms that are analyzed and turned into a phrase query.",
"type": "string"
},
"slop": {
"description": "Maximum number of positions allowed between matching tokens.",
"default": 0,
"type": "number"
},
"zero_terms_query": {
"description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `all`: Returns all documents, similar to a `match_all` query.\n - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n",
"default": "'none'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery"
}
]
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.MatchPhrasePrefixQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to convert text in the query value into tokens.",
"type": "string"
},
"max_expansions": {
"description": "Maximum number of terms to which the last provided term of the query value will expand.",
"default": 50,
"type": "number"
},
"query": {
"description": "Text you wish to find in the provided field.",
"type": "string"
},
"slop": {
"description": "Maximum number of positions allowed between matching tokens.",
"default": 0,
"type": "number"
},
"zero_terms_query": {
"description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `all`: Returns all documents, similar to a `match_all` query.\n - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n",
"default": "none",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery"
}
]
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.MoreLikeThisQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"externalDocs": {
"url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis"
},
"description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.",
"type": "string"
},
"boost_terms": {
"description": "Each term in the formed query could be further boosted by their tf-idf score.\nThis sets the boost factor to use when using this feature.\nDefaults to deactivated (0).",
"default": 0,
"type": "number"
},
"fail_on_unsupported_field": {
"description": "Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`).",
"default": true,
"type": "boolean"
},
"fields": {
"description": "A list of fields to fetch and analyze the text from.\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"include": {
"description": "Specifies whether the input documents should also be included in the search results returned.",
"default": false,
"type": "boolean"
},
"like": {
"description": "Specifies free form text and/or a single or multiple documents for which you want to find similar documents.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Like"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.Like"
}
}
]
},
"max_doc_freq": {
"description": "The maximum document frequency above which the terms are ignored from the input document.",
"type": "number"
},
"max_query_terms": {
"description": "The maximum number of query terms that can be selected.",
"default": 25,
"type": "number"
},
"max_word_length": {
"description": "The maximum word length above which the terms are ignored.\nDefaults to unbounded (`0`).",
"default": 0,
"type": "number"
},
"min_doc_freq": {
"description": "The minimum document frequency below which the terms are ignored from the input document.",
"default": 5,
"type": "number"
},
"minimum_should_match": {
"description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"min_term_freq": {
"description": "The minimum term frequency below which the terms are ignored from the input document.",
"default": 2,
"type": "number"
},
"min_word_length": {
"description": "The minimum word length below which the terms are ignored.",
"default": 0,
"type": "number"
},
"routing": {
"type": "string"
},
"stop_words": {
"description": "An array of stop words.\nAny word in this set is ignored.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"unlike": {
"description": "Used in combination with `like` to exclude documents that match a set of terms.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Like"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.Like"
}
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"version_type": {
"description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"default": "'internal'",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionType"
}
]
}
},
"required": [
"like"
]
}
],
"x-model": true
},
"_types.query_dsl.Like": {
"description": "Text that we want similar documents for or a lookup to a document's field for the text.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/_types.query_dsl.LikeDocument"
}
]
},
"_types.query_dsl.LikeDocument": {
"type": "object",
"properties": {
"doc": {
"description": "A document not present in the index.",
"type": "object"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"_id": {
"description": "ID of a document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "Index of a document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"per_field_analyzer": {
"description": "Overrides the default analyzer.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"routing": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Routing"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"version_type": {
"description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"default": "'internal'",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionType"
}
]
}
},
"x-model": true
},
"_types.Routing": {
"description": "Only to be used in query and path parameters, as the array form is actually a csv",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"_types.VersionType": {
"type": "string",
"enum": [
"internal",
"external",
"external_gte"
]
},
"_types.analysis.StopWords": {
"description": "Language value, such as _arabic_ or _thai_. Defaults to _english_.\nEach language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words.\nAlso accepts an array of stop words.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWordLanguage"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"_types.analysis.StopWordLanguage": {
"type": "string",
"enum": [
"_arabic_",
"_armenian_",
"_basque_",
"_bengali_",
"_brazilian_",
"_bulgarian_",
"_catalan_",
"_cjk_",
"_czech_",
"_danish_",
"_dutch_",
"_english_",
"_estonian_",
"_finnish_",
"_french_",
"_galician_",
"_german_",
"_greek_",
"_hindi_",
"_hungarian_",
"_indonesian_",
"_irish_",
"_italian_",
"_latvian_",
"_lithuanian_",
"_norwegian_",
"_persian_",
"_portuguese_",
"_romanian_",
"_russian_",
"_serbian_",
"_sorani_",
"_spanish_",
"_swedish_",
"_thai_",
"_turkish_",
"_none_"
]
},
"_types.query_dsl.MultiMatchQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to convert the text in the query value into tokens.",
"type": "string"
},
"auto_generate_synonyms_phrase_query": {
"description": "If `true`, match phrase queries are automatically created for multi-term synonyms.",
"default": true,
"type": "boolean"
},
"cutoff_frequency": {
"deprecated": true,
"type": "number"
},
"fields": {
"description": "The fields to be queried.\nDefaults to the `index.query.default_field` index settings, which in turn defaults to `*`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"fuzziness": {
"description": "Maximum edit distance allowed for matching.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fuzziness"
}
]
},
"fuzzy_rewrite": {
"description": "Method used to rewrite the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"fuzzy_transpositions": {
"description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.",
"default": true,
"type": "boolean"
},
"lenient": {
"description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.",
"default": false,
"type": "boolean"
},
"max_expansions": {
"description": "Maximum number of terms to which the query will expand.",
"default": 50,
"type": "number"
},
"minimum_should_match": {
"description": "Minimum number of clauses that must match for a document to be returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"operator": {
"description": "Boolean logic used to interpret text in the query value.",
"default": "'or'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Operator"
}
]
},
"prefix_length": {
"description": "Number of beginning characters left unchanged for fuzzy matching.",
"default": 0,
"type": "number"
},
"query": {
"description": "Text, number, boolean value or date you wish to find in the provided field.",
"type": "string"
},
"slop": {
"description": "Maximum number of positions allowed between matching tokens.",
"default": 0,
"type": "number"
},
"tie_breaker": {
"description": "Determines how scores for each per-term blended query and scores across groups are combined.",
"default": 0,
"type": "number"
},
"type": {
"description": "How `the` multi_match query is executed internally.\n\nSupported values include:\n - `best_fields`: Finds documents that match any field, but uses the `_score` from the best field.\n - `most_fields`: Finds documents that match any field and combines the `_score` from each field.\n - `cross_fields`: Treats fields with the same analyzer as though they were one big field.\nLooks for each word in any field.\n - `phrase`: Runs a `match_phrase` query on each field and uses the `_score` from the best field.\n - `phrase_prefix`: Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field.\n - `bool_prefix`: Creates a `match_bool_prefix` query on each field and combines the `_score` from each field.\n\n",
"default": "'best_fields'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.TextQueryType"
}
]
},
"zero_terms_query": {
"description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `all`: Returns all documents, similar to a `match_all` query.\n - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n",
"default": "'none'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery"
}
]
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.TextQueryType": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix",
"bool_prefix"
]
},
"_types.query_dsl.NestedQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"ignore_unmapped": {
"description": "Indicates whether to ignore an unmapped path and not return any documents instead of an error.",
"default": false,
"type": "boolean"
},
"inner_hits": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits"
},
"description": "If defined, each search hit will contain inner hits.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.InnerHits"
}
]
},
"path": {
"description": "Path to the nested object you wish to search.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"query": {
"description": "Query you wish to run on nested objects in the path.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"score_mode": {
"description": "How scores for matching child objects affect the root parent document’s relevance score.",
"default": "'avg'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode"
}
]
}
},
"required": [
"path",
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.ParentIdQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"id": {
"description": "ID of the parent document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"ignore_unmapped": {
"description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.",
"default": false,
"type": "boolean"
},
"type": {
"description": "Name of the child relationship mapped for the `join` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RelationName"
}
]
}
}
}
],
"x-model": true
},
"_types.query_dsl.PercolateQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"document": {
"description": "The source of the document being percolated.",
"type": "object"
},
"documents": {
"description": "An array of sources of the documents being percolated.",
"type": "array",
"items": {
"type": "object"
}
},
"field": {
"description": "Field that holds the indexed queries. The field must use the `percolator` mapping type.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"id": {
"description": "The ID of a stored document to percolate.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"index": {
"description": "The index of a stored document to percolate.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"name": {
"description": "The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.",
"type": "string"
},
"preference": {
"description": "Preference used to fetch document to percolate.",
"type": "string"
},
"routing": {
"description": "Routing used to fetch document to percolate.",
"type": "string"
},
"version": {
"description": "The expected version of a stored document to percolate.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"field"
]
}
],
"x-model": true
},
"_types.query_dsl.PinnedQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query"
},
"allOf": [
{
"type": "object",
"properties": {
"organic": {
"description": "Any choice of query used to rank documents which will be ranked below the \"pinned\" documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"organic"
]
},
{
"type": "object",
"properties": {
"ids": {
"description": "Document IDs listed in the order they are to appear in results.\nRequired if `docs` is not specified.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
},
"docs": {
"description": "Documents listed in the order they are to appear in results.\nRequired if `ids` is not specified.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.PinnedDoc"
}
}
},
"minProperties": 1,
"maxProperties": 1
}
]
}
],
"x-model": true
},
"_types.query_dsl.PinnedDoc": {
"type": "object",
"properties": {
"_id": {
"description": "The unique document ID.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "The index that contains the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"_id"
]
},
"_types.query_dsl.PrefixQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"rewrite": {
"description": "Method used to rewrite the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"value": {
"description": "Beginning characters of terms you wish to find in the provided field.",
"type": "string"
},
"case_insensitive": {
"description": "Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.\nDefault is `false` which means the case sensitivity of matching depends on the underlying field’s mapping.",
"default": false,
"x-state": "Generally available; Added in 7.10.0",
"type": "boolean"
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.query_dsl.QueryStringQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"allow_leading_wildcard": {
"description": "If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string.",
"default": true,
"type": "boolean"
},
"analyzer": {
"description": "Analyzer used to convert text in the query string into tokens.",
"type": "string"
},
"analyze_wildcard": {
"description": "If `true`, the query attempts to analyze wildcard terms in the query string.",
"default": false,
"type": "boolean"
},
"auto_generate_synonyms_phrase_query": {
"description": "If `true`, match phrase queries are automatically created for multi-term synonyms.",
"default": true,
"type": "boolean"
},
"default_field": {
"description": "Default field to search if no field is provided in the query string.\nSupports wildcards (`*`).\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"default_operator": {
"description": "Default boolean logic used to interpret text in the query string if no operators are specified.",
"default": "'or'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Operator"
}
]
},
"enable_position_increments": {
"description": "If `true`, enable position increments in queries constructed from a `query_string` search.",
"default": true,
"type": "boolean"
},
"escape": {
"default": false,
"type": "boolean"
},
"fields": {
"description": "Array of fields to search. Supports wildcards (`*`).",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"fuzziness": {
"description": "Maximum edit distance allowed for fuzzy matching.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fuzziness"
}
]
},
"fuzzy_max_expansions": {
"description": "Maximum number of terms to which the query expands for fuzzy matching.",
"default": 50,
"type": "number"
},
"fuzzy_prefix_length": {
"description": "Number of beginning characters left unchanged for fuzzy matching.",
"default": 0,
"type": "number"
},
"fuzzy_rewrite": {
"description": "Method used to rewrite the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"fuzzy_transpositions": {
"description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).",
"default": true,
"type": "boolean"
},
"lenient": {
"description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.",
"default": false,
"type": "boolean"
},
"max_determinized_states": {
"description": "Maximum number of automaton states required for the query.",
"default": 10000,
"type": "number"
},
"minimum_should_match": {
"description": "Minimum number of clauses that must match for a document to be returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"phrase_slop": {
"description": "Maximum number of positions allowed between matching tokens for phrases.",
"default": 0,
"type": "number"
},
"query": {
"description": "Query string you wish to parse and use for search.",
"type": "string"
},
"quote_analyzer": {
"description": "Analyzer used to convert quoted text in the query string into tokens.\nFor quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter.",
"type": "string"
},
"quote_field_suffix": {
"description": "Suffix appended to quoted text in the query string.\nYou can use this suffix to use a different analysis method for exact matches.",
"type": "string"
},
"rewrite": {
"description": "Method used to rewrite the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"tie_breaker": {
"description": "How to combine the queries generated from the individual search terms in the resulting `dis_max` query.",
"type": "number"
},
"time_zone": {
"description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
},
"type": {
"description": "Determines how the query matches and scores documents.\n\nSupported values include:\n - `best_fields`: Finds documents that match any field, but uses the `_score` from the best field.\n - `most_fields`: Finds documents that match any field and combines the `_score` from each field.\n - `cross_fields`: Treats fields with the same analyzer as though they were one big field.\nLooks for each word in any field.\n - `phrase`: Runs a `match_phrase` query on each field and uses the `_score` from the best field.\n - `phrase_prefix`: Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field.\n - `bool_prefix`: Creates a `match_bool_prefix` query on each field and combines the `_score` from each field.\n\n",
"default": "'best_fields'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.TextQueryType"
}
]
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.TimeZone": {
"type": "string"
},
"_types.query_dsl.RangeQuery": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query"
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.UntypedRangeQuery"
},
{
"$ref": "#/components/schemas/_types.query_dsl.DateRangeQuery"
},
{
"$ref": "#/components/schemas/_types.query_dsl.NumberRangeQuery"
},
{
"$ref": "#/components/schemas/_types.query_dsl.LongNumberRangeQuery"
},
{
"$ref": "#/components/schemas/_types.query_dsl.TermRangeQuery"
}
],
"x-model": true
},
"_types.query_dsl.UntypedRangeQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeQueryBase"
},
{
"type": "object",
"properties": {
"format": {
"description": "Date format used to convert `date` values in the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateFormat"
}
]
},
"time_zone": {
"description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
}
}
}
]
},
"_types.DateFormat": {
"type": "string"
},
"_types.query_dsl.RangeQueryBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"relation": {
"description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
"default": "intersects",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
}
]
},
"gt": {
"description": "Greater than.",
"type": "object"
},
"gte": {
"description": "Greater than or equal to.",
"type": "object"
},
"lt": {
"description": "Less than.",
"type": "object"
},
"lte": {
"description": "Less than or equal to.",
"type": "object"
}
}
}
]
},
"_types.query_dsl.RangeRelation": {
"type": "string",
"enum": [
"within",
"contains",
"intersects"
]
},
"_types.query_dsl.DateRangeQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeQueryBaseDateMath"
},
{
"type": "object",
"properties": {
"format": {
"description": "Date format used to convert `date` values in the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateFormat"
}
]
},
"time_zone": {
"description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
}
}
}
]
},
"_types.query_dsl.RangeQueryBaseDateMath": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"relation": {
"description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
"default": "intersects",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
}
]
},
"gt": {
"description": "Greater than.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateMath"
}
]
},
"gte": {
"description": "Greater than or equal to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateMath"
}
]
},
"lt": {
"description": "Less than.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateMath"
}
]
},
"lte": {
"description": "Less than or equal to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateMath"
}
]
}
}
}
]
},
"_types.query_dsl.NumberRangeQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeQueryBasedouble"
},
{
"type": "object"
}
]
},
"_types.query_dsl.RangeQueryBasedouble": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"relation": {
"description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
"default": "intersects",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
}
]
},
"gt": {
"description": "Greater than.",
"type": "number"
},
"gte": {
"description": "Greater than or equal to.",
"type": "number"
},
"lt": {
"description": "Less than.",
"type": "number"
},
"lte": {
"description": "Less than or equal to.",
"type": "number"
}
}
}
]
},
"_types.query_dsl.LongNumberRangeQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeQueryBaselong"
},
{
"type": "object"
}
]
},
"_types.query_dsl.RangeQueryBaselong": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"relation": {
"description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
"default": "intersects",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
}
]
},
"gt": {
"description": "Greater than.",
"type": "number"
},
"gte": {
"description": "Greater than or equal to.",
"type": "number"
},
"lt": {
"description": "Less than.",
"type": "number"
},
"lte": {
"description": "Less than or equal to.",
"type": "number"
}
}
}
]
},
"_types.query_dsl.TermRangeQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeQueryBasestring"
},
{
"type": "object"
}
]
},
"_types.query_dsl.RangeQueryBasestring": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"relation": {
"description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
"default": "intersects",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
}
]
},
"gt": {
"description": "Greater than.",
"type": "string"
},
"gte": {
"description": "Greater than or equal to.",
"type": "string"
},
"lt": {
"description": "Less than.",
"type": "string"
},
"lte": {
"description": "Less than or equal to.",
"type": "string"
}
}
}
]
},
"_types.query_dsl.RankFeatureQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "`rank_feature` or `rank_features` field used to boost relevance scores.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"saturation": {
"description": "Saturation function used to boost relevance scores based on the value of the rank feature `field`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation"
}
]
},
"log": {
"description": "Logarithmic function used to boost relevance scores based on the value of the rank feature `field`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm"
}
]
},
"linear": {
"description": "Linear function used to boost relevance scores based on the value of the rank feature `field`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear"
}
]
},
"sigmoid": {
"description": "Sigmoid function used to boost relevance scores based on the value of the rank feature `field`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid"
}
]
}
},
"required": [
"field"
]
}
],
"x-model": true
},
"_types.query_dsl.RankFeatureFunctionSaturation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunction"
},
{
"type": "object",
"properties": {
"pivot": {
"description": "Configurable pivot value so that the result will be less than 0.5.",
"type": "number"
}
}
}
]
},
"_types.query_dsl.RankFeatureFunction": {
"type": "object"
},
"_types.query_dsl.RankFeatureFunctionLogarithm": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunction"
},
{
"type": "object",
"properties": {
"scaling_factor": {
"description": "Configurable scaling factor.",
"type": "number"
}
},
"required": [
"scaling_factor"
]
}
]
},
"_types.query_dsl.RankFeatureFunctionLinear": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunction"
},
{
"type": "object"
}
]
},
"_types.query_dsl.RankFeatureFunctionSigmoid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunction"
},
{
"type": "object",
"properties": {
"pivot": {
"description": "Configurable pivot value so that the result will be less than 0.5.",
"type": "number"
},
"exponent": {
"description": "Configurable Exponent.",
"type": "number"
}
},
"required": [
"pivot",
"exponent"
]
}
]
},
"_types.query_dsl.RegexpQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"case_insensitive": {
"description": "Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.\nWhen `false`, case sensitivity of matching depends on the underlying field’s mapping.",
"default": false,
"x-state": "Generally available; Added in 7.10.0",
"type": "boolean"
},
"flags": {
"description": "Enables optional operators for the regular expression.",
"type": "string"
},
"max_determinized_states": {
"description": "Maximum number of automaton states required for the query.",
"default": 10000,
"type": "number"
},
"rewrite": {
"description": "Method used to rewrite the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"value": {
"description": "Regular expression for terms you wish to find in the provided field.",
"type": "string"
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.query_dsl.RuleQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"organic": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"ruleset_ids": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Id"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
}
]
},
"ruleset_id": {
"type": "string"
},
"match_criteria": {
"type": "object"
}
},
"required": [
"organic",
"match_criteria"
]
}
],
"x-model": true
},
"_types.query_dsl.ScriptQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"script": {
"description": "Contains a script to run as a query.\nThis script must return a boolean value, `true` or `false`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"script"
]
}
],
"x-model": true
},
"_types.query_dsl.ScriptScoreQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"min_score": {
"description": "Documents with a score lower than this floating point number are excluded from the search results.",
"type": "number"
},
"query": {
"description": "Query used to return documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"script": {
"description": "Script used to compute the score of documents returned by the query.\nImportant: final relevance scores from the `script_score` query cannot be negative.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"query",
"script"
]
}
],
"x-model": true
},
"_types.query_dsl.SemanticQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to query, which must be a semantic_text field type",
"type": "string"
},
"query": {
"description": "The query text",
"type": "string"
}
},
"required": [
"field",
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.ShapeQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"ignore_unmapped": {
"description": "When set to `true` the query ignores an unmapped field and will not match any documents.",
"type": "boolean"
}
}
}
],
"x-model": true
},
"_types.query_dsl.SimpleQueryStringQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"description": "Analyzer used to convert text in the query string into tokens.",
"type": "string"
},
"analyze_wildcard": {
"description": "If `true`, the query attempts to analyze wildcard terms in the query string.",
"default": false,
"type": "boolean"
},
"auto_generate_synonyms_phrase_query": {
"description": "If `true`, the parser creates a match_phrase query for each multi-position token.",
"default": true,
"type": "boolean"
},
"default_operator": {
"description": "Default boolean logic used to interpret text in the query string if no operators are specified.",
"default": "'or'",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.Operator"
}
]
},
"fields": {
"description": "Array of fields you wish to search.\nAccepts wildcard expressions.\nYou also can boost relevance scores for matches to particular fields using a caret (`^`) notation.\nDefaults to the `index.query.default_field index` setting, which has a default value of `*`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"flags": {
"description": "List of enabled operators for the simple query string syntax.",
"default": "ALL",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringFlags"
}
]
},
"fuzzy_max_expansions": {
"description": "Maximum number of terms to which the query expands for fuzzy matching.",
"default": 50,
"type": "number"
},
"fuzzy_prefix_length": {
"description": "Number of beginning characters left unchanged for fuzzy matching.",
"default": 0,
"type": "number"
},
"fuzzy_transpositions": {
"description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).",
"type": "boolean"
},
"lenient": {
"description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.",
"default": false,
"type": "boolean"
},
"minimum_should_match": {
"description": "Minimum number of clauses that must match for a document to be returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"query": {
"description": "Query string in the simple query string syntax you wish to parse and use for search.",
"type": "string"
},
"quote_field_suffix": {
"description": "Suffix appended to quoted text in the query string.",
"type": "string"
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.SimpleQueryStringFlags": {
"description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag"
}
]
},
"_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag": {
"description": "A set of flags that can be represented as a single enum value or a set of values that are encoded\nas a pipe-separated string\n\nDepending on the target language, code generators can use this hint to generate language specific\nflags enum constructs and the corresponding (de-)serialization code.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringFlag"
},
{
"type": "string"
}
]
},
"_types.query_dsl.SimpleQueryStringFlag": {
"type": "string",
"enum": [
"NONE",
"AND",
"NOT",
"OR",
"PREFIX",
"PHRASE",
"PRECEDENCE",
"ESCAPE",
"WHITESPACE",
"FUZZY",
"NEAR",
"SLOP",
"ALL"
]
},
"_types.query_dsl.SpanContainingQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"big": {
"description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
]
},
"little": {
"description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
]
}
},
"required": [
"big",
"little"
]
}
],
"x-model": true
},
"_types.query_dsl.SpanQuery": {
"type": "object",
"properties": {
"span_containing": {
"description": "Accepts a list of span queries, but only returns those spans which also match a second span query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery"
}
]
},
"span_field_masking": {
"description": "Allows queries like `span_near` or `span_or` across different fields.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery"
}
]
},
"span_first": {
"description": "Accepts another span query whose matches must appear within the first N positions of the field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery"
}
]
},
"span_gap": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanGapQuery"
}
]
},
"span_multi": {
"description": "Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery"
}
]
},
"span_near": {
"description": "Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery"
}
]
},
"span_not": {
"description": "Wraps another span query, and excludes any documents which match that query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery"
}
]
},
"span_or": {
"description": "Combines multiple span queries and returns documents which match any of the specified queries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery"
}
]
},
"span_term": {
"description": "The equivalent of the `term` query but for use with other span queries.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.SpanTermQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"span_within": {
"description": "The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.query_dsl.SpanFieldMaskingQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"query": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
]
}
},
"required": [
"field",
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.SpanFirstQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"end": {
"description": "Controls the maximum end position permitted in a match.",
"type": "number"
},
"match": {
"description": "Can be any other span type query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
]
}
},
"required": [
"end",
"match"
]
}
],
"x-model": true
},
"_types.query_dsl.SpanGapQuery": {
"description": "Can only be used as a clause in a span_near query.",
"type": "object",
"additionalProperties": {
"type": "number"
},
"minProperties": 1,
"maxProperties": 1
},
"_types.query_dsl.SpanMultiTermQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"match": {
"description": "Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query).",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"match"
]
}
],
"x-model": true
},
"_types.query_dsl.SpanNearQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"clauses": {
"description": "Array of one or more other span type queries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
},
"in_order": {
"description": "Controls whether matches are required to be in-order.",
"type": "boolean"
},
"slop": {
"description": "Controls the maximum number of intervening unmatched positions permitted.",
"type": "number"
}
},
"required": [
"clauses"
]
}
],
"x-model": true
},
"_types.query_dsl.SpanNotQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"dist": {
"description": "The number of tokens from within the include span that can’t have overlap with the exclude span.\nEquivalent to setting both `pre` and `post`.",
"type": "number"
},
"exclude": {
"description": "Span query whose matches must not overlap those returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
]
},
"include": {
"description": "Span query whose matches are filtered.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
]
},
"post": {
"description": "The number of tokens after the include span that can’t have overlap with the exclude span.",
"default": 0,
"type": "number"
},
"pre": {
"description": "The number of tokens before the include span that can’t have overlap with the exclude span.",
"default": 0,
"type": "number"
}
},
"required": [
"exclude",
"include"
]
}
],
"x-model": true
},
"_types.query_dsl.SpanOrQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"clauses": {
"description": "Array of one or more other span type queries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
}
},
"required": [
"clauses"
]
}
],
"x-model": true
},
"_types.query_dsl.SpanTermQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
}
]
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.query_dsl.SpanWithinQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"big": {
"description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
]
},
"little": {
"description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
}
]
}
},
"required": [
"big",
"little"
]
}
],
"x-model": true
},
"_types.query_dsl.SparseVectorQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query"
},
"allOf": [
{
"type": "object",
"properties": {
"field": {
"description": "The name of the field that contains the token-weight pairs to be searched against.\nThis field must be a mapped sparse_vector field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"query": {
"description": "The query text you want to use for search.\nIf inference_id is specified, query must also be specified.",
"type": "string"
},
"prune": {
"description": "Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.\nIf prune is true but the pruning_config is not specified, pruning will occur but default values will be used.\nDefault: false",
"x-state": "Generally available; Added in 8.15.0",
"type": "boolean"
},
"pruning_config": {
"description": "Optional pruning configuration.\nIf enabled, this will omit non-significant tokens from the query in order to improve query performance.\nThis is only used if prune is set to true.\nIf prune is set to true but pruning_config is not specified, default values will be used.",
"x-state": "Generally available; Added in 8.15.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.TokenPruningConfig"
}
]
}
},
"required": [
"field"
]
},
{
"type": "object",
"properties": {
"query_vector": {
"description": "Dictionary of precomputed sparse vectors and their associated weights.\nOnly one of inference_id or query_vector may be supplied in a request.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"inference_id": {
"description": "The inference ID to use to convert the query text into token-weight pairs.\nIt must be the same inference ID that was used to create the tokens from the input text.\nOnly one of inference_id and query_vector is allowed.\nIf inference_id is specified, query must also be specified.\nOnly one of inference_id or query_vector may be supplied in a request.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
}
],
"x-model": true
},
"_types.TokenPruningConfig": {
"type": "object",
"properties": {
"tokens_freq_ratio_threshold": {
"description": "Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.",
"default": 5,
"type": "number"
},
"tokens_weight_threshold": {
"description": "Tokens whose weight is less than this threshold are considered nonsignificant and pruned.",
"default": 0.4,
"type": "number"
},
"only_score_pruned_tokens": {
"description": "Whether to only score pruned tokens, vs only scoring kept tokens.",
"default": false,
"type": "boolean"
}
}
},
"_types.query_dsl.TermQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"value": {
"description": "Term you wish to find in the provided field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
}
]
},
"case_insensitive": {
"description": "Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.\nWhen `false`, the case sensitivity of matching depends on the underlying field’s mapping.",
"default": false,
"x-state": "Generally available; Added in 7.10.0",
"type": "boolean"
}
},
"required": [
"value"
]
}
],
"x-model": true
},
"_types.query_dsl.TermsQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.query_dsl.TermsSetQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"minimum_should_match": {
"description": "Specification describing number of matching terms required to return a document.",
"x-state": "Generally available; Added in 8.10.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.MinimumShouldMatch"
}
]
},
"minimum_should_match_field": {
"description": "Numeric field containing the number of matching terms required to return a document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"minimum_should_match_script": {
"description": "Custom script containing the number of matching terms required to return a document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"terms": {
"description": "Array of terms you wish to find in the provided field.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.FieldValue"
}
}
},
"required": [
"terms"
]
}
],
"x-model": true
},
"_types.query_dsl.TextExpansionQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"model_id": {
"description": "The text expansion NLP model to use",
"type": "string"
},
"model_text": {
"description": "The query text",
"type": "string"
},
"pruning_config": {
"description": "Token pruning configurations",
"x-state": "Experimental; Added in 8.13.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.TokenPruningConfig"
}
]
}
},
"required": [
"model_id",
"model_text"
]
}
],
"x-model": true
},
"_types.query_dsl.WeightedTokensQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"tokens": {
"description": "The tokens representing this query",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"type": "number"
}
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
}
]
},
"pruning_config": {
"description": "Token pruning configurations",
"allOf": [
{
"$ref": "#/components/schemas/_types.TokenPruningConfig"
}
]
}
},
"required": [
"tokens"
]
}
],
"x-model": true
},
"_types.query_dsl.WildcardQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"case_insensitive": {
"description": "Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping.",
"x-state": "Generally available; Added in 7.10.0",
"type": "boolean"
},
"rewrite": {
"description": "Method used to rewrite the query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
}
]
},
"value": {
"description": "Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.",
"type": "string"
},
"wildcard": {
"description": "Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.",
"type": "string"
}
}
}
],
"x-model": true
},
"_types.query_dsl.WrapperQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"query": {
"description": "A base64 encoded query.\nThe binary data format can be any of JSON, YAML, CBOR or SMILE encodings",
"type": "string"
}
},
"required": [
"query"
]
}
],
"x-model": true
},
"_types.query_dsl.TypeQuery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryBase"
},
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
]
},
"_types.aggregations.BucketAggregationBase": {
"description": "Base type for bucket aggregations. These aggregations also accept sub-aggregations.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Aggregation"
},
{
"type": "object"
}
]
},
"_types.aggregations.Aggregation": {
"type": "object"
},
"_types.aggregations.AutoDateHistogramAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"buckets": {
"description": "The target number of buckets.",
"default": 10,
"type": "number"
},
"field": {
"description": "The field on which to run the aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"format": {
"description": "The date format used to format `key_as_string` in the response.\nIf no `format` is specified, the first date format specified in the field mapping is used.",
"type": "string"
},
"minimum_interval": {
"description": "The minimum rounding interval.\nThis can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MinimumInterval"
},
{
"nullable": true,
"type": "string"
}
]
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"offset": {
"description": "Time zone specified as a ISO 8601 UTC offset.",
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"time_zone": {
"description": "Time zone ID.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.MinimumInterval": {
"type": "string",
"enum": [
"second",
"minute",
"hour",
"day",
"month",
"year"
]
},
"_types.DateTime": {
"description": "A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a\nnumber of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string\nrepresentation.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"_types.aggregations.AverageAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.FormatMetricAggregationBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"format": {
"type": "string"
}
}
}
]
},
"_types.aggregations.MetricAggregationBase": {
"type": "object",
"properties": {
"field": {
"description": "The field on which to run the aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Missing"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
}
},
"_types.aggregations.Missing": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"_types.aggregations.AverageBucketAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.PipelineAggregationBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation"
},
{
"type": "object",
"properties": {
"format": {
"description": "`DecimalFormat` pattern for the output value.\nIf specified, the formatted value is returned in the aggregation’s `value_as_string` property.",
"type": "string"
},
"gap_policy": {
"description": "Policy to apply when gaps are found in the data.\n\nSupported values include:\n - `skip`: Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.\n - `insert_zeros`: Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.\n - `keep_values`: Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.\n\n",
"default": "skip",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GapPolicy"
}
]
}
}
}
]
},
"_types.aggregations.GapPolicy": {
"type": "string",
"enum": [
"skip",
"insert_zeros",
"keep_values"
]
},
"_types.aggregations.BucketPathAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Aggregation"
},
{
"type": "object",
"properties": {
"buckets_path": {
"description": "Path to the buckets that contain one set of values to correlate.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsPath"
}
]
}
}
}
]
},
"_types.aggregations.BucketsPath": {
"description": "Buckets path can be expressed in different ways, and an aggregation may accept some or all of these\nforms depending on its type. Please refer to each aggregation's documentation to know what buckets\npath forms they accept.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"additionalProperties": {
"type": "string"
}
}
]
},
"_types.aggregations.BoxplotAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"compression": {
"description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.",
"type": "number"
},
"execution_hint": {
"description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.",
"default": "default",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint"
}
]
}
}
}
]
},
"_types.aggregations.TDigestExecutionHint": {
"type": "string",
"enum": [
"default",
"high_accuracy"
]
},
"_types.aggregations.BucketScriptAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"script": {
"description": "The script to run for this aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.BucketSelectorAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"script": {
"description": "The script to run for this aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.BucketSortAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Aggregation"
},
{
"type": "object",
"properties": {
"from": {
"description": "Buckets in positions prior to `from` will be truncated.",
"type": "number"
},
"gap_policy": {
"description": "The policy to apply when gaps are found in the data.\n\nSupported values include:\n - `skip`: Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.\n - `insert_zeros`: Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.\n - `keep_values`: Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.\n\n",
"default": "skip",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GapPolicy"
}
]
},
"size": {
"description": "The number of buckets to return.\nDefaults to all buckets of the parent aggregation.",
"type": "number"
},
"sort": {
"description": "The list of fields to sort on.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.BucketKsAggregation": {
"description": "A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred\nto as a \"K-S test\" from now on) against a provided distribution, and the distribution implied\nby the documents counts in the configured sibling aggregation. Specifically, for some metric,\nassuming that the percentile intervals of the metric are known beforehand or have been computed\nby an aggregation, then one would use range aggregation for the sibling to compute the p-value\nof the distribution difference between the metric and the restriction of that metric to a subset\nof the documents. A natural use case is if the sibling aggregation range aggregation nested in a\nterms aggregation, in which case one compares the overall distribution of metric to its restriction\nto each term.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation"
},
{
"type": "object",
"properties": {
"alternative": {
"description": "A list of string values indicating which K-S test alternative to calculate. The valid values\nare: \"greater\", \"less\", \"two_sided\". This parameter is key for determining the K-S statistic used\nwhen calculating the K-S test. Default value is all possible alternative hypotheses.",
"type": "array",
"items": {
"type": "string"
}
},
"fractions": {
"description": "A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results.\nIn typical usage this is the overall proportion of documents in each bucket, which is compared with the actual\ndocument proportions in each bucket from the sibling aggregation counts. The default is to assume that overall\ndocuments are uniformly distributed on these buckets, which they would be if one used equal percentiles of a\nmetric to define the bucket end points.",
"type": "array",
"items": {
"type": "number"
}
},
"sampling_method": {
"description": "Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values.\nThis determines the cumulative distribution function (CDF) points used comparing the two samples. Default is\n`upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`,\nand `lower_tail`.",
"type": "string"
}
}
}
],
"x-model": true
},
"_types.aggregations.BucketCorrelationAggregation": {
"description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation"
},
{
"type": "object",
"properties": {
"function": {
"description": "The correlation function to execute.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunction"
}
]
}
},
"required": [
"function"
]
}
],
"x-model": true
},
"_types.aggregations.BucketCorrelationFunction": {
"type": "object",
"properties": {
"count_correlation": {
"description": "The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation"
}
]
}
},
"required": [
"count_correlation"
]
},
"_types.aggregations.BucketCorrelationFunctionCountCorrelation": {
"type": "object",
"properties": {
"indicator": {
"description": "The indicator with which to correlate the configured `bucket_path` values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator"
}
]
}
},
"required": [
"indicator"
]
},
"_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator": {
"type": "object",
"properties": {
"doc_count": {
"description": "The total number of documents that initially created the expectations. It’s required to be greater\nthan or equal to the sum of all values in the buckets_path as this is the originating superset of data\nto which the term values are correlated.",
"type": "number"
},
"expectations": {
"description": "An array of numbers with which to correlate the configured `bucket_path` values.\nThe length of this value must always equal the number of buckets returned by the `bucket_path`.",
"type": "array",
"items": {
"type": "number"
}
},
"fractions": {
"description": "An array of fractions to use when averaging and calculating variance. This should be used if\nthe pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided,\nmust equal expectations.",
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"doc_count",
"expectations"
]
},
"_types.aggregations.CardinalityAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"precision_threshold": {
"description": "A unique count below which counts are expected to be close to accurate.\nThis allows to trade memory for accuracy.",
"default": 3000,
"type": "number"
},
"rehash": {
"type": "boolean"
},
"execution_hint": {
"description": "Mechanism by which cardinality aggregations is run.\n\nSupported values include:\n - `global_ordinals`: Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard.\n - `segment_ordinals`: Run the aggregation by using segment ordinal values and resolving those values after each segment.\n - `direct`: Run the aggregation by using field values directly.\n - `save_memory_heuristic`: Heuristic-based mode, default in Elasticsearch 8.3 and earlier.\n - `save_time_heuristic`: Heuristic-based mode, default in Elasticsearch 8.4 and later.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CardinalityExecutionMode"
}
]
}
}
}
]
},
"_types.aggregations.CardinalityExecutionMode": {
"type": "string",
"enum": [
"global_ordinals",
"segment_ordinals",
"direct",
"save_memory_heuristic",
"save_time_heuristic"
]
},
"_types.aggregations.CartesianBoundsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.CartesianCentroidAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.CategorizeTextAggregation": {
"description": "A multi-bucket aggregation that groups semi-structured text into buckets. Each text\nfield is re-analyzed using a custom analyzer. The resulting tokens are then categorized\ncreating buckets of similarly formatted text values. This aggregation works best with machine\ngenerated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Aggregation"
},
{
"type": "object",
"properties": {
"field": {
"description": "The semi-structured text field to categorize.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"max_unique_tokens": {
"description": "The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1.\nSmaller values use less memory and create fewer categories. Larger values will use more memory and\ncreate narrower categories. Max allowed value is 100.",
"default": 50,
"type": "number"
},
"max_matched_tokens": {
"description": "The maximum number of token positions to match on before attempting to merge categories. Larger\nvalues will use more memory and create narrower categories. Max allowed value is 100.",
"default": 5,
"type": "number"
},
"similarity_threshold": {
"description": "The minimum percentage of tokens that must match for text to be added to the category bucket. Must\nbe between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory\nusage and create narrower categories.",
"default": 50,
"type": "number"
},
"categorization_filters": {
"description": "This property expects an array of regular expressions. The expressions are used to filter out matching\nsequences from the categorization field values. You can use this functionality to fine tune the categorization\nby excluding sequences from consideration when categories are defined. For example, you can exclude SQL\nstatements that appear in your log files. This property cannot be used at the same time as categorization_analyzer.\nIf you only want to define simple regular expression filters that are applied prior to tokenization, setting\nthis property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering,\nuse the categorization_analyzer property instead and include the filters as pattern_replace character filters.",
"type": "array",
"items": {
"type": "string"
}
},
"categorization_analyzer": {
"externalDocs": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze"
},
"description": "The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.\nThe syntax is very similar to that used to define the analyzer in the analyze API. This property\ncannot be used at the same time as `categorization_filters`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CategorizeTextAnalyzer"
}
]
},
"shard_size": {
"description": "The number of categorization buckets to return from each shard before merging all the results.",
"type": "number"
},
"size": {
"description": "The number of buckets to return.",
"default": 10,
"type": "number"
},
"min_doc_count": {
"description": "The minimum number of documents in a bucket to be returned to the results.",
"type": "number"
},
"shard_min_doc_count": {
"description": "The minimum number of documents in a bucket to be returned from the shard before merging.",
"type": "number"
}
},
"required": [
"field"
]
}
],
"x-model": true
},
"_types.aggregations.CategorizeTextAnalyzer": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/_types.aggregations.CustomCategorizeTextAnalyzer"
}
]
},
"_types.aggregations.CustomCategorizeTextAnalyzer": {
"type": "object",
"properties": {
"char_filter": {
"type": "array",
"items": {
"type": "string"
}
},
"tokenizer": {
"type": "string"
},
"filter": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"_types.aggregations.ChangePointAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.ChildrenAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"type": {
"description": "The child type that should be selected.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RelationName"
}
]
}
}
}
]
},
"_types.aggregations.CompositeAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"after": {
"description": "When paginating, use the `after_key` value returned in the previous response to retrieve the next page.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey"
}
]
},
"size": {
"description": "The number of composite buckets that should be returned.",
"default": 10,
"type": "number"
},
"sources": {
"description": "The value sources used to build composite buckets.\nKeys are returned in the order of the `sources` definition.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregationSource"
},
"minProperties": 1,
"maxProperties": 1
}
}
}
}
]
},
"_types.aggregations.CompositeAggregationSource": {
"type": "object",
"properties": {
"terms": {
"description": "A terms aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeTermsAggregation"
}
]
},
"histogram": {
"description": "A histogram aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeHistogramAggregation"
}
]
},
"date_histogram": {
"description": "A date histogram aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation"
}
]
},
"geotile_grid": {
"description": "A geotile grid aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.aggregations.CompositeTermsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.CompositeAggregationBase": {
"type": "object",
"properties": {
"field": {
"description": "Either `field` or `script` must be present",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"missing_bucket": {
"type": "boolean"
},
"missing_order": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MissingOrder"
}
]
},
"script": {
"description": "Either `field` or `script` must be present",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"value_type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ValueType"
}
]
},
"order": {
"description": "\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortOrder"
}
]
}
}
},
"_types.aggregations.MissingOrder": {
"type": "string",
"enum": [
"first",
"last",
"default"
]
},
"_types.aggregations.ValueType": {
"type": "string",
"enum": [
"string",
"long",
"double",
"number",
"date",
"date_nanos",
"ip",
"numeric",
"geo_point",
"boolean"
]
},
"_types.aggregations.CompositeHistogramAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregationBase"
},
{
"type": "object",
"properties": {
"interval": {
"type": "number"
}
},
"required": [
"interval"
]
}
]
},
"_types.aggregations.CompositeDateHistogramAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregationBase"
},
{
"type": "object",
"properties": {
"format": {
"type": "string"
},
"calendar_interval": {
"description": "Either `calendar_interval` or `fixed_interval` must be present",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationLarge"
}
]
},
"fixed_interval": {
"description": "Either `calendar_interval` or `fixed_interval` must be present",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationLarge"
}
]
},
"offset": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_zone": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
}
}
}
]
},
"_types.aggregations.CompositeGeoTileGridAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregationBase"
},
{
"type": "object",
"properties": {
"precision": {
"type": "number"
},
"bounds": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoBounds"
}
]
}
}
}
]
},
"_types.aggregations.CumulativeCardinalityAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.CumulativeSumAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.DateHistogramAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"calendar_interval": {
"description": "Calendar-aware interval.\nCan be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CalendarInterval"
}
]
},
"extended_bounds": {
"description": "Enables extending the bounds of the histogram beyond the data itself.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath"
}
]
},
"hard_bounds": {
"description": "Limits the histogram to specified bounds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath"
}
]
},
"field": {
"description": "The date field whose values are use to build a histogram.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"fixed_interval": {
"description": "Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"format": {
"description": "The date format used to format `key_as_string` in the response.\nIf no `format` is specified, the first date format specified in the field mapping is used.",
"type": "string"
},
"interval": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"min_doc_count": {
"description": "Only returns buckets that have `min_doc_count` number of documents.\nBy default, all buckets between the first bucket that matches documents and the last one are returned.",
"type": "number"
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"offset": {
"description": "Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"order": {
"description": "The sort order of the returned buckets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateOrder"
}
]
},
"params": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"time_zone": {
"description": "Time zone used for bucketing and rounding.\nDefaults to Coordinated Universal Time (UTC).",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
},
"keyed": {
"description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.",
"type": "boolean"
}
}
}
]
},
"_types.aggregations.CalendarInterval": {
"type": "string",
"enum": [
"second",
"1s",
"minute",
"1m",
"hour",
"1h",
"day",
"1d",
"week",
"1w",
"month",
"1M",
"quarter",
"1q",
"year",
"1y"
]
},
"_types.aggregations.ExtendedBoundsFieldDateMath": {
"type": "object",
"properties": {
"max": {
"description": "Maximum value for the bound.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FieldDateMath"
}
]
},
"min": {
"description": "Minimum value for the bound.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FieldDateMath"
}
]
}
}
},
"_types.aggregations.FieldDateMath": {
"description": "A date range limit, represented either as a DateMath expression or a number expressed\naccording to the target field's precision.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.DateMath"
},
{
"type": "number"
}
]
},
"_types.aggregations.AggregateOrder": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.SortOrder"
},
"minProperties": 1,
"maxProperties": 1
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.SortOrder"
},
"minProperties": 1,
"maxProperties": 1
}
}
]
},
"_types.aggregations.DateRangeAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The date field whose values are use to build ranges.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"format": {
"description": "The date format used to format `from` and `to` in the response.",
"type": "string"
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Missing"
}
]
},
"ranges": {
"description": "Array of date ranges.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.DateRangeExpression"
}
},
"time_zone": {
"description": "Time zone used to convert dates from another time zone to UTC.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
},
"keyed": {
"description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.",
"type": "boolean"
}
}
}
]
},
"_types.aggregations.DateRangeExpression": {
"type": "object",
"properties": {
"from": {
"description": "Start of the range (inclusive).",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FieldDateMath"
}
]
},
"key": {
"description": "Custom key to return the range with.",
"type": "string"
},
"to": {
"description": "End of the range (exclusive).",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FieldDateMath"
}
]
}
}
},
"_types.aggregations.DerivativeAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.DiversifiedSamplerAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"execution_hint": {
"description": "The type of value used for de-duplication.\n\nSupported values include:\n - `map`: Hold field values directly.\n - `global_ordinals`: Hold ordinals of the field as determined by the Lucene index.\n - `bytes_hash`: Hold hashes of the field values - with potential for hash collisions.\n\n",
"default": "global_ordinals",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint"
}
]
},
"max_docs_per_value": {
"description": "Limits how many documents are permitted per choice of de-duplicating value.",
"default": 1,
"type": "number"
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"shard_size": {
"description": "Limits how many top-scoring documents are collected in the sample processed on each shard.",
"default": 100,
"type": "number"
},
"field": {
"description": "The field used to provide values used for de-duplication.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.SamplerAggregationExecutionHint": {
"type": "string",
"enum": [
"map",
"global_ordinals",
"bytes_hash"
]
},
"_types.aggregations.ExtendedStatsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object",
"properties": {
"sigma": {
"description": "The number of standard deviations above/below the mean to display.",
"type": "number"
}
}
}
]
},
"_types.aggregations.ExtendedStatsBucketAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"sigma": {
"description": "The number of standard deviations above/below the mean to display.",
"type": "number"
}
}
}
]
},
"_types.aggregations.FrequentItemSetsAggregation": {
"type": "object",
"properties": {
"fields": {
"description": "Fields to analyze.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsField"
}
},
"minimum_set_size": {
"description": "The minimum size of one item set.",
"default": 1,
"type": "number"
},
"minimum_support": {
"description": "The minimum support of one item set.",
"default": 0.1,
"type": "number"
},
"size": {
"description": "The number of top item sets to return.",
"default": 10,
"type": "number"
},
"filter": {
"description": "Query that filters documents from analysis.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"fields"
]
},
"_types.aggregations.FrequentItemSetsField": {
"type": "object",
"properties": {
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"exclude": {
"description": "Values to exclude.\nCan be regular expression strings or arrays of strings of exact terms.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsExclude"
}
]
},
"include": {
"description": "Values to include.\nCan be regular expression strings or arrays of strings of exact terms.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsInclude"
}
]
}
},
"required": [
"field"
]
},
"_types.aggregations.TermsExclude": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"_types.aggregations.TermsInclude": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"$ref": "#/components/schemas/_types.aggregations.TermsPartition"
}
]
},
"_types.aggregations.TermsPartition": {
"type": "object",
"properties": {
"num_partitions": {
"description": "The number of partitions.",
"type": "number"
},
"partition": {
"description": "The partition number for this request.",
"type": "number"
}
},
"required": [
"num_partitions",
"partition"
]
},
"_types.aggregations.FiltersAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"filters": {
"description": "Collection of queries from which to build buckets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsQueryContainer"
}
]
},
"other_bucket": {
"description": "Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.",
"type": "boolean"
},
"other_bucket_key": {
"description": "The key with which the other bucket is returned.",
"default": "_other_",
"type": "string"
},
"keyed": {
"description": "By default, the named filters aggregation returns the buckets as an object.\nSet to `false` to return the buckets as an array of objects.",
"default": true,
"type": "boolean"
}
}
}
]
},
"_types.aggregations.BucketsQueryContainer": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
},
"_types.aggregations.GeoBoundsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"wrap_longitude": {
"description": "Specifies whether the bounding box should be allowed to overlap the international date line.",
"default": true,
"type": "boolean"
}
}
}
]
},
"_types.aggregations.GeoCentroidAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"count": {
"type": "number"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
}
}
}
]
},
"_types.aggregations.GeoDistanceAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"distance_type": {
"description": "The distance calculation type.\n\nSupported values include:\n - `arc`: The `arc` calculation is the most accurate.\n - `plane`: The `plane` calculation is faster but less accurate.\n\n",
"default": "arc",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoDistanceType"
}
]
},
"field": {
"description": "A field of type `geo_point` used to evaluate the distance.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"origin": {
"description": "The origin used to evaluate the distance.",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
},
"ranges": {
"description": "An array of ranges used to bucket documents.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.AggregationRange"
}
},
"unit": {
"description": "The distance unit.",
"default": "m",
"allOf": [
{
"$ref": "#/components/schemas/_types.DistanceUnit"
}
]
}
}
}
]
},
"_types.aggregations.AggregationRange": {
"type": "object",
"properties": {
"from": {
"description": "Start of the range (inclusive).",
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"key": {
"description": "Custom key to return the range with.",
"type": "string"
},
"to": {
"description": "End of the range (exclusive).",
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"_types.aggregations.GeoHashGridAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"bounds": {
"description": "The bounding box to filter the points in each bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoBounds"
}
]
},
"field": {
"description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohash_grid` aggregates all array values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"precision": {
"description": "The string length of the geohashes used to define cells/buckets in the results.",
"default": "5",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoHashPrecision"
}
]
},
"shard_size": {
"description": "Allows for more accurate counting of the top cells returned in the final result the aggregation.\nDefaults to returning `max(10,(size x number-of-shards))` buckets from each shard.",
"type": "number"
},
"size": {
"description": "The maximum number of geohash buckets to return.",
"default": 10000,
"type": "number"
}
}
}
]
},
"_types.GeoHashPrecision": {
"description": "A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like \"1km\", \"10m\".",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"_types.aggregations.GeoLineAggregation": {
"type": "object",
"properties": {
"point": {
"description": "The name of the geo_point field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoLinePoint"
}
]
},
"sort": {
"description": "The name of the numeric field to use as the sort key for ordering the points.\nWhen the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoLineSort"
}
]
},
"include_sort": {
"description": "When `true`, returns an additional array of the sort values in the feature properties.",
"type": "boolean"
},
"sort_order": {
"description": "The order in which the line is sorted (ascending or descending).\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
"default": "asc",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortOrder"
}
]
},
"size": {
"description": "The maximum length of the line represented in the aggregation.\nValid sizes are between 1 and 10000.",
"default": 10000,
"type": "number"
}
},
"required": [
"point"
]
},
"_types.aggregations.GeoLinePoint": {
"type": "object",
"properties": {
"field": {
"description": "The name of the geo_point field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
},
"_types.aggregations.GeoLineSort": {
"type": "object",
"properties": {
"field": {
"description": "The name of the numeric field to use as the sort key for ordering the points.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
},
"_types.aggregations.GeoTileGridAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geotile_grid` aggregates all array values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"precision": {
"description": "Integer zoom of the key used to define cells/buckets in the results.\nValues outside of the range [0,29] will be rejected.",
"default": "7",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoTilePrecision"
}
]
},
"shard_size": {
"description": "Allows for more accurate counting of the top cells returned in the final result the aggregation.\nDefaults to returning `max(10,(size x number-of-shards))` buckets from each shard.",
"type": "number"
},
"size": {
"description": "The maximum number of buckets to return.",
"default": 10000,
"type": "number"
},
"bounds": {
"description": "A bounding box to filter the geo-points or geo-shapes in each bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoBounds"
}
]
}
}
}
]
},
"_types.GeoTilePrecision": {
"type": "number"
},
"_types.aggregations.GeohexGridAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohex_grid` aggregates all array values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"precision": {
"description": "Integer zoom of the key used to defined cells or buckets\nin the results. Value should be between 0-15.",
"default": 6,
"type": "number"
},
"bounds": {
"description": "Bounding box used to filter the geo-points in each bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoBounds"
}
]
},
"size": {
"description": "Maximum number of buckets to return.",
"default": 10000,
"type": "number"
},
"shard_size": {
"description": "Number of buckets returned from each shard.",
"type": "number"
}
},
"required": [
"field"
]
}
]
},
"_types.aggregations.GlobalAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.HistogramAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"extended_bounds": {
"description": "Enables extending the bounds of the histogram beyond the data itself.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble"
}
]
},
"hard_bounds": {
"description": "Limits the range of buckets in the histogram.\nIt is particularly useful in the case of open data ranges that can result in a very large number of buckets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble"
}
]
},
"field": {
"description": "The name of the field to aggregate on.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"interval": {
"description": "The interval for the buckets.\nMust be a positive decimal.",
"type": "number"
},
"min_doc_count": {
"description": "Only returns buckets that have `min_doc_count` number of documents.\nBy default, the response will fill gaps in the histogram with empty buckets.",
"type": "number"
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"type": "number"
},
"offset": {
"description": "By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.\nThe bucket boundaries can be shifted by using the `offset` option.",
"type": "number"
},
"order": {
"description": "The sort order of the returned buckets.\nBy default, the returned buckets are sorted by their key ascending.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateOrder"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"format": {
"type": "string"
},
"keyed": {
"description": "If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys.",
"default": false,
"type": "boolean"
}
}
}
]
},
"_types.aggregations.ExtendedBoundsdouble": {
"type": "object",
"properties": {
"max": {
"description": "Maximum value for the bound.",
"type": "number"
},
"min": {
"description": "Minimum value for the bound.",
"type": "number"
}
}
},
"_types.aggregations.IpRangeAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The date field whose values are used to build ranges.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ranges": {
"description": "Array of IP ranges.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.IpRangeAggregationRange"
}
}
}
}
]
},
"_types.aggregations.IpRangeAggregationRange": {
"type": "object",
"properties": {
"from": {
"description": "Start of the range.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"mask": {
"description": "IP range defined as a CIDR mask.",
"type": "string"
},
"to": {
"description": "End of the range.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"_types.aggregations.IpPrefixAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The IP address field to aggregation on. The field mapping type must be `ip`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"prefix_length": {
"description": "Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].\nFor IPv6 addresses the accepted range is [0, 128].",
"type": "number"
},
"is_ipv6": {
"description": "Defines whether the prefix applies to IPv6 addresses.",
"default": false,
"type": "boolean"
},
"append_prefix_length": {
"description": "Defines whether the prefix length is appended to IP address keys in the response.",
"default": false,
"type": "boolean"
},
"keyed": {
"description": "Defines whether buckets are returned as a hash rather than an array in the response.",
"type": "boolean"
},
"min_doc_count": {
"description": "Minimum number of documents in a bucket for it to be included in the response.",
"default": 1,
"type": "number"
}
},
"required": [
"field",
"prefix_length"
]
}
]
},
"_types.aggregations.InferenceAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"model_id": {
"description": "The ID or alias for the trained model.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"inference_config": {
"description": "Contains the inference type and its options.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.InferenceConfigContainer"
}
]
}
},
"required": [
"model_id"
]
}
]
},
"_types.aggregations.InferenceConfigContainer": {
"type": "object",
"properties": {
"regression": {
"description": "Regression configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.RegressionInferenceOptions"
}
]
},
"classification": {
"description": "Classification configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.RegressionInferenceOptions": {
"type": "object",
"properties": {
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"num_top_feature_importance_values": {
"description": "Specifies the maximum number of feature importance values per document.",
"default": 0,
"type": "number"
}
}
},
"ml._types.ClassificationInferenceOptions": {
"type": "object",
"properties": {
"num_top_classes": {
"description": "Specifies the number of top class predictions to return. Defaults to 0.",
"type": "number"
},
"num_top_feature_importance_values": {
"description": "Specifies the maximum number of feature importance values per document.",
"default": 0,
"type": "number"
},
"prediction_field_type": {
"description": "Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.",
"type": "string"
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"top_classes_results_field": {
"description": "Specifies the field to which the top classes are written. Defaults to top_classes.",
"type": "string"
}
}
},
"_types.aggregations.MatrixStatsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MatrixAggregation"
},
{
"type": "object",
"properties": {
"mode": {
"description": "Array value the aggregation will use for array or multi-valued fields.",
"default": "avg",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortMode"
}
]
}
}
}
]
},
"_types.aggregations.MatrixAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Aggregation"
},
{
"type": "object",
"properties": {
"fields": {
"description": "An array of fields for computing the statistics.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"type": "object",
"additionalProperties": {
"type": "number"
}
}
}
}
]
},
"_types.aggregations.MaxAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.MaxBucketAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MedianAbsoluteDeviationAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object",
"properties": {
"compression": {
"description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.",
"default": 1000,
"type": "number"
},
"execution_hint": {
"description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.",
"default": "default",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint"
}
]
}
}
}
]
},
"_types.aggregations.MinAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.MinBucketAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.MissingAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The name of the field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"missing": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Missing"
}
]
}
}
}
]
},
"_types.aggregations.MovingAverageAggregation": {
"discriminator": {
"propertyName": "model",
"mapping": {
"ewma": "#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation",
"holt": "#/components/schemas/_types.aggregations.HoltMovingAverageAggregation",
"holt_winters": "#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation",
"linear": "#/components/schemas/_types.aggregations.LinearMovingAverageAggregation",
"simple": "#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.aggregations.LinearMovingAverageAggregation"
},
{
"$ref": "#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation"
},
{
"$ref": "#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation"
},
{
"$ref": "#/components/schemas/_types.aggregations.HoltMovingAverageAggregation"
},
{
"$ref": "#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation"
}
]
},
"_types.aggregations.LinearMovingAverageAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
},
{
"type": "object",
"properties": {
"model": {
"type": "string",
"enum": [
"linear"
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EmptyObject"
}
]
}
},
"required": [
"model",
"settings"
]
}
]
},
"_types.EmptyObject": {
"description": "For empty Class assignments",
"type": "object"
},
"_types.aggregations.MovingAverageAggregationBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"minimize": {
"type": "boolean"
},
"predict": {
"type": "number"
},
"window": {
"type": "number"
}
}
}
]
},
"_types.aggregations.SimpleMovingAverageAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
},
{
"type": "object",
"properties": {
"model": {
"type": "string",
"enum": [
"simple"
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EmptyObject"
}
]
}
},
"required": [
"model",
"settings"
]
}
]
},
"_types.aggregations.EwmaMovingAverageAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
},
{
"type": "object",
"properties": {
"model": {
"type": "string",
"enum": [
"ewma"
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.EwmaModelSettings"
}
]
}
},
"required": [
"model",
"settings"
]
}
]
},
"_types.aggregations.EwmaModelSettings": {
"type": "object",
"properties": {
"alpha": {
"type": "number"
}
}
},
"_types.aggregations.HoltMovingAverageAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
},
{
"type": "object",
"properties": {
"model": {
"type": "string",
"enum": [
"holt"
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.HoltLinearModelSettings"
}
]
}
},
"required": [
"model",
"settings"
]
}
]
},
"_types.aggregations.HoltLinearModelSettings": {
"type": "object",
"properties": {
"alpha": {
"type": "number"
},
"beta": {
"type": "number"
}
}
},
"_types.aggregations.HoltWintersMovingAverageAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
},
{
"type": "object",
"properties": {
"model": {
"type": "string",
"enum": [
"holt_winters"
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.HoltWintersModelSettings"
}
]
}
},
"required": [
"model",
"settings"
]
}
]
},
"_types.aggregations.HoltWintersModelSettings": {
"type": "object",
"properties": {
"alpha": {
"type": "number"
},
"beta": {
"type": "number"
},
"gamma": {
"type": "number"
},
"pad": {
"type": "boolean"
},
"period": {
"type": "number"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.HoltWintersType"
}
]
}
}
},
"_types.aggregations.HoltWintersType": {
"type": "string",
"enum": [
"add",
"mult"
]
},
"_types.aggregations.MovingPercentilesAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"window": {
"description": "The size of window to \"slide\" across the histogram.",
"type": "number"
},
"shift": {
"description": "By default, the window consists of the last n values excluding the current bucket.\nIncreasing `shift` by 1, moves the starting window position by 1 to the right.",
"default": 0,
"type": "number"
},
"keyed": {
"type": "boolean"
}
}
}
],
"x-model": true
},
"_types.aggregations.MovingFunctionAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"script": {
"description": "The script that should be executed on each window of data.",
"type": "string"
},
"shift": {
"description": "By default, the window consists of the last n values excluding the current bucket.\nIncreasing `shift` by 1, moves the starting window position by 1 to the right.",
"default": 0,
"type": "number"
},
"window": {
"description": "The size of window to \"slide\" across the histogram.",
"type": "number"
}
}
}
],
"x-model": true
},
"_types.aggregations.MultiTermsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"collect_mode": {
"description": "Specifies the strategy for data collection.\n\nSupported values include:\n - `depth_first`: Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs.\n - `breadth_first`: Caches the set of documents that fall into the uppermost buckets for subsequent replay.\n\n",
"default": "breadth_first",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode"
}
]
},
"order": {
"description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateOrder"
}
]
},
"min_doc_count": {
"description": "The minimum number of documents in a bucket for it to be returned.",
"default": 1,
"type": "number"
},
"shard_min_doc_count": {
"description": "The minimum number of documents in a bucket on each shard for it to be returned.",
"default": 1,
"type": "number"
},
"shard_size": {
"description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.",
"type": "number"
},
"show_term_doc_count_error": {
"description": "Calculates the doc count error on per term basis.",
"default": false,
"type": "boolean"
},
"size": {
"description": "The number of term buckets should be returned out of the overall terms list.",
"default": 10,
"type": "number"
},
"terms": {
"description": "The field from which to generate sets of terms.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.MultiTermLookup"
}
}
},
"required": [
"terms"
]
}
]
},
"_types.aggregations.TermsAggregationCollectMode": {
"type": "string",
"enum": [
"depth_first",
"breadth_first"
]
},
"_types.aggregations.MultiTermLookup": {
"allOf": [
{
"type": "object",
"properties": {
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Missing"
}
]
}
}
},
{
"type": "object",
"properties": {
"field": {
"description": "A field from which to retrieve terms.\nIt is required if `script` is not provided.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"script": {
"description": "A script to calculate terms to aggregate on.\nIt is required if `field` is not provided.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"_types.aggregations.NestedAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"path": {
"description": "The path to the field of type `nested`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
}
}
]
},
"_types.aggregations.NormalizeAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"method": {
"description": "The specific method to apply.\n\nSupported values include:\n - `rescale_0_1`: This method rescales the data such that the minimum number is 0, and the maximum number is 1, with the rest normalized linearly in-between.\n - `rescale_0_100`: This method rescales the data such that the minimum number is 0, and the maximum number is 100, with the rest normalized linearly in-between.\n - `percent_of_sum`: This method normalizes each value so that it represents a percentage of the total sum it attributes to.\n - `mean`: This method normalizes such that each value is normalized by how much it differs from the average.\n - `z-score`: This method normalizes such that each value represents how far it is from the mean relative to the standard deviation.\n - `softmax`: This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.NormalizeMethod"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.NormalizeMethod": {
"type": "string",
"enum": [
"rescale_0_1",
"rescale_0_100",
"percent_of_sum",
"mean",
"z-score",
"softmax"
]
},
"_types.aggregations.ParentAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"type": {
"description": "The child type that should be selected.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RelationName"
}
]
}
}
}
]
},
"_types.aggregations.PercentileRanksAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object",
"properties": {
"keyed": {
"description": "By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.\nSet to `false` to disable this behavior.",
"default": true,
"type": "boolean"
},
"values": {
"description": "An array of values for which to calculate the percentile ranks.",
"oneOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"nullable": true,
"type": "string"
}
]
},
"hdr": {
"description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.HdrMethod"
}
]
},
"tdigest": {
"description": "Sets parameters for the default TDigest algorithm used to calculate percentile ranks.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TDigest"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.HdrMethod": {
"type": "object",
"properties": {
"number_of_significant_value_digits": {
"description": "Specifies the resolution of values for the histogram in number of significant digits.",
"type": "number"
}
}
},
"_types.aggregations.TDigest": {
"type": "object",
"properties": {
"compression": {
"description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.",
"type": "number"
},
"execution_hint": {
"description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.",
"default": "default",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint"
}
]
}
}
},
"_types.aggregations.PercentilesAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object",
"properties": {
"keyed": {
"description": "By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.\nSet to `false` to disable this behavior.",
"default": true,
"type": "boolean"
},
"percents": {
"description": "The percentiles to calculate.",
"oneOf": [
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "number"
}
}
]
},
"hdr": {
"description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.HdrMethod"
}
]
},
"tdigest": {
"description": "Sets parameters for the default TDigest algorithm used to calculate percentiles.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TDigest"
}
]
}
}
}
]
},
"_types.aggregations.PercentilesBucketAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"percents": {
"description": "The list of percentiles to calculate.",
"type": "array",
"items": {
"type": "number"
}
}
}
}
]
},
"_types.aggregations.RangeAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The date field whose values are use to build ranges.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"type": "number"
},
"ranges": {
"description": "An array of ranges used to bucket documents.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.AggregationRange"
}
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"keyed": {
"description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.",
"type": "boolean"
},
"format": {
"type": "string"
}
}
}
]
},
"_types.aggregations.RareTermsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"exclude": {
"description": "Terms that should be excluded from the aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsExclude"
}
]
},
"field": {
"description": "The field from which to return rare terms.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"include": {
"description": "Terms that should be included in the aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsInclude"
}
]
},
"max_doc_count": {
"description": "The maximum number of documents a term should appear in.",
"default": 1,
"type": "number"
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Missing"
}
]
},
"precision": {
"description": "The precision of the internal CuckooFilters.\nSmaller precision leads to better approximation, but higher memory usage.",
"default": 0.001,
"type": "number"
},
"value_type": {
"type": "string"
}
}
}
],
"x-model": true
},
"_types.aggregations.RateAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object",
"properties": {
"unit": {
"description": "The interval used to calculate the rate.\nBy default, the interval of the `date_histogram` is used.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CalendarInterval"
}
]
},
"mode": {
"description": "How the rate is calculated.\n\nSupported values include:\n - `sum`: Calculates the sum of all values of the field.\n - `value_count`: Uses the number of values of the field.\n\n",
"default": "sum",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.RateMode"
}
]
}
}
}
]
},
"_types.aggregations.RateMode": {
"type": "string",
"enum": [
"sum",
"value_count"
]
},
"_types.aggregations.ReverseNestedAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"path": {
"description": "Defines the nested object field that should be joined back to.\nThe default is empty, which means that it joins back to the root/main document level.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
}
}
]
},
"_types.aggregations.RandomSamplerAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"probability": {
"description": "The probability that a document will be included in the aggregated data.\nMust be greater than 0, less than 0.5, or exactly 1.\nThe lower the probability, the fewer documents are matched.",
"type": "number"
},
"seed": {
"description": "The seed to generate the random sampling of documents.\nWhen a seed is provided, the random subset of documents is the same between calls.",
"type": "number"
},
"shard_seed": {
"description": "When combined with seed, setting shard_seed ensures 100% consistent sampling over shards where data is exactly the same.",
"x-state": "Generally available; Added in 8.14.0",
"type": "number"
}
},
"required": [
"probability"
]
}
],
"x-model": true
},
"_types.aggregations.SamplerAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"shard_size": {
"description": "Limits how many top-scoring documents are collected in the sample processed on each shard.",
"default": 100,
"type": "number"
}
}
}
]
},
"_types.aggregations.ScriptedMetricAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"combine_script": {
"description": "Runs once on each shard after document collection is complete.\nAllows the aggregation to consolidate the state returned from each shard.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"init_script": {
"description": "Runs prior to any collection of documents.\nAllows the aggregation to set up any initial state.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"map_script": {
"description": "Run once per document collected.\nIf no `combine_script` is specified, the resulting state needs to be stored in the `state` object.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"params": {
"description": "A global object with script parameters for `init`, `map` and `combine` scripts.\nIt is shared between the scripts.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"reduce_script": {
"description": "Runs once on the coordinating node after all shards have returned their results.\nThe script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
}
}
]
},
"_types.aggregations.SerialDifferencingAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object",
"properties": {
"lag": {
"description": "The historical bucket to subtract from the current value.\nMust be a positive, non-zero integer.",
"type": "number"
}
}
}
],
"x-model": true
},
"_types.aggregations.SignificantTermsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"background_filter": {
"description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"chi_square": {
"description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic"
}
]
},
"exclude": {
"description": "Terms to exclude.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsExclude"
}
]
},
"execution_hint": {
"description": "Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint"
}
]
},
"field": {
"description": "The field from which to return significant terms.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"gnd": {
"description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic"
}
]
},
"include": {
"description": "Terms to include.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsInclude"
}
]
},
"jlh": {
"description": "Use JLH score as the significance score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EmptyObject"
}
]
},
"min_doc_count": {
"description": "Only return terms that are found in more than `min_doc_count` hits.",
"default": 3,
"type": "number"
},
"mutual_information": {
"description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic"
}
]
},
"percentage": {
"description": "A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic"
}
]
},
"script_heuristic": {
"description": "Customized score, implemented via a script.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic"
}
]
},
"p_value": {
"description": "Significant terms heuristic that calculates the p-value between the term existing in foreground and background sets.\n\nThe p-value is the probability of obtaining test results at least as extreme as\nthe results actually observed, under the assumption that the null hypothesis is\ncorrect. The p-value is calculated assuming that the foreground set and the\nbackground set are independent https://en.wikipedia.org/wiki/Bernoulli_trial, with the null\nhypothesis that the probabilities are the same.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PValueHeuristic"
}
]
},
"shard_min_doc_count": {
"description": "Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.\nTerms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.",
"type": "number"
},
"shard_size": {
"description": "Can be used to control the volumes of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.",
"type": "number"
},
"size": {
"description": "The number of buckets returned out of the overall terms list.",
"type": "number"
}
}
}
],
"x-model": true
},
"_types.aggregations.ChiSquareHeuristic": {
"type": "object",
"properties": {
"background_is_superset": {
"description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.",
"type": "boolean"
},
"include_negatives": {
"description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.",
"type": "boolean"
}
},
"required": [
"background_is_superset",
"include_negatives"
]
},
"_types.aggregations.TermsAggregationExecutionHint": {
"type": "string",
"enum": [
"map",
"global_ordinals",
"global_ordinals_hash",
"global_ordinals_low_cardinality"
]
},
"_types.aggregations.GoogleNormalizedDistanceHeuristic": {
"type": "object",
"properties": {
"background_is_superset": {
"description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.",
"type": "boolean"
}
}
},
"_types.aggregations.MutualInformationHeuristic": {
"type": "object",
"properties": {
"background_is_superset": {
"description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.",
"type": "boolean"
},
"include_negatives": {
"description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.",
"type": "boolean"
}
}
},
"_types.aggregations.PercentageScoreHeuristic": {
"type": "object"
},
"_types.aggregations.ScriptedHeuristic": {
"type": "object",
"properties": {
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"script"
]
},
"_types.aggregations.PValueHeuristic": {
"type": "object",
"properties": {
"background_is_superset": {
"type": "boolean"
},
"normalize_above": {
"description": "Should the results be normalized when above the given value.\nAllows for consistent significance results at various scales.\nNote: `0` is a special value which means no normalization",
"default": 0,
"type": "number"
}
}
},
"_types.aggregations.SignificantTextAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"background_filter": {
"description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"chi_square": {
"description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic"
}
]
},
"exclude": {
"description": "Values to exclude.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsExclude"
}
]
},
"execution_hint": {
"description": "Determines whether the aggregation will use field values directly or global ordinals.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint"
}
]
},
"field": {
"description": "The field from which to return significant text.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"filter_duplicate_text": {
"description": "Whether to out duplicate text to deal with noisy data.",
"type": "boolean"
},
"gnd": {
"description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic"
}
]
},
"include": {
"description": "Values to include.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsInclude"
}
]
},
"jlh": {
"description": "Use JLH score as the significance score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EmptyObject"
}
]
},
"min_doc_count": {
"description": "Only return values that are found in more than `min_doc_count` hits.",
"default": 3,
"type": "number"
},
"mutual_information": {
"description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic"
}
]
},
"percentage": {
"description": "A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic"
}
]
},
"script_heuristic": {
"description": "Customized score, implemented via a script.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic"
}
]
},
"shard_min_doc_count": {
"description": "Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.\nValues will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.",
"type": "number"
},
"shard_size": {
"description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.",
"type": "number"
},
"size": {
"description": "The number of buckets returned out of the overall terms list.",
"type": "number"
},
"source_fields": {
"description": "Overrides the JSON `_source` fields from which text will be analyzed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
}
}
}
],
"x-model": true
},
"_types.aggregations.StatsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.StatsBucketAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.StringStatsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"show_distribution": {
"description": "Shows the probability distribution for all characters.",
"default": false,
"type": "boolean"
}
}
}
]
},
"_types.aggregations.SumAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
},
{
"type": "object"
}
]
},
"_types.aggregations.SumBucketAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
},
{
"type": "object"
}
],
"x-model": true
},
"_types.aggregations.TermsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"collect_mode": {
"description": "Determines how child aggregations should be calculated: breadth-first or depth-first.\n\nSupported values include:\n - `depth_first`: Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs.\n - `breadth_first`: Caches the set of documents that fall into the uppermost buckets for subsequent replay.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode"
}
]
},
"exclude": {
"description": "Values to exclude.\nAccepts regular expressions and partitions.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsExclude"
}
]
},
"execution_hint": {
"description": "Determines whether the aggregation will use field values directly or global ordinals.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint"
}
]
},
"field": {
"description": "The field from which to return terms.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"include": {
"description": "Values to include.\nAccepts regular expressions and partitions.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsInclude"
}
]
},
"min_doc_count": {
"description": "Only return values that are found in more than `min_doc_count` hits.",
"default": 1,
"type": "number"
},
"missing": {
"description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Missing"
}
]
},
"missing_order": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MissingOrder"
}
]
},
"missing_bucket": {
"type": "boolean"
},
"value_type": {
"description": "Coerced unmapped fields into the specified type.",
"type": "string"
},
"order": {
"description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.AggregateOrder"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"shard_min_doc_count": {
"description": "Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.\nTerms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.",
"type": "number"
},
"shard_size": {
"description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.",
"type": "number"
},
"show_term_doc_count_error": {
"description": "Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard.",
"type": "boolean"
},
"size": {
"description": "The number of buckets returned out of the overall terms list.",
"default": 10,
"type": "number"
},
"format": {
"type": "string"
}
}
}
],
"x-model": true
},
"_types.aggregations.TimeSeriesAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"size": {
"description": "The maximum number of results to return.",
"default": 10000,
"type": "number"
},
"keyed": {
"description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.",
"type": "boolean"
}
}
}
]
},
"_types.aggregations.TopHitsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"docvalue_fields": {
"description": "Fields for which to return doc values.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"explain": {
"description": "If `true`, returns detailed information about score computation as part of a hit.",
"default": false,
"type": "boolean"
},
"fields": {
"description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"from": {
"description": "Starting document offset.",
"default": 0,
"type": "number"
},
"highlight": {
"description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Highlight"
}
]
},
"script_fields": {
"description": "Returns the result of one or more script evaluations for each hit.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ScriptField"
}
},
"size": {
"description": "The maximum number of top matching hits to return per bucket.",
"default": 3,
"type": "number"
},
"sort": {
"description": "Sort order of the top matching hits.\nBy default, the hits are sorted by the score of the main query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"_source": {
"description": "Selects the fields of the source that are returned.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"stored_fields": {
"description": "Returns values for the specified stored fields (fields that use the `store` mapping option).",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"track_scores": {
"description": "If `true`, calculates and returns document scores, even if the scores are not used for sorting.",
"default": false,
"type": "boolean"
},
"version": {
"description": "If `true`, returns document version as part of a hit.",
"default": false,
"type": "boolean"
},
"seq_no_primary_term": {
"description": "If `true`, returns sequence number and primary term of the last modification of each hit.",
"type": "boolean"
}
}
}
]
},
"_types.aggregations.TTestAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Aggregation"
},
{
"type": "object",
"properties": {
"a": {
"description": "Test population A.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TestPopulation"
}
]
},
"b": {
"description": "Test population B.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TestPopulation"
}
]
},
"type": {
"description": "The type of test.\n\nSupported values include:\n - `paired`: Performs paired t-test.\n - `homoscedastic`: Performs two-sample equal variance test.\n - `heteroscedastic`: Performs two-sample unequal variance test.\n\n",
"default": "heteroscedastic",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TTestType"
}
]
}
}
}
]
},
"_types.aggregations.TestPopulation": {
"type": "object",
"properties": {
"field": {
"description": "The field to aggregate.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"filter": {
"description": "A filter used to define a set of records to run unpaired t-test on.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"field"
]
},
"_types.aggregations.TTestType": {
"type": "string",
"enum": [
"paired",
"homoscedastic",
"heteroscedastic"
]
},
"_types.aggregations.TopMetricsAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"metrics": {
"description": "The fields of the top document to return.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TopMetricsValue"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.aggregations.TopMetricsValue"
}
}
]
},
"size": {
"description": "The number of top documents from which to return metrics.",
"default": 1,
"type": "number"
},
"sort": {
"description": "The sort order of the documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
}
}
}
]
},
"_types.aggregations.TopMetricsValue": {
"type": "object",
"properties": {
"field": {
"description": "A field to return as a metric.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
},
"_types.aggregations.ValueCountAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.FormattableMetricAggregation"
},
{
"type": "object"
}
]
},
"_types.aggregations.FormattableMetricAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
},
{
"type": "object",
"properties": {
"format": {
"type": "string"
}
}
}
]
},
"_types.aggregations.WeightedAverageAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.Aggregation"
},
{
"type": "object",
"properties": {
"format": {
"description": "A numeric response formatter.",
"type": "string"
},
"value": {
"description": "Configuration for the field that provides the values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue"
}
]
},
"value_type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ValueType"
}
]
},
"weight": {
"description": "Configuration for the field or script that provides the weights.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue"
}
]
}
}
}
]
},
"_types.aggregations.WeightedAverageValue": {
"type": "object",
"properties": {
"field": {
"description": "The field from which to extract the values or weights.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"missing": {
"description": "A value or weight to use if the field is missing.",
"type": "number"
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
}
},
"_types.aggregations.VariableWidthHistogramAggregation": {
"type": "object",
"properties": {
"field": {
"description": "The name of the field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"buckets": {
"description": "The target number of buckets.",
"default": 10,
"type": "number"
},
"shard_size": {
"description": "The number of buckets that the coordinating node will request from each shard.\nDefaults to `buckets * 50`.",
"type": "number"
},
"initial_buffer": {
"description": "Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.\nDefaults to `min(10 * shard_size, 50000)`.",
"type": "number"
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
}
},
"_global.search._types.TrackHits": {
"description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.",
"oneOf": [
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"_types.KnnSearch": {
"type": "object",
"properties": {
"field": {
"description": "The name of the vector field to search against",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"query_vector": {
"description": "The query vector",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryVector"
}
]
},
"query_vector_builder": {
"description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryVectorBuilder"
}
]
},
"k": {
"description": "The final number of nearest neighbors to return as top hits",
"type": "number"
},
"num_candidates": {
"description": "The number of nearest neighbor candidates to consider per shard",
"type": "number"
},
"visit_percentage": {
"description": "The percentage of vectors to explore per shard while doing knn search with bbq_disk",
"x-state": "Generally available; Added in 9.2.0",
"type": "number"
},
"boost": {
"description": "Boost value to apply to kNN scores",
"type": "number"
},
"filter": {
"description": "Filters for the kNN search query",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
},
"similarity": {
"description": "The minimum similarity for a vector to be considered a match",
"type": "number"
},
"inner_hits": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits"
},
"description": "If defined, each search hit will contain inner hits.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.InnerHits"
}
]
},
"rescore_vector": {
"description": "Apply oversampling and rescoring to quantized vectors",
"x-state": "Generally available; Added in 8.18.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.RescoreVector"
}
]
},
"_name": {
"type": "string"
}
},
"required": [
"field"
]
},
"_types.RankContainer": {
"type": "object",
"properties": {
"rrf": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reciprocal-rank-fusion"
},
"description": "The reciprocal rank fusion parameters",
"allOf": [
{
"$ref": "#/components/schemas/_types.RrfRank"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.RrfRank": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RankBase"
},
{
"type": "object",
"properties": {
"rank_constant": {
"description": "How much influence documents in individual result sets per query have over the final ranked result set",
"type": "number"
},
"rank_window_size": {
"description": "Size of the individual result sets per query",
"type": "number"
}
}
}
]
},
"_types.RankBase": {
"type": "object"
},
"_global.search._types.Rescore": {
"allOf": [
{
"type": "object",
"properties": {
"window_size": {
"type": "number"
}
}
},
{
"type": "object",
"properties": {
"query": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.RescoreQuery"
}
]
},
"learning_to_rank": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.LearningToRank"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.ScriptRescore"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"_global.search._types.RescoreQuery": {
"type": "object",
"properties": {
"rescore_query": {
"description": "The query to use for rescoring.\nThis query is only run on the Top-K results returned by the `query` and `post_filter` phases.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"query_weight": {
"description": "Relative importance of the original query versus the rescore query.",
"default": 1,
"type": "number"
},
"rescore_query_weight": {
"description": "Relative importance of the rescore query versus the original query.",
"default": 1,
"type": "number"
},
"score_mode": {
"description": "Determines how scores are combined.\n\nSupported values include:\n - `avg`: Average the original score and the rescore query score.\n - `max`: Take the max of original score and the rescore query score.\n - `min`: Take the min of the original score and the rescore query score.\n - `multiply`: Multiply the original score by the rescore query score.\nUseful for `function` query rescores.\n - `total`: Add the original score and the rescore query score.\n\n",
"default": "total",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.ScoreMode"
}
]
}
},
"required": [
"rescore_query"
]
},
"_global.search._types.ScoreMode": {
"type": "string",
"enum": [
"avg",
"max",
"min",
"multiply",
"total"
]
},
"_global.search._types.LearningToRank": {
"type": "object",
"properties": {
"model_id": {
"description": "The unique identifier of the trained model uploaded to Elasticsearch",
"type": "string"
},
"params": {
"description": "Named parameters to be passed to the query templates used for feature",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"model_id"
]
},
"_global.search._types.ScriptRescore": {
"type": "object",
"properties": {
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"script"
]
},
"_types.RetrieverContainer": {
"type": "object",
"properties": {
"standard": {
"description": "A retriever that replaces the functionality of a traditional query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.StandardRetriever"
}
]
},
"knn": {
"description": "A retriever that replaces the functionality of a knn search.",
"allOf": [
{
"$ref": "#/components/schemas/_types.KnnRetriever"
}
]
},
"rrf": {
"description": "A retriever that produces top documents from reciprocal rank fusion (RRF).",
"allOf": [
{
"$ref": "#/components/schemas/_types.RRFRetriever"
}
]
},
"text_similarity_reranker": {
"description": "A retriever that reranks the top documents based on a reranking model using the InferenceAPI",
"allOf": [
{
"$ref": "#/components/schemas/_types.TextSimilarityReranker"
}
]
},
"rule": {
"description": "A retriever that replaces the functionality of a rule query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RuleRetriever"
}
]
},
"rescorer": {
"description": "A retriever that re-scores only the results produced by its child retriever.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RescorerRetriever"
}
]
},
"linear": {
"description": "A retriever that supports the combination of different retrievers through a weighted linear combination.",
"allOf": [
{
"$ref": "#/components/schemas/_types.LinearRetriever"
}
]
},
"pinned": {
"description": "A pinned retriever applies pinned documents to the underlying retriever.\nThis retriever will rewrite to a PinnedQueryBuilder.",
"allOf": [
{
"$ref": "#/components/schemas/_types.PinnedRetriever"
}
]
},
"diversify": {
"description": "A retriever that diversifies the results from its child retriever.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DiversifyRetriever"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.StandardRetriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"query": {
"description": "Defines a query to retrieve a set of top documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"search_after": {
"description": "Defines a search after object parameter used for pagination.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
},
"terminate_after": {
"description": "Maximum number of documents to collect for each shard.",
"type": "number"
},
"sort": {
"description": "A sort object that that specifies the order of matching documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"collapse": {
"description": "Collapses the top documents by a specified key into a single top document per key.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FieldCollapse"
}
]
}
}
}
]
},
"_types.RetrieverBase": {
"type": "object",
"properties": {
"filter": {
"description": "Query to filter the documents that can match.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
},
"min_score": {
"description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.",
"type": "number"
},
"_name": {
"description": "Retriever name.",
"type": "string"
}
}
},
"_types.KnnRetriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The name of the vector field to search against.",
"type": "string"
},
"query_vector": {
"description": "Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both.",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryVector"
}
]
},
"query_vector_builder": {
"description": "Defines a model to build a query vector.",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryVectorBuilder"
}
]
},
"k": {
"description": "Number of nearest neighbors to return as top hits.",
"type": "number"
},
"num_candidates": {
"description": "Number of nearest neighbor candidates to consider per shard.",
"type": "number"
},
"visit_percentage": {
"description": "The percentage of vectors to explore per shard while doing knn search with bbq_disk",
"x-state": "Generally available; Added in 9.2.0",
"type": "number"
},
"similarity": {
"description": "The minimum similarity required for a document to be considered a match.",
"type": "number"
},
"rescore_vector": {
"description": "Apply oversampling and rescoring to quantized vectors",
"x-state": "Generally available; Added in 8.18.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.RescoreVector"
}
]
}
},
"required": [
"field",
"k",
"num_candidates"
]
}
]
},
"_types.RRFRetriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"retrievers": {
"description": "A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. Each retriever can optionally include a weight parameter.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.RRFRetrieverEntry"
}
},
"rank_constant": {
"description": "This value determines how much influence documents in individual result sets per query have over the final ranked result set.",
"type": "number"
},
"rank_window_size": {
"description": "This value determines the size of the individual result sets per query.",
"type": "number"
},
"query": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"retrievers"
]
}
]
},
"_types.RRFRetrieverEntry": {
"description": "Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
},
{
"$ref": "#/components/schemas/_types.RRFRetrieverComponent"
}
]
},
"_types.RRFRetrieverComponent": {
"description": "Wraps a retriever with an optional weight for RRF scoring.",
"type": "object",
"properties": {
"retriever": {
"description": "The nested retriever configuration.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"weight": {
"description": "Weight multiplier for this retriever's contribution to the RRF score. Higher values increase influence. Defaults to 1.0 if not specified. Must be non-negative.",
"default": 1,
"type": "number"
}
},
"required": [
"retriever"
]
},
"_types.TextSimilarityReranker": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"retriever": {
"description": "The nested retriever which will produce the first-level results, that will later be used for reranking.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"rank_window_size": {
"description": "This value determines how many documents we will consider from the nested retriever.",
"type": "number"
},
"inference_id": {
"description": "Unique identifier of the inference endpoint created using the inference API.",
"type": "string"
},
"inference_text": {
"description": "The text snippet used as the basis for similarity comparison.",
"type": "string"
},
"field": {
"description": "The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text.",
"type": "string"
},
"chunk_rescorer": {
"description": "Whether to rescore on only the best matching chunks.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.ChunkRescorer"
}
]
}
},
"required": [
"retriever",
"inference_text",
"field"
]
}
]
},
"_types.ChunkRescorer": {
"type": "object",
"properties": {
"size": {
"description": "The number of chunks per document to evaluate for reranking.",
"type": "number"
},
"chunking_settings": {
"description": "Chunking settings to apply",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.ChunkRescorerChunkingSettings"
}
]
}
}
},
"_types.mapping.ChunkRescorerChunkingSettings": {
"type": "object",
"properties": {
"max_chunk_size": {
"description": "The maximum size of a chunk in words.\nThis value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).\nThis value should not exceed the window size for the associated model.",
"default": 250,
"type": "number"
},
"overlap": {
"description": "The number of overlapping words for chunks.\nIt is applicable only to a `word` chunking strategy.\nThis value cannot be higher than half the `max_chunk_size` value.",
"default": 100,
"type": "number"
},
"sentence_overlap": {
"description": "The number of overlapping sentences for chunks.\nIt is applicable only for a `sentence` chunking strategy.\nIt can be either `1` or `0`.",
"default": 1,
"type": "number"
},
"separator_group": {
"description": "Only applicable to the `recursive` strategy and required when using it.\n\nSets a predefined list of separators in the saved chunking settings based on the selected text type.\nValues can be `markdown` or `plaintext`.\n\nUsing this parameter is an alternative to manually specifying a custom `separators` list.",
"type": "string"
},
"separators": {
"description": "Only applicable to the `recursive` strategy and required when using it.\n\nA list of strings used as possible split points when chunking text.\n\nEach string can be a plain string or a regular expression (regex) pattern.\nThe system tries each separator in order to split the text, starting from the first item in the list.\n\nAfter splitting, it attempts to recombine smaller pieces into larger chunks that stay within\nthe `max_chunk_size` limit, to reduce the total number of chunks generated.",
"type": "array",
"items": {
"type": "string"
}
},
"strategy": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies"
},
"description": "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation.",
"default": "sentence",
"type": "string"
}
},
"required": [
"max_chunk_size"
]
},
"_types.RuleRetriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"ruleset_ids": {
"description": "The ruleset IDs containing the rules this retriever is evaluating against.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.Id"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
}
]
},
"match_criteria": {
"description": "The match criteria that will determine if a rule in the provided rulesets should be applied.",
"type": "object"
},
"retriever": {
"description": "The retriever whose results rules should be applied to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"rank_window_size": {
"description": "This value determines the size of the individual result set.",
"type": "number"
}
},
"required": [
"ruleset_ids",
"match_criteria",
"retriever"
]
}
]
},
"_types.RescorerRetriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"retriever": {
"description": "Inner retriever.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"rescore": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.Rescore"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Rescore"
}
}
]
}
},
"required": [
"retriever",
"rescore"
]
}
]
},
"_types.LinearRetriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"retrievers": {
"description": "Inner retrievers.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.InnerRetriever"
}
},
"rank_window_size": {
"type": "number"
},
"query": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"normalizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScoreNormalizer"
}
]
}
}
}
]
},
"_types.InnerRetriever": {
"type": "object",
"properties": {
"retriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"weight": {
"type": "number"
},
"normalizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScoreNormalizer"
}
]
}
},
"required": [
"retriever",
"weight",
"normalizer"
]
},
"_types.ScoreNormalizer": {
"type": "string",
"enum": [
"none",
"minmax",
"l2_norm"
]
},
"_types.PinnedRetriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"retriever": {
"description": "Inner retriever.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"docs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.SpecifiedDocument"
}
},
"rank_window_size": {
"type": "number"
}
},
"required": [
"retriever"
]
}
]
},
"_types.SpecifiedDocument": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
},
"required": [
"id"
]
},
"_types.DiversifyRetriever": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverBase"
},
{
"type": "object",
"properties": {
"type": {
"description": "The diversification strategy to apply.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DiversifyRetrieverTypes"
}
]
},
"field": {
"description": "The document field on which to diversify results on.",
"type": "string"
},
"retriever": {
"description": "The nested retriever whose results will be diversified.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"size": {
"description": "The number of top documents to return after diversification.",
"type": "number"
},
"rank_window_size": {
"description": "The number of top documents from the nested retriever to consider for diversification.",
"type": "number"
},
"query_vector": {
"description": "The query vector used for diversification.",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryVector"
}
]
},
"query_vector_builder": {
"description": "a dense vector query vector builder to use instead of a static query_vector",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryVectorBuilder"
}
]
},
"lambda": {
"description": "Controls the trade-off between relevance and diversity for MMR. A value of 0.0 focuses solely on diversity, while a value of 1.0 focuses solely on relevance. Required for MMR",
"type": "number"
}
},
"required": [
"type",
"field",
"retriever"
]
}
]
},
"_types.DiversifyRetrieverTypes": {
"type": "string",
"enum": [
"mmr"
]
},
"_types.SlicedScroll": {
"type": "object",
"properties": {
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"max": {
"type": "number"
}
},
"required": [
"id",
"max"
]
},
"_global.search._types.Suggester": {
"type": "object",
"properties": {
"text": {
"description": "Global suggest text, to avoid repetition when the same text is used in several suggesters",
"type": "string"
}
}
},
"_global.search._types.PointInTimeReference": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"keep_alive": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"id"
]
},
"_types.mapping.RuntimeFields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.RuntimeField"
}
},
"_types.mapping.RuntimeField": {
"type": "object",
"properties": {
"fields": {
"description": "For type `composite`",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.CompositeSubField"
}
},
"fetch_fields": {
"description": "For type `lookup`",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.mapping.RuntimeFieldFetchFields"
}
},
"format": {
"description": "A custom format for `date` type runtime fields.",
"type": "string"
},
"input_field": {
"description": "For type `lookup`",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"target_field": {
"description": "For type `lookup`",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"target_index": {
"description": "For type `lookup`",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"script": {
"description": "Painless script executed at query time.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"type": {
"description": "Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFieldType"
}
]
}
},
"required": [
"type"
]
},
"_types.mapping.CompositeSubField": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFieldType"
}
]
}
},
"required": [
"type"
]
},
"_types.mapping.RuntimeFieldType": {
"type": "string",
"enum": [
"boolean",
"composite",
"date",
"double",
"geo_point",
"geo_shape",
"ip",
"keyword",
"long",
"lookup"
]
},
"_types.mapping.RuntimeFieldFetchFields": {
"type": "object",
"properties": {
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"format": {
"type": "string"
}
},
"required": [
"field"
]
},
"_types.ScrollId": {
"type": "string"
},
"_global.search._types.Suggest": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.CompletionSuggest"
},
{
"$ref": "#/components/schemas/_global.search._types.PhraseSuggest"
},
{
"$ref": "#/components/schemas/_global.search._types.TermSuggest"
}
]
},
"_global.search._types.CompletionSuggest": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SuggestBase"
},
{
"type": "object",
"properties": {
"options": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.CompletionSuggestOption"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.CompletionSuggestOption"
}
}
]
}
},
"required": [
"options"
]
}
]
},
"_global.search._types.CompletionSuggestOption": {
"type": "object",
"properties": {
"collate_match": {
"type": "boolean"
},
"contexts": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Context"
}
}
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"_id": {
"type": "string"
},
"_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_routing": {
"type": "string"
},
"_score": {
"type": "number"
},
"_source": {
"type": "object"
},
"text": {
"type": "string"
},
"score": {
"type": "number"
}
},
"required": [
"text"
]
},
"_global.search._types.Context": {
"description": "Text or location that we want similar documents for or a lookup to a document's field for the text.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
},
"_global.search._types.SuggestBase": {
"type": "object",
"properties": {
"length": {
"type": "number"
},
"offset": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": [
"length",
"offset",
"text"
]
},
"_global.search._types.PhraseSuggest": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SuggestBase"
},
{
"type": "object",
"properties": {
"options": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.PhraseSuggestOption"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.PhraseSuggestOption"
}
}
]
}
},
"required": [
"options"
]
}
]
},
"_global.search._types.PhraseSuggestOption": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"score": {
"type": "number"
},
"highlighted": {
"type": "string"
},
"collate_match": {
"type": "boolean"
}
},
"required": [
"text",
"score"
]
},
"_global.search._types.TermSuggest": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SuggestBase"
},
{
"type": "object",
"properties": {
"options": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.TermSuggestOption"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.TermSuggestOption"
}
}
]
}
},
"required": [
"options"
]
}
]
},
"_global.search._types.TermSuggestOption": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"score": {
"type": "number"
},
"freq": {
"type": "number"
},
"highlighted": {
"type": "string"
},
"collate_match": {
"type": "boolean"
}
},
"required": [
"text",
"score",
"freq"
]
},
"async_search._types.AsyncSearchResponseBase": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"is_partial": {
"description": "When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.\nWhile the query is running, `is_partial` is always set to `true`.",
"type": "boolean"
},
"is_running": {
"description": "Indicates whether the search is still running or has completed.\n\n> info\n> If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.",
"type": "boolean"
},
"expiration_time": {
"description": "Indicates when the async search will expire.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"expiration_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"start_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"start_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"completion_time": {
"description": "Indicates when the async search completed.\nIt is present only when the search has completed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"completion_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"is_partial",
"is_running",
"expiration_time_in_millis",
"start_time_in_millis"
]
},
"async_search.status.StatusResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/async_search._types.AsyncSearchResponseBase"
},
{
"type": "object",
"properties": {
"_shards": {
"description": "The number of shards that have run the query so far.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"_clusters": {
"description": "Metadata about clusters involved in the cross-cluster search.\nIt is not shown for local-only searches.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ClusterStatistics"
}
]
},
"completion_status": {
"description": "If the async search completed, this field shows the status code of the search.\nFor example, `200` indicates that the async search was successfully completed.\n`503` indicates that the async search was completed with an error.",
"type": "number"
}
},
"required": [
"_shards"
]
}
]
},
"_types.Indices": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
]
},
"_types.ExpandWildcards": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.ExpandWildcard"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ExpandWildcard"
}
}
]
},
"_types.ExpandWildcard": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"_types.SearchType": {
"type": "string",
"enum": [
"query_then_fetch",
"dfs_query_then_fetch"
]
},
"_types.SuggestMode": {
"type": "string",
"enum": [
"missing",
"popular",
"always"
]
},
"_global.search._types.SourceConfigParam": {
"description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.\nUsed as a query parameter along with the `_source_includes` and `_source_excludes` parameters.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"_types.Refresh": {
"type": "string",
"enum": [
"true",
"false",
"wait_for"
]
},
"_types.WaitForActiveShards": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/components/schemas/_types.WaitForActiveShardOptions"
}
]
},
"_types.WaitForActiveShardOptions": {
"type": "string",
"enum": [
"all",
"index-setting"
]
},
"_global.bulk.OperationContainer": {
"type": "object",
"properties": {
"index": {
"description": "Index the specified document.\nIf the document exists, it replaces the document and increments the version.\nThe following line must contain the source data to be indexed.",
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.IndexOperation"
}
]
},
"create": {
"description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.",
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.CreateOperation"
}
]
},
"update": {
"description": "Perform a partial document update.\nThe following line must contain the partial document and update options.",
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.UpdateOperation"
}
]
},
"delete": {
"description": "Remove the specified document from the index.",
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.DeleteOperation"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_global.bulk.IndexOperation": {
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.WriteOperation"
},
{
"type": "object"
}
]
},
"_global.bulk.WriteOperation": {
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.OperationBase"
},
{
"type": "object",
"properties": {
"dynamic_templates": {
"description": "A map from the full name of fields to the name of dynamic templates.\nIt defaults to an empty map.\nIf a name matches a dynamic template, that template will be applied regardless of other match predicates defined in the template.\nIf a field is already defined in the mapping, then this parameter won't be used.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"pipeline": {
"description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.",
"type": "string"
},
"require_alias": {
"description": "If `true`, the request's actions must target an index alias.",
"default": false,
"type": "boolean"
}
}
}
]
},
"_global.bulk.OperationBase": {
"type": "object",
"properties": {
"_id": {
"description": "The document ID.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "The name of the index or index alias to perform the action on.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"routing": {
"description": "A custom value used to route operations to a specific shard, or multiple comma separated values.",
"type": "string"
},
"if_primary_term": {
"type": "number"
},
"if_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"version_type": {
"description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionType"
}
]
}
}
},
"_global.bulk.CreateOperation": {
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.WriteOperation"
},
{
"type": "object"
}
]
},
"_global.bulk.UpdateOperation": {
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.OperationBase"
},
{
"type": "object",
"properties": {
"require_alias": {
"description": "If `true`, the request's actions must target an index alias.",
"default": false,
"type": "boolean"
},
"retry_on_conflict": {
"description": "The number of times an update should be retried in the case of a version conflict.",
"type": "number"
}
}
}
]
},
"_global.bulk.DeleteOperation": {
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.OperationBase"
},
{
"type": "object"
}
]
},
"_global.bulk.UpdateAction": {
"type": "object",
"properties": {
"detect_noop": {
"description": "If true, the `result` in the response is set to 'noop' when no changes to the document occur.",
"default": true,
"type": "boolean"
},
"doc": {
"description": "A partial update to an existing document.",
"type": "object"
},
"doc_as_upsert": {
"description": "Set to `true` to use the contents of `doc` as the value of `upsert`.",
"default": false,
"type": "boolean"
},
"script": {
"description": "The script to run to update the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"scripted_upsert": {
"description": "Set to `true` to run the script whether or not the document exists.",
"default": false,
"type": "boolean"
},
"_source": {
"description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.",
"default": "true",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"upsert": {
"description": "If the document does not already exist, the contents of `upsert` are inserted as a new document.\nIf the document exists, the `script` is run.",
"type": "object"
}
}
},
"_global.bulk.ResponseItem": {
"type": "object",
"properties": {
"_id": {
"description": "The document ID associated with the operation.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"_index": {
"description": "The name of the index associated with the operation.\nIf the operation targeted a data stream, this is the backing index into which the document was written.",
"type": "string"
},
"status": {
"description": "The HTTP status code returned for the operation.",
"type": "number"
},
"failure_store": {
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.FailureStoreStatus"
}
]
},
"error": {
"description": "Additional information about the failed operation.\nThe property is returned only for failed operations.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"_primary_term": {
"description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.",
"type": "number"
},
"result": {
"description": "The result of the operation.\nPossible values are `created`, `updated`, `deleted`, `noop`, and `not_found`.",
"type": "string"
},
"_seq_no": {
"description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"_shards": {
"description": "Shard information for the operation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"_version": {
"description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.\nThis property is returned only for successful actions.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"forced_refresh": {
"type": "boolean"
},
"get": {
"allOf": [
{
"$ref": "#/components/schemas/_types.InlineGetDictUserDefined"
}
]
}
},
"required": [
"_index",
"status"
]
},
"_global.bulk.FailureStoreStatus": {
"type": "string",
"enum": [
"not_applicable_or_unknown",
"used",
"not_enabled",
"failed"
]
},
"_types.InlineGetDictUserDefined": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"found": {
"type": "boolean"
},
"_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"_primary_term": {
"type": "number"
},
"_routing": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Routing"
}
]
},
"_source": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"found"
]
},
"_types.TaskId": {
"type": "string"
},
"_types.ReindexStatus": {
"type": "object",
"properties": {
"slice_id": {
"description": "The slice ID",
"type": "number"
},
"batches": {
"description": "The number of scroll responses pulled back by the reindex.",
"type": "number"
},
"created": {
"description": "The number of documents that were successfully created.",
"type": "number"
},
"deleted": {
"description": "The number of documents that were successfully deleted.",
"type": "number"
},
"noops": {
"description": "The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.",
"type": "number"
},
"requests_per_second": {
"description": "The number of requests per second effectively executed during the reindex.",
"type": "number"
},
"retries": {
"description": "The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Retries"
}
]
},
"throttled": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_millis": {
"description": "Number of milliseconds the request slept to conform to `requests_per_second`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"throttled_until": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_until_millis": {
"description": "This field should always be equal to zero in a `_reindex` response.\nIt only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total": {
"description": "The number of documents that were successfully processed.",
"type": "number"
},
"updated": {
"description": "The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.",
"type": "number"
},
"version_conflicts": {
"description": "The number of version conflicts that reindex hits.",
"type": "number"
},
"cancelled": {
"description": "The reason for cancellation if the slice was canceled",
"type": "string"
}
},
"required": [
"batches",
"deleted",
"noops",
"requests_per_second",
"retries",
"throttled_millis",
"throttled_until_millis",
"total",
"version_conflicts"
]
},
"_types.Retries": {
"type": "object",
"properties": {
"bulk": {
"description": "The number of bulk actions retried.",
"type": "number"
},
"search": {
"description": "The number of search actions retried.",
"type": "number"
}
},
"required": [
"bulk",
"search"
]
},
"_types.ReindexTaskResult": {
"description": "The final result of a completed reindex operation, as stored in the task result.\nThis is the serialized form of `BulkByScrollResponse`.",
"type": "object",
"properties": {
"batches": {
"description": "The number of scroll responses pulled back by the reindex.",
"type": "number"
},
"created": {
"description": "The number of documents that were successfully created.",
"type": "number"
},
"deleted": {
"description": "The number of documents that were successfully deleted.",
"type": "number"
},
"failures": {
"description": "Any failures encountered during the reindex. If non-empty, the reindex ended because of these failures.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.BulkIndexByScrollFailure"
}
},
"noops": {
"description": "The number of documents that were ignored because the script returned a `noop` value for `ctx.op`.",
"type": "number"
},
"requests_per_second": {
"description": "The number of requests per second effectively executed during the reindex.",
"type": "number"
},
"retries": {
"description": "The number of retries attempted by reindex.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Retries"
}
]
},
"throttled_millis": {
"description": "Number of milliseconds the request slept to conform to `requests_per_second`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"throttled_until_millis": {
"description": "This field should always be equal to zero in a completed reindex result.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"timed_out": {
"description": "Whether any of the requests executed during the reindex timed out.",
"type": "boolean"
},
"took": {
"description": "The total milliseconds the entire operation took.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total": {
"description": "The number of documents that were successfully processed.",
"type": "number"
},
"updated": {
"description": "The number of documents that were successfully updated.",
"type": "number"
},
"version_conflicts": {
"description": "The number of version conflicts that occurred.",
"type": "number"
}
}
},
"_types.BulkIndexByScrollFailure": {
"type": "object",
"properties": {
"cause": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"status": {
"type": "number"
}
},
"required": [
"cause",
"id",
"index",
"status"
]
},
"_types.Names": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Name"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Name"
}
}
]
},
"cat._types.CatAliasesColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatAliasesColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatAliasesColumn"
}
}
]
},
"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.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"
}
}
},
"_types.NodeIds": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.NodeId"
}
}
]
},
"cat._types.CatAllocationColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatAllocationColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatAllocationColumn"
}
}
]
},
"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.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"
},
{
"nullable": true,
"type": "string"
}
]
},
"write_load.forecast": {
"description": "Sum of index write load forecasts",
"oneOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifieddouble"
},
{
"nullable": true,
"type": "string"
}
]
},
"disk.indices.forecast": {
"description": "Sum of shard size forecasts",
"oneOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
},
{
"nullable": true,
"type": "string"
}
]
},
"disk.indices": {
"description": "Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards.\nIMPORTANT: 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"
},
{
"nullable": true,
"type": "string"
}
]
},
"disk.used": {
"description": "Total disk space in use.\nElasticsearch retrieves this metric from the node’s operating system (OS).\nThe 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.\nUnlike `disk.indices`, this metric does not double-count disk space for hard-linked files.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
},
{
"nullable": true,
"type": "string"
}
]
},
"disk.avail": {
"description": "Free disk space available to Elasticsearch.\nElasticsearch retrieves this metric from the node’s operating system.\nDisk-based shard allocation uses this metric to assign shards to nodes based on available disk space.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
},
{
"nullable": true,
"type": "string"
}
]
},
"disk.total": {
"description": "Total disk space for the node, including in-use and available space.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
},
{
"nullable": true,
"type": "string"
}
]
},
"disk.percent": {
"description": "Total percentage of disk space in use. Calculated as `disk.used / disk.total`.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.Percentage"
},
{
"nullable": true,
"type": "string"
}
]
},
"host": {
"description": "Network host for the node. Set using the `network.host` setting.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.Host"
},
{
"nullable": true,
"type": "string"
}
]
},
"ip": {
"description": "IP address and port for the node.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.Ip"
},
{
"nullable": true,
"type": "string"
}
]
},
"node": {
"description": "Name for the node. Set using the `node.name` setting.",
"type": "string"
},
"node.role": {
"description": "Node roles",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"_spec_utils.Stringifieddouble": {
"description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"_types.ByteSize": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"_types.Percentage": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"_types.Host": {
"type": "string"
},
"_types.Ip": {
"type": "string"
},
"cat._types.CatCircuitBreakerColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatCircuitBreakerColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatCircuitBreakerColumn"
}
}
]
},
"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"
}
]
},
"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"
}
}
},
"cat._types.CatComponentColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatComponentColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatComponentColumn"
}
}
]
},
"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.component_templates.ComponentTemplate": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"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"
]
},
"cat._types.CatCountColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatCountColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatCountColumn"
}
}
]
},
"cat._types.CatCountColumn": {
"anyOf": [
{
"type": "string",
"enum": [
"epoch",
"t",
"time",
"timestamp",
"ts",
"hms",
"hhmmss",
"count",
"dc",
"docs.count",
"docsCount"
]
},
{
"type": "string"
}
]
},
"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"
}
}
},
"_spec_utils.StringifiedEpochTimeUnitSeconds": {
"description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitSeconds"
},
{
"type": "string"
}
]
},
"_types.EpochTimeUnitSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitSeconds"
}
]
},
"_types.UnitSeconds": {
"description": "Time unit for seconds",
"type": "number"
},
"_types.TimeOfDay": {
"description": "Time of day, expressed as HH:MM:SS",
"type": "string"
},
"cat._types.CatFieldDataColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatFieldDataColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatFieldDataColumn"
}
}
]
},
"cat._types.CatFieldDataColumn": {
"anyOf": [
{
"type": "string",
"enum": [
"id",
"host",
"h",
"ip",
"node",
"n",
"field",
"f",
"size",
"s"
]
},
{
"type": "string"
}
]
},
"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"
}
}
},
"cat._types.CatHealthColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatHealthColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatHealthColumn"
}
}
]
},
"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"
}
]
},
"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"
}
}
},
"_types.HealthStatus": {
"type": "string",
"enum": [
"green",
"GREEN",
"yellow",
"YELLOW",
"red",
"RED",
"unknown",
"unavailable"
]
},
"cat._types.CatIndicesColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatIndicesColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatIndicesColumn"
}
}
]
},
"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.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.\nFor indices with `semantic_text` fields or other nested field types,\nthis count includes the internal nested documents.\nTo get the logical document count (excluding nested documents), use\nthe `_count` API or `_cat/count` API instead.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"docs.deleted": {
"description": "deleted docs",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"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"
},
{
"nullable": true,
"type": "string"
}
]
},
"pri.store.size": {
"description": "store size of primaries",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"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"
},
{
"nullable": true,
"type": "string"
}
]
},
"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._types.CatMasterColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatMasterColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatMasterColumn"
}
}
]
},
"cat._types.CatMasterColumn": {
"anyOf": [
{
"type": "string",
"enum": [
"id",
"host",
"h",
"ip",
"node",
"n"
]
},
{
"type": "string"
}
]
},
"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.CatDfaColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatDfaColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatDfaColumn"
}
}
]
},
"cat._types.CatDfaColumn": {
"type": "string"
},
"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"
}
}
},
"_types.VersionString": {
"type": "string"
},
"cat._types.CatDatafeedColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatDatafeedColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatDatafeedColumn"
}
}
]
},
"cat._types.CatDatafeedColumn": {
"type": "string"
},
"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.\nFor 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.\nFor 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.\nFor 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.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.",
"type": "string"
}
}
},
"ml._types.DatafeedState": {
"type": "string",
"enum": [
"started",
"stopped",
"starting",
"stopping"
]
},
"cat._types.CatAnomalyDetectorColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatAnomalyDetectorColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatAnomalyDetectorColumn"
}
}
]
},
"cat._types.CatAnomalyDetectorColumn": {
"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.\nThis value includes documents with missing fields, since they are nonetheless analyzed.\nIf 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.\nOnly fields that are specified in the detector configuration object contribute to this count.\nThe 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.\nThis count includes fields that are not used in the analysis.\nHowever, 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.\nInput documents with missing fields are still processed because it is possible that not all fields are missing.\nIf 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.\nIt 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.\nThis information is applicable only when you provide data to the anomaly detection job by using the post data API.\nThese 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.\nIf 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.\nIf 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.\nThis is the maximum value since the last time the model was persisted.\nIf 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.\nThis 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.\nThis 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.\nThis 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.\nThis 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.\nDead 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`.\nThis count does not track which specific categories failed to be created.\nTherefore 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.\nA 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"
}
}
},
"ml._types.JobState": {
"type": "string",
"enum": [
"closing",
"closed",
"opened",
"failed",
"opening"
]
},
"ml._types.MemoryStatus": {
"type": "string",
"enum": [
"ok",
"soft_limit",
"hard_limit"
]
},
"ml._types.CategorizationStatus": {
"type": "string",
"enum": [
"ok",
"warn"
]
},
"cat._types.CatTrainedModelsColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatTrainedModelsColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatTrainedModelsColumn"
}
}
]
},
"cat._types.CatTrainedModelsColumn": {
"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.\nThis 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.\nOnly 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.CatNodeattrsColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatNodeattrsColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatNodeattrsColumn"
}
}
]
},
"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.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._types.CatNodeColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatNodeColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatNodeColumn"
}
}
]
},
"cat._types.CatNodeColumn": {
"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.\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).",
"type": "string"
},
"master": {
"description": "Indicates whether the node is the elected master node.\nReturned 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.CatPendingTasksColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatPendingTasksColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatPendingTasksColumn"
}
}
]
},
"cat._types.CatPendingTasksColumn": {
"anyOf": [
{
"type": "string",
"enum": [
"insertOrder",
"o",
"timeInQueue",
"t",
"priority",
"p",
"source",
"s"
]
},
{
"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.CatPluginsColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatPluginsColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatPluginsColumn"
}
}
]
},
"cat._types.CatPluginsColumn": {
"anyOf": [
{
"type": "string",
"enum": [
"id",
"name",
"n",
"component",
"c",
"version",
"v",
"description",
"d"
]
},
{
"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.CatRecoveryColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatRecoveryColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatRecoveryColumn"
}
}
]
},
"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"
}
]
},
"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.repositories.RepositoriesRecord": {
"type": "object",
"properties": {
"id": {
"description": "The unique repository identifier.",
"type": "string"
},
"type": {
"description": "The repository type.",
"type": "string"
}
}
},
"cat._types.CatSegmentsColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatSegmentsColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatSegmentsColumn"
}
}
]
},
"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.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.\nElasticsearch 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.\nThis excludes deleted documents and counts any nested documents separately from their parents.\nIt 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.\nThis number excludes deletes that were performed recently and do not yet belong to a segment.\nDeleted documents are cleaned up by the automatic merge process if it makes sense to do so.\nAlso, 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.\nA 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.\nSegments that are synced can survive a hard reboot.\nIf `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.\nIf `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.\nThis means Lucene merged all files from the segment in a single file to save file descriptors.",
"type": "string"
}
}
},
"cat._types.CatShardColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatShardColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatShardColumn"
}
}
]
},
"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.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.\nReturned values include:\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.",
"type": "string"
},
"docs": {
"description": "The number of documents in the shard.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"store": {
"description": "The disk space used by the shard.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"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"
},
{
"nullable": true,
"type": "string"
}
]
},
"ip": {
"description": "The IP address of the node.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"id": {
"description": "The unique identifier for the node.",
"type": "string"
},
"node": {
"description": "The name of node.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"sync_id": {
"description": "The sync identifier.",
"type": "string"
},
"unassigned.reason": {
"description": "The reason for the last change to the state of an unassigned shard.\nIt does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information.\nReturned values include:\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.",
"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.\nIt 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.CatSnapshotsColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatSnapshotsColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatSnapshotsColumn"
}
}
]
},
"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"
}
]
},
"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.\nReturned values include:\n`FAILED`: The snapshot process failed.\n`INCOMPATIBLE`: The snapshot process is incompatible with the current cluster version.\n`IN_PROGRESS`: The snapshot process started but has not completed.\n`PARTIAL`: The snapshot process completed with a partial success.\n`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"
}
}
},
"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"
}
]
},
"watcher._types.HourAndMinute": {
"type": "object",
"properties": {
"hour": {
"type": "array",
"items": {
"type": "number"
}
},
"minute": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"hour",
"minute"
]
},
"cat._types.CatTasksColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatTasksColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatTasksColumn"
}
}
]
},
"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.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"
}
}
},
"cat._types.CatTemplatesColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatTemplatesColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatTemplatesColumn"
}
}
]
},
"cat._types.CatTemplatesColumn": {
"anyOf": [
{
"type": "string",
"enum": [
"name",
"n",
"index_patterns",
"t",
"order",
"o",
"p",
"version",
"v",
"composed_of",
"c"
]
},
{
"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"
},
{
"nullable": true,
"type": "string"
}
]
},
"composed_of": {
"description": "The component templates that comprise the index template.",
"type": "string"
}
}
},
"cat._types.CatThreadPoolColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatThreadPoolColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatThreadPoolColumn"
}
}
]
},
"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"
}
]
},
"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.\nReturned 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"
},
{
"nullable": true,
"type": "string"
}
]
},
"max": {
"description": "The maximum number of active threads allowed in a scaling thread pool.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"size": {
"description": "The number of active threads allowed in a fixed thread pool.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"keep_alive": {
"description": "The thread keep alive time.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"cat._types.CatTransformColumns": {
"oneOf": [
{
"$ref": "#/components/schemas/cat._types.CatTransformColumn"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cat._types.CatTransformColumn"
}
}
]
},
"cat._types.CatTransformColumn": {
"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.\nReturned values include:\n`aborting`: The transform is aborting.\n`failed: The transform failed. For more information about the failure, check the `reason` field.\n`indexing`: The transform is actively processing data and creating new documents.\n`started`: The transform is running but not actively indexing data.\n`stopped`: The transform is stopped.\n`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"
},
{
"nullable": true,
"type": "string"
}
]
},
"last_search_time": {
"description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"changes_last_detection_time": {
"description": "The timestamp when changes were last detected in the source indices.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"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.\nFor 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.\nDocuments 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"
}
}
},
"indices._types.IndexSettings": {
"type": "object",
"x-model": true,
"externalDocs": {
"description": "Index settings",
"url": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/"
}
},
"indices._types.SoftDeletes": {
"type": "object",
"properties": {
"enabled": {
"description": "Indicates whether soft deletes are enabled on the index.",
"default": true,
"type": "boolean"
},
"retention_lease": {
"description": "The maximum period to retain a shard history retention lease before it is considered expired.\nShard history retention leases ensure that soft deletes are retained during merges on the Lucene\nindex. If a soft delete is merged away before it can be replicated to a follower the following\nprocess will fail due to incomplete history on the leader.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.RetentionLease"
}
]
}
}
},
"indices._types.RetentionLease": {
"type": "object",
"properties": {
"period": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"period"
]
},
"indices._types.IndexSegmentSort": {
"type": "object",
"properties": {
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"order": {
"description": "\n\nSupported values include: `asc` (or `ASC`), `desc` (or `DESC`)\n\n",
"oneOf": [
{
"$ref": "#/components/schemas/indices._types.SegmentSortOrder"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/indices._types.SegmentSortOrder"
}
}
]
},
"mode": {
"description": "\n\nSupported values include: `min` (or `MIN`), `max` (or `MAX`)\n\n",
"oneOf": [
{
"$ref": "#/components/schemas/indices._types.SegmentSortMode"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/indices._types.SegmentSortMode"
}
}
]
},
"missing": {
"description": "\n\nSupported values include: `_last`, `_first`\n\n",
"oneOf": [
{
"$ref": "#/components/schemas/indices._types.SegmentSortMissing"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/indices._types.SegmentSortMissing"
}
}
]
}
}
},
"indices._types.SegmentSortOrder": {
"type": "string",
"enum": [
"asc",
"ASC",
"desc",
"DESC"
]
},
"indices._types.SegmentSortMode": {
"type": "string",
"enum": [
"min",
"MIN",
"max",
"MAX"
]
},
"indices._types.SegmentSortMissing": {
"type": "string",
"enum": [
"_last",
"_first"
]
},
"indices._types.IndexCheckOnStartup": {
"type": "string",
"enum": [
"true",
"false",
"checksum"
]
},
"_spec_utils.Stringifiedinteger": {
"description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"_spec_utils.NullValue": {
"nullable": true,
"description": "A `null` value that is to be interpreted as an actual value, unless other uses of `null` that are equivalent\nto a missing value. It is used for exemple in settings, where using the `NullValue` for a setting will reset\nit to its default value.",
"type": "string"
},
"indices._types.Merge": {
"type": "object",
"properties": {
"scheduler": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.MergeScheduler"
}
]
}
}
},
"indices._types.MergeScheduler": {
"type": "object",
"properties": {
"max_thread_count": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
}
]
},
"max_merge_count": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
}
]
}
}
},
"indices._types.SettingsSearch": {
"type": "object",
"properties": {
"idle": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SearchIdle"
}
]
},
"slowlog": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SlowlogSettings"
}
]
}
}
},
"indices._types.SearchIdle": {
"type": "object",
"properties": {
"after": {
"default": "30s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"indices._types.SlowlogSettings": {
"type": "object",
"properties": {
"level": {
"type": "string"
},
"source": {
"type": "number"
},
"reformat": {
"type": "boolean"
},
"threshold": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SlowlogTresholds"
}
]
}
}
},
"indices._types.SlowlogTresholds": {
"type": "object",
"properties": {
"query": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels"
}
]
},
"fetch": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels"
}
]
}
}
},
"indices._types.SlowlogTresholdLevels": {
"type": "object",
"properties": {
"warn": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"debug": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"trace": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"indices._types.IndexSettingBlocks": {
"type": "object",
"properties": {
"read_only": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
},
"read_only_allow_delete": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
},
"read": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
},
"write": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
}
}
},
"_spec_utils.Stringifiedboolean": {
"description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"indices._types.SettingsAnalyze": {
"type": "object",
"properties": {
"max_token_count": {
"default": "10000",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
}
]
}
}
},
"indices._types.SettingsHighlight": {
"type": "object",
"properties": {
"max_analyzed_offset": {
"default": 1000000,
"type": "number"
}
}
},
"indices._types.IndexRouting": {
"type": "object",
"properties": {
"allocation": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexRoutingAllocation"
}
]
},
"rebalance": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexRoutingRebalance"
}
]
}
}
},
"indices._types.IndexRoutingAllocation": {
"type": "object",
"properties": {
"enable": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexRoutingAllocationOptions"
}
]
},
"include": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInclude"
}
]
},
"initial_recovery": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInitialRecovery"
}
]
},
"disk": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexRoutingAllocationDisk"
}
]
}
}
},
"indices._types.IndexRoutingAllocationOptions": {
"type": "string",
"enum": [
"all",
"primaries",
"new_primaries",
"none"
]
},
"indices._types.IndexRoutingAllocationInclude": {
"type": "object",
"properties": {
"_tier_preference": {
"type": "string"
},
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
}
},
"indices._types.IndexRoutingAllocationInitialRecovery": {
"type": "object",
"properties": {
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
}
},
"indices._types.IndexRoutingAllocationDisk": {
"type": "object",
"properties": {
"threshold_enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
}
},
"indices._types.IndexRoutingRebalance": {
"type": "object",
"properties": {
"enable": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexRoutingRebalanceOptions"
}
]
}
},
"required": [
"enable"
]
},
"indices._types.IndexRoutingRebalanceOptions": {
"type": "string",
"enum": [
"all",
"primaries",
"replicas",
"none"
]
},
"_types.PipelineName": {
"type": "string"
},
"indices._types.IndexSettingsLifecycle": {
"type": "object",
"properties": {
"name": {
"description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"indexing_complete": {
"description": "Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.\nYou can explicitly set it to skip rollover.",
"default": "false",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
},
"origination_date": {
"description": "If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting\nif you create a new index that contains old data and want to use the original creation date to calculate the index\nage. Specified as a Unix epoch value in milliseconds.",
"default": 0,
"type": "number"
},
"parse_origination_date": {
"description": "Set to true to parse the origination date from the index name. This origination date is used to calculate the index age\nfor its phase transitions. The index name must match the pattern ^.*-{date_format}-\\\\d+, where the date_format is\nyyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,\nfor example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.",
"type": "boolean"
},
"step": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettingsLifecycleStep"
}
]
},
"rollover_alias": {
"description": "The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.\nWhen the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more\ninformation about rolling indices, see Rollover.",
"default": "",
"type": "string"
},
"prefer_ilm": {
"description": "Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are\napplicable for an index).",
"default": "true",
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
}
},
"indices._types.IndexSettingsLifecycleStep": {
"type": "object",
"properties": {
"wait_time_threshold": {
"description": "Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).\nSee Shard allocation for shrink.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"_spec_utils.StringifiedEpochTimeUnitMillis": {
"description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
},
{
"type": "string"
}
]
},
"_types.Uuid": {
"type": "string"
},
"indices._types.IndexVersioning": {
"type": "object",
"properties": {
"created": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"created_string": {
"type": "string"
}
}
},
"indices._types.Translog": {
"type": "object",
"properties": {
"sync_interval": {
"description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.",
"default": "5s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"durability": {
"description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.\n\nSupported values include:\n - `request` (or `REQUEST`): (default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes\nwill already have been committed to disk.\n - `async` (or `ASYNC`): fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes\nsince the last automatic commit will be discarded.\n\n",
"default": "string",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.TranslogDurability"
}
]
},
"flush_threshold_size": {
"description": "The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not\npart of a Lucene commit point). Although these operations are available for reads, they will need\nto be replayed if the shard was stopped and had to be recovered. This setting controls the\nmaximum total size of these operations, to prevent recoveries from taking too long. Once the\nmaximum size has been reached a flush will happen, generating a new Lucene commit point.",
"default": "512mb",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"retention": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.TranslogRetention"
}
]
}
}
},
"indices._types.TranslogDurability": {
"type": "string",
"enum": [
"request",
"REQUEST",
"async",
"ASYNC"
]
},
"indices._types.TranslogRetention": {
"type": "object",
"properties": {
"size": {
"description": "This controls the total size of translog files to keep for each shard. Keeping more translog files increases\nthe chance of performing an operation based sync when recovering a replica. If the translog files are not\nsufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be\nset, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch\nversions 7.0.0 and later.",
"default": "512mb",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"age": {
"description": "This controls the maximum duration for which translog files are kept by each shard. Keeping more\ntranslog files increases the chance of performing an operation based sync when recovering replicas. If\nthe translog files are not sufficient, replica recovery will fall back to a file based sync. This setting\nis ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in\nindices created in Elasticsearch versions 7.0.0 and later.",
"default": "12h",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"indices._types.SettingsQueryString": {
"type": "object",
"properties": {
"lenient": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
}
},
"required": [
"lenient"
]
},
"indices._types.IndexSettingsAnalysis": {
"type": "object",
"properties": {
"analyzer": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.analysis.Analyzer"
}
},
"char_filter": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.analysis.CharFilter"
}
},
"filter": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.analysis.TokenFilter"
}
},
"normalizer": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.analysis.Normalizer"
}
},
"tokenizer": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.analysis.Tokenizer"
}
}
}
},
"_types.analysis.Analyzer": {
"discriminator": {
"propertyName": "type",
"mapping": {
"arabic": "#/components/schemas/_types.analysis.ArabicAnalyzer",
"armenian": "#/components/schemas/_types.analysis.ArmenianAnalyzer",
"basque": "#/components/schemas/_types.analysis.BasqueAnalyzer",
"bengali": "#/components/schemas/_types.analysis.BengaliAnalyzer",
"brazilian": "#/components/schemas/_types.analysis.BrazilianAnalyzer",
"bulgarian": "#/components/schemas/_types.analysis.BulgarianAnalyzer",
"catalan": "#/components/schemas/_types.analysis.CatalanAnalyzer",
"chinese": "#/components/schemas/_types.analysis.ChineseAnalyzer",
"cjk": "#/components/schemas/_types.analysis.CjkAnalyzer",
"custom": "#/components/schemas/_types.analysis.CustomAnalyzer",
"czech": "#/components/schemas/_types.analysis.CzechAnalyzer",
"danish": "#/components/schemas/_types.analysis.DanishAnalyzer",
"dutch": "#/components/schemas/_types.analysis.DutchAnalyzer",
"english": "#/components/schemas/_types.analysis.EnglishAnalyzer",
"estonian": "#/components/schemas/_types.analysis.EstonianAnalyzer",
"fingerprint": "#/components/schemas/_types.analysis.FingerprintAnalyzer",
"finnish": "#/components/schemas/_types.analysis.FinnishAnalyzer",
"french": "#/components/schemas/_types.analysis.FrenchAnalyzer",
"galician": "#/components/schemas/_types.analysis.GalicianAnalyzer",
"german": "#/components/schemas/_types.analysis.GermanAnalyzer",
"greek": "#/components/schemas/_types.analysis.GreekAnalyzer",
"hindi": "#/components/schemas/_types.analysis.HindiAnalyzer",
"hungarian": "#/components/schemas/_types.analysis.HungarianAnalyzer",
"icu_analyzer": "#/components/schemas/_types.analysis.IcuAnalyzer",
"indonesian": "#/components/schemas/_types.analysis.IndonesianAnalyzer",
"irish": "#/components/schemas/_types.analysis.IrishAnalyzer",
"italian": "#/components/schemas/_types.analysis.ItalianAnalyzer",
"keyword": "#/components/schemas/_types.analysis.KeywordAnalyzer",
"kuromoji": "#/components/schemas/_types.analysis.KuromojiAnalyzer",
"latvian": "#/components/schemas/_types.analysis.LatvianAnalyzer",
"lithuanian": "#/components/schemas/_types.analysis.LithuanianAnalyzer",
"nori": "#/components/schemas/_types.analysis.NoriAnalyzer",
"norwegian": "#/components/schemas/_types.analysis.NorwegianAnalyzer",
"pattern": "#/components/schemas/_types.analysis.PatternAnalyzer",
"persian": "#/components/schemas/_types.analysis.PersianAnalyzer",
"portuguese": "#/components/schemas/_types.analysis.PortugueseAnalyzer",
"romanian": "#/components/schemas/_types.analysis.RomanianAnalyzer",
"russian": "#/components/schemas/_types.analysis.RussianAnalyzer",
"serbian": "#/components/schemas/_types.analysis.SerbianAnalyzer",
"simple": "#/components/schemas/_types.analysis.SimpleAnalyzer",
"snowball": "#/components/schemas/_types.analysis.SnowballAnalyzer",
"sorani": "#/components/schemas/_types.analysis.SoraniAnalyzer",
"spanish": "#/components/schemas/_types.analysis.SpanishAnalyzer",
"standard": "#/components/schemas/_types.analysis.StandardAnalyzer",
"stop": "#/components/schemas/_types.analysis.StopAnalyzer",
"swedish": "#/components/schemas/_types.analysis.SwedishAnalyzer",
"thai": "#/components/schemas/_types.analysis.ThaiAnalyzer",
"turkish": "#/components/schemas/_types.analysis.TurkishAnalyzer",
"whitespace": "#/components/schemas/_types.analysis.WhitespaceAnalyzer"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.analysis.CustomAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.FingerprintAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.KeywordAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.NoriAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.PatternAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.SimpleAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.StandardAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.StopAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.WhitespaceAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.IcuAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.KuromojiAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.SnowballAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.ArabicAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.ArmenianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.BasqueAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.BengaliAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.BrazilianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.BulgarianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.CatalanAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.ChineseAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.CjkAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.CzechAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.DanishAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.DutchAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.EnglishAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.EstonianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.FinnishAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.FrenchAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.GalicianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.GermanAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.GreekAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.HindiAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.HungarianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.IndonesianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.IrishAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.ItalianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.LatvianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.LithuanianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.NorwegianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.PersianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.PortugueseAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.RomanianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.RussianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.SerbianAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.SoraniAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.SpanishAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.SwedishAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.TurkishAnalyzer"
},
{
"$ref": "#/components/schemas/_types.analysis.ThaiAnalyzer"
}
]
},
"_types.analysis.CustomAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom"
]
},
"char_filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"position_increment_gap": {
"type": "number"
},
"position_offset_gap": {
"type": "number"
},
"tokenizer": {
"type": "string"
}
},
"required": [
"type",
"tokenizer"
]
},
"_types.analysis.FingerprintAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"fingerprint"
]
},
"version": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"max_output_size": {
"description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`",
"default": 255,
"type": "number"
},
"separator": {
"description": "The character to use to concatenate the terms.\nDefaults to a space.",
"type": "string"
},
"stopwords": {
"description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.",
"default": "_none_",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"description": "The path to a file containing stop words.",
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.KeywordAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"keyword"
]
},
"version": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
},
"required": [
"type"
]
},
"_types.analysis.NoriAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"nori"
]
},
"version": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"decompound_mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode"
}
]
},
"stoptags": {
"type": "array",
"items": {
"type": "string"
}
},
"user_dictionary": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.NoriDecompoundMode": {
"type": "string",
"enum": [
"discard",
"none",
"mixed"
]
},
"_types.analysis.PatternAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pattern"
]
},
"version": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"flags": {
"description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".",
"type": "string"
},
"lowercase": {
"description": "Should terms be lowercased or not.\nDefaults to `true`.",
"default": true,
"type": "boolean"
},
"pattern": {
"description": "A Java regular expression.\nDefaults to `\\W+`.",
"default": "\\W+",
"type": "string"
},
"stopwords": {
"description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.",
"default": "_none_",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"description": "The path to a file containing stop words.",
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.SimpleAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"simple"
]
},
"version": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
},
"required": [
"type"
]
},
"_types.analysis.StandardAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"standard"
]
},
"max_token_length": {
"description": "The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals.\nDefaults to `255`.",
"default": 255,
"type": "number"
},
"stopwords": {
"description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.",
"default": "_none_",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"description": "The path to a file containing stop words.",
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.StopAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"stop"
]
},
"version": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"stopwords": {
"description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.",
"default": "_none_",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"description": "The path to a file containing stop words.",
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.WhitespaceAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"whitespace"
]
},
"version": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
},
"required": [
"type"
]
},
"_types.analysis.IcuAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"icu_analyzer"
]
},
"method": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuNormalizationType"
}
]
},
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode"
}
]
}
},
"required": [
"type",
"method",
"mode"
]
},
"_types.analysis.IcuNormalizationType": {
"type": "string",
"enum": [
"nfc",
"nfkc",
"nfkc_cf"
]
},
"_types.analysis.IcuNormalizationMode": {
"type": "string",
"enum": [
"decompose",
"compose"
]
},
"_types.analysis.KuromojiAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kuromoji"
]
},
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode"
}
]
},
"user_dictionary": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.KuromojiTokenizationMode": {
"type": "string",
"enum": [
"normal",
"search",
"extended"
]
},
"_types.analysis.SnowballAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"snowball"
]
},
"version": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"language": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.SnowballLanguage"
}
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
}
},
"required": [
"type",
"language"
]
},
"_types.analysis.SnowballLanguage": {
"type": "string",
"enum": [
"Arabic",
"Armenian",
"Basque",
"Catalan",
"Danish",
"Dutch",
"English",
"Estonian",
"Finnish",
"French",
"German",
"German2",
"Hungarian",
"Italian",
"Irish",
"Kp",
"Lithuanian",
"Lovins",
"Norwegian",
"Porter",
"Portuguese",
"Romanian",
"Russian",
"Serbian",
"Spanish",
"Swedish",
"Turkish"
]
},
"_types.analysis.ArabicAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"arabic"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.ArmenianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"armenian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.BasqueAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"basque"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.BengaliAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bengali"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.BrazilianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"brazilian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.BulgarianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bulgarian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.CatalanAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalan"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.ChineseAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"chinese"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.CjkAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cjk"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.CzechAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"czech"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.DanishAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"danish"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.DutchAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dutch"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.EnglishAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"english"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.EstonianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"estonian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.FinnishAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"finnish"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.FrenchAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"french"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.GalicianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"galician"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.GermanAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"german"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.GreekAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"greek"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.HindiAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"hindi"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.HungarianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"hungarian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.IndonesianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"indonesian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.IrishAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"irish"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.ItalianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"italian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.LatvianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"latvian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.LithuanianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"lithuanian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.NorwegianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"norwegian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.PersianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"persian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.PortugueseAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"portuguese"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.RomanianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"romanian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.RussianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"russian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.SerbianAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"serbian"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.SoraniAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"sorani"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.SpanishAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"spanish"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.SwedishAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"swedish"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.TurkishAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"turkish"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
},
"stem_exclusion": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.ThaiAnalyzer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"thai"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"type": "string"
}
},
"required": [
"type"
]
},
"_types.analysis.CharFilter": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/text-analysis/character-filter-reference"
},
"x-model": true
},
"_types.analysis.CharFilterDefinition": {
"discriminator": {
"propertyName": "type",
"mapping": {
"html_strip": "#/components/schemas/_types.analysis.HtmlStripCharFilter",
"icu_normalizer": "#/components/schemas/_types.analysis.IcuNormalizationCharFilter",
"kuromoji_iteration_mark": "#/components/schemas/_types.analysis.KuromojiIterationMarkCharFilter",
"mapping": "#/components/schemas/_types.analysis.MappingCharFilter",
"pattern_replace": "#/components/schemas/_types.analysis.PatternReplaceCharFilter"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.analysis.HtmlStripCharFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.MappingCharFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.PatternReplaceCharFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.IcuNormalizationCharFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KuromojiIterationMarkCharFilter"
}
]
},
"_types.analysis.HtmlStripCharFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.CharFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"html_strip"
]
},
"escaped_tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.CharFilterBase": {
"type": "object",
"properties": {
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
}
},
"_types.analysis.MappingCharFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.CharFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"mapping"
]
},
"mappings": {
"type": "array",
"items": {
"type": "string"
}
},
"mappings_path": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.PatternReplaceCharFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.CharFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pattern_replace"
]
},
"flags": {
"type": "string"
},
"pattern": {
"type": "string"
},
"replacement": {
"type": "string"
}
},
"required": [
"type",
"pattern"
]
}
]
},
"_types.analysis.IcuNormalizationCharFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.CharFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"icu_normalizer"
]
},
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuNormalizationType"
}
]
},
"unicode_set_filter": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.KuromojiIterationMarkCharFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.CharFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kuromoji_iteration_mark"
]
},
"normalize_kana": {
"type": "boolean"
},
"normalize_kanji": {
"type": "boolean"
}
},
"required": [
"type",
"normalize_kana",
"normalize_kanji"
]
}
]
},
"_types.analysis.TokenFilter": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/text-analysis/token-filter-reference"
},
"x-model": true
},
"_types.analysis.TokenFilterDefinition": {
"discriminator": {
"propertyName": "type",
"mapping": {
"apostrophe": "#/components/schemas/_types.analysis.ApostropheTokenFilter",
"arabic_normalization": "#/components/schemas/_types.analysis.ArabicNormalizationTokenFilter",
"arabic_stem": "#/components/schemas/_types.analysis.ArabicStemTokenFilter",
"asciifolding": "#/components/schemas/_types.analysis.AsciiFoldingTokenFilter",
"bengali_normalization": "#/components/schemas/_types.analysis.BengaliNormalizationTokenFilter",
"brazilian_stem": "#/components/schemas/_types.analysis.BrazilianStemTokenFilter",
"cjk_bigram": "#/components/schemas/_types.analysis.CjkBigramTokenFilter",
"cjk_width": "#/components/schemas/_types.analysis.CjkWidthTokenFilter",
"classic": "#/components/schemas/_types.analysis.ClassicTokenFilter",
"common_grams": "#/components/schemas/_types.analysis.CommonGramsTokenFilter",
"condition": "#/components/schemas/_types.analysis.ConditionTokenFilter",
"czech_stem": "#/components/schemas/_types.analysis.CzechStemTokenFilter",
"decimal_digit": "#/components/schemas/_types.analysis.DecimalDigitTokenFilter",
"delimited_payload": "#/components/schemas/_types.analysis.DelimitedPayloadTokenFilter",
"dictionary_decompounder": "#/components/schemas/_types.analysis.DictionaryDecompounderTokenFilter",
"dutch_stem": "#/components/schemas/_types.analysis.DutchStemTokenFilter",
"edge_ngram": "#/components/schemas/_types.analysis.EdgeNGramTokenFilter",
"elision": "#/components/schemas/_types.analysis.ElisionTokenFilter",
"fingerprint": "#/components/schemas/_types.analysis.FingerprintTokenFilter",
"flatten_graph": "#/components/schemas/_types.analysis.FlattenGraphTokenFilter",
"french_stem": "#/components/schemas/_types.analysis.FrenchStemTokenFilter",
"german_normalization": "#/components/schemas/_types.analysis.GermanNormalizationTokenFilter",
"german_stem": "#/components/schemas/_types.analysis.GermanStemTokenFilter",
"hindi_normalization": "#/components/schemas/_types.analysis.HindiNormalizationTokenFilter",
"hunspell": "#/components/schemas/_types.analysis.HunspellTokenFilter",
"hyphenation_decompounder": "#/components/schemas/_types.analysis.HyphenationDecompounderTokenFilter",
"icu_collation": "#/components/schemas/_types.analysis.IcuCollationTokenFilter",
"icu_folding": "#/components/schemas/_types.analysis.IcuFoldingTokenFilter",
"icu_normalizer": "#/components/schemas/_types.analysis.IcuNormalizationTokenFilter",
"icu_transform": "#/components/schemas/_types.analysis.IcuTransformTokenFilter",
"indic_normalization": "#/components/schemas/_types.analysis.IndicNormalizationTokenFilter",
"ja_stop": "#/components/schemas/_types.analysis.JaStopTokenFilter",
"keep": "#/components/schemas/_types.analysis.KeepWordsTokenFilter",
"keep_types": "#/components/schemas/_types.analysis.KeepTypesTokenFilter",
"keyword_marker": "#/components/schemas/_types.analysis.KeywordMarkerTokenFilter",
"keyword_repeat": "#/components/schemas/_types.analysis.KeywordRepeatTokenFilter",
"kstem": "#/components/schemas/_types.analysis.KStemTokenFilter",
"kuromoji_part_of_speech": "#/components/schemas/_types.analysis.KuromojiPartOfSpeechTokenFilter",
"kuromoji_readingform": "#/components/schemas/_types.analysis.KuromojiReadingFormTokenFilter",
"kuromoji_stemmer": "#/components/schemas/_types.analysis.KuromojiStemmerTokenFilter",
"length": "#/components/schemas/_types.analysis.LengthTokenFilter",
"limit": "#/components/schemas/_types.analysis.LimitTokenCountTokenFilter",
"lowercase": "#/components/schemas/_types.analysis.LowercaseTokenFilter",
"min_hash": "#/components/schemas/_types.analysis.MinHashTokenFilter",
"multiplexer": "#/components/schemas/_types.analysis.MultiplexerTokenFilter",
"ngram": "#/components/schemas/_types.analysis.NGramTokenFilter",
"nori_part_of_speech": "#/components/schemas/_types.analysis.NoriPartOfSpeechTokenFilter",
"pattern_capture": "#/components/schemas/_types.analysis.PatternCaptureTokenFilter",
"pattern_replace": "#/components/schemas/_types.analysis.PatternReplaceTokenFilter",
"persian_normalization": "#/components/schemas/_types.analysis.PersianNormalizationTokenFilter",
"persian_stem": "#/components/schemas/_types.analysis.PersianStemTokenFilter",
"phonetic": "#/components/schemas/_types.analysis.PhoneticTokenFilter",
"porter_stem": "#/components/schemas/_types.analysis.PorterStemTokenFilter",
"predicate_token_filter": "#/components/schemas/_types.analysis.PredicateTokenFilter",
"remove_duplicates": "#/components/schemas/_types.analysis.RemoveDuplicatesTokenFilter",
"reverse": "#/components/schemas/_types.analysis.ReverseTokenFilter",
"russian_stem": "#/components/schemas/_types.analysis.RussianStemTokenFilter",
"scandinavian_folding": "#/components/schemas/_types.analysis.ScandinavianFoldingTokenFilter",
"scandinavian_normalization": "#/components/schemas/_types.analysis.ScandinavianNormalizationTokenFilter",
"serbian_normalization": "#/components/schemas/_types.analysis.SerbianNormalizationTokenFilter",
"shingle": "#/components/schemas/_types.analysis.ShingleTokenFilter",
"snowball": "#/components/schemas/_types.analysis.SnowballTokenFilter",
"sorani_normalization": "#/components/schemas/_types.analysis.SoraniNormalizationTokenFilter",
"stemmer": "#/components/schemas/_types.analysis.StemmerTokenFilter",
"stemmer_override": "#/components/schemas/_types.analysis.StemmerOverrideTokenFilter",
"stop": "#/components/schemas/_types.analysis.StopTokenFilter",
"synonym": "#/components/schemas/_types.analysis.SynonymTokenFilter",
"synonym_graph": "#/components/schemas/_types.analysis.SynonymGraphTokenFilter",
"trim": "#/components/schemas/_types.analysis.TrimTokenFilter",
"truncate": "#/components/schemas/_types.analysis.TruncateTokenFilter",
"unique": "#/components/schemas/_types.analysis.UniqueTokenFilter",
"uppercase": "#/components/schemas/_types.analysis.UppercaseTokenFilter",
"word_delimiter": "#/components/schemas/_types.analysis.WordDelimiterTokenFilter",
"word_delimiter_graph": "#/components/schemas/_types.analysis.WordDelimiterGraphTokenFilter"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.analysis.ApostropheTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ArabicStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ArabicNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.AsciiFoldingTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.BengaliNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.BrazilianStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.CjkBigramTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.CjkWidthTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ClassicTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.CommonGramsTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ConditionTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.CzechStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.DecimalDigitTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.DelimitedPayloadTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.DutchStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.EdgeNGramTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ElisionTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.FingerprintTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.FlattenGraphTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.FrenchStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.GermanNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.GermanStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.HindiNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.HunspellTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.HyphenationDecompounderTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.IndicNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KeepTypesTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KeepWordsTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KeywordMarkerTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KeywordRepeatTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.LengthTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.LimitTokenCountTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.LowercaseTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.MinHashTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.MultiplexerTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.NGramTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.NoriPartOfSpeechTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.PatternCaptureTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.PatternReplaceTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.PersianNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.PersianStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.PorterStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.PredicateTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.RemoveDuplicatesTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ReverseTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.RussianStemTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ScandinavianFoldingTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ScandinavianNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.SerbianNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.ShingleTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.SnowballTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.SoraniNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.StemmerOverrideTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.StemmerTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.StopTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.SynonymGraphTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.SynonymTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.TrimTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.TruncateTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.UniqueTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.UppercaseTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.WordDelimiterGraphTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.WordDelimiterTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.JaStopTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KuromojiStemmerTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KuromojiReadingFormTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.KuromojiPartOfSpeechTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.IcuFoldingTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.IcuNormalizationTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.IcuTransformTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.PhoneticTokenFilter"
},
{
"$ref": "#/components/schemas/_types.analysis.DictionaryDecompounderTokenFilter"
}
]
},
"_types.analysis.ApostropheTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"apostrophe"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.TokenFilterBase": {
"type": "object",
"properties": {
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
}
},
"_types.analysis.ArabicStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"arabic_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.ArabicNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"arabic_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.AsciiFoldingTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"asciifolding"
]
},
"preserve_original": {
"description": "If `true`, emit both original tokens and folded tokens. Defaults to `false`.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.BengaliNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bengali_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.BrazilianStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"brazilian_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.CjkBigramTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cjk_bigram"
]
},
"ignored_scripts": {
"description": "Array of character scripts for which to disable bigrams.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.analysis.CjkBigramIgnoredScript"
}
},
"output_unigrams": {
"description": "If `true`, emit tokens in both bigram and unigram form. If `false`, a CJK character is output in unigram form when it has no adjacent characters. Defaults to `false`.",
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.CjkBigramIgnoredScript": {
"type": "string",
"enum": [
"han",
"hangul",
"hiragana",
"katakana"
]
},
"_types.analysis.CjkWidthTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cjk_width"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.ClassicTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"classic"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.CommonGramsTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"common_grams"
]
},
"common_words": {
"description": "A list of tokens. The filter generates bigrams for these tokens.\nEither this or the `common_words_path` parameter is required.",
"type": "array",
"items": {
"type": "string"
}
},
"common_words_path": {
"description": "Path to a file containing a list of tokens. The filter generates bigrams for these tokens.\nThis path must be absolute or relative to the `config` location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break.\nEither this or the `common_words` parameter is required.",
"type": "string"
},
"ignore_case": {
"description": "If `true`, matches for common words matching are case-insensitive. Defaults to `false`.",
"type": "boolean"
},
"query_mode": {
"description": "If `true`, the filter excludes the following tokens from the output:\n- Unigrams for common words\n- Unigrams for terms followed by common words\nDefaults to `false`. We recommend enabling this parameter for search analyzers.",
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.ConditionTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"condition"
]
},
"filter": {
"description": "Array of token filters. If a token matches the predicate script in the `script` parameter, these filters are applied to the token in the order provided.",
"type": "array",
"items": {
"type": "string"
}
},
"script": {
"description": "Predicate script used to apply token filters. If a token matches this script, the filters in the `filter` parameter are applied to the token.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"type",
"filter",
"script"
]
}
]
},
"_types.analysis.CzechStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"czech_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.DecimalDigitTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"decimal_digit"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.DelimitedPayloadTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"delimited_payload"
]
},
"delimiter": {
"description": "Character used to separate tokens from payloads. Defaults to `|`.",
"type": "string"
},
"encoding": {
"description": "Data type for the stored payload.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.DelimitedPayloadEncoding"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.DelimitedPayloadEncoding": {
"type": "string",
"enum": [
"int",
"float",
"identity"
]
},
"_types.analysis.DutchStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dutch_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.EdgeNGramTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"edge_ngram"
]
},
"max_gram": {
"description": "Maximum character length of a gram. For custom token filters, defaults to `2`. For the built-in edge_ngram filter, defaults to `1`.",
"type": "number"
},
"min_gram": {
"description": "Minimum character length of a gram. Defaults to `1`.",
"type": "number"
},
"side": {
"description": "Indicates whether to truncate tokens from the `front` or `back`. Defaults to `front`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.EdgeNGramSide"
}
]
},
"preserve_original": {
"description": "Emits original token when set to `true`. Defaults to `false`.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.EdgeNGramSide": {
"type": "string",
"enum": [
"front",
"back"
]
},
"_types.analysis.ElisionTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"elision"
]
},
"articles": {
"description": "List of elisions to remove.\nTo be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.\nFor custom `elision` filters, either this parameter or `articles_path` must be specified.",
"type": "array",
"items": {
"type": "string"
}
},
"articles_path": {
"description": "Path to a file that contains a list of elisions to remove.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each elision in the file must be separated by a line break.\nTo be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.\nFor custom `elision` filters, either this parameter or `articles` must be specified.",
"type": "string"
},
"articles_case": {
"description": "If `true`, elision matching is case insensitive. If `false`, elision matching is case sensitive. Defaults to `false`.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.FingerprintTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"fingerprint"
]
},
"max_output_size": {
"description": "Maximum character length, including whitespace, of the output token. Defaults to `255`. Concatenated tokens longer than this will result in no token output.",
"type": "number"
},
"separator": {
"description": "Character to use to concatenate the token stream input. Defaults to a space.",
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.FlattenGraphTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"flatten_graph"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.FrenchStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"french_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.GermanNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"german_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.GermanStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"german_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.HindiNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"hindi_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.HunspellTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"hunspell"
]
},
"dedup": {
"description": "If `true`, duplicate tokens are removed from the filter’s output. Defaults to `true`.",
"type": "boolean"
},
"dictionary": {
"description": "One or more `.dic` files (e.g, `en_US.dic`, my_custom.dic) to use for the Hunspell dictionary.\nBy default, the `hunspell` filter uses all `.dic` files in the `<$ES_PATH_CONF>/hunspell/` directory specified using the `lang`, `language`, or `locale` parameter.",
"type": "string"
},
"locale": {
"description": "Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary.",
"type": "string"
},
"longest_only": {
"description": "If `true`, only the longest stemmed version of each token is included in the output. If `false`, all stemmed versions of the token are included. Defaults to `false`.",
"type": "boolean"
}
},
"required": [
"type",
"locale"
]
}
]
},
"_types.analysis.HyphenationDecompounderTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.CompoundWordTokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"hyphenation_decompounder"
]
},
"hyphenation_patterns_path": {
"description": "Path to an Apache FOP (Formatting Objects Processor) XML hyphenation pattern file.\nThis path must be absolute or relative to the `config` location. Only FOP v1.2 compatible files are supported.",
"type": "string"
},
"no_sub_matches": {
"description": "If `true`, do not match sub tokens in tokens that are in the word list. Defaults to `false`.",
"type": "boolean"
},
"no_overlapping_matches": {
"description": "If `true`, do not allow overlapping tokens. Defaults to `false`.",
"type": "boolean"
}
},
"required": [
"type",
"hyphenation_patterns_path"
]
}
]
},
"_types.analysis.CompoundWordTokenFilterBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"max_subword_size": {
"description": "Maximum subword character length. Longer subword tokens are excluded from the output. Defaults to `15`.",
"type": "number"
},
"min_subword_size": {
"description": "Minimum subword character length. Shorter subword tokens are excluded from the output. Defaults to `2`.",
"type": "number"
},
"min_word_size": {
"description": "Minimum word character length. Shorter word tokens are excluded from the output. Defaults to `5`.",
"type": "number"
},
"only_longest_match": {
"description": "If `true`, only include the longest matching subword. Defaults to `false`.",
"type": "boolean"
},
"word_list": {
"description": "A list of subwords to look for in the token stream. If found, the subword is included in the token output.\nEither this parameter or `word_list_path` must be specified.",
"type": "array",
"items": {
"type": "string"
}
},
"word_list_path": {
"description": "Path to a file that contains a list of subwords to find in the token stream. If found, the subword is included in the token output.\nThis path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.\nEither this parameter or `word_list` must be specified.",
"type": "string"
}
}
}
]
},
"_types.analysis.IndicNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"indic_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.KeepTypesTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"keep_types"
]
},
"mode": {
"description": "Indicates whether to keep or remove the specified token types.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.KeepTypesMode"
}
]
},
"types": {
"description": "List of token types to keep or remove.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"types"
]
}
]
},
"_types.analysis.KeepTypesMode": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"_types.analysis.KeepWordsTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"keep"
]
},
"keep_words": {
"description": "List of words to keep. Only tokens that match words in this list are included in the output.\nEither this parameter or `keep_words_path` must be specified.",
"type": "array",
"items": {
"type": "string"
}
},
"keep_words_case": {
"description": "If `true`, lowercase all keep words. Defaults to `false`.",
"type": "boolean"
},
"keep_words_path": {
"description": "Path to a file that contains a list of words to keep. Only tokens that match words in this list are included in the output.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.\nEither this parameter or `keep_words` must be specified.",
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.KeywordMarkerTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"keyword_marker"
]
},
"ignore_case": {
"description": "If `true`, matching for the `keywords` and `keywords_path` parameters ignores letter case. Defaults to `false`.",
"type": "boolean"
},
"keywords": {
"description": "Array of keywords. Tokens that match these keywords are not stemmed.\nThis parameter, `keywords_path`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"keywords_path": {
"description": "Path to a file that contains a list of keywords. Tokens that match these keywords are not stemmed.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.\nThis parameter, `keywords`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`.",
"type": "string"
},
"keywords_pattern": {
"description": "Java regular expression used to match tokens. Tokens that match this expression are marked as keywords and not stemmed.\nThis parameter, `keywords`, or `keywords_path` must be specified. You cannot specify this parameter and `keywords` or `keywords_pattern`.",
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.KeywordRepeatTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"keyword_repeat"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.KStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kstem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.LengthTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"length"
]
},
"max": {
"description": "Maximum character length of a token. Longer tokens are excluded from the output. Defaults to `Integer.MAX_VALUE`, which is `2^31-1` or `2147483647`.",
"type": "number"
},
"min": {
"description": "Minimum character length of a token. Shorter tokens are excluded from the output. Defaults to `0`.",
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.LimitTokenCountTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"limit"
]
},
"consume_all_tokens": {
"description": "If `true`, the limit filter exhausts the token stream, even if the `max_token_count` has already been reached. Defaults to `false`.",
"type": "boolean"
},
"max_token_count": {
"description": "Maximum number of tokens to keep. Once this limit is reached, any remaining tokens are excluded from the output. Defaults to `1`.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.LowercaseTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"lowercase"
]
},
"language": {
"description": "Language-specific lowercase token filter to use.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.LowercaseTokenFilterLanguages"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.LowercaseTokenFilterLanguages": {
"type": "string",
"enum": [
"greek",
"irish",
"turkish"
]
},
"_types.analysis.MinHashTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"min_hash"
]
},
"bucket_count": {
"description": "Number of buckets to which hashes are assigned. Defaults to `512`.",
"type": "number"
},
"hash_count": {
"description": "Number of ways to hash each token in the stream. Defaults to `1`.",
"type": "number"
},
"hash_set_size": {
"description": "Number of hashes to keep from each bucket. Defaults to `1`.\nHashes are retained by ascending size, starting with the bucket’s smallest hash first.",
"type": "number"
},
"with_rotation": {
"description": "If `true`, the filter fills empty buckets with the value of the first non-empty bucket to its circular right if the `hash_set_size` is `1`. If the `bucket_count` argument is greater than 1, this parameter defaults to `true`. Otherwise, this parameter defaults to `false`.",
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.MultiplexerTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"multiplexer"
]
},
"filters": {
"description": "A list of token filters to apply to incoming tokens.",
"type": "array",
"items": {
"type": "string"
}
},
"preserve_original": {
"description": "If `true` (the default) then emit the original token in addition to the filtered tokens.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
}
},
"required": [
"type",
"filters"
]
}
]
},
"_types.analysis.NGramTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ngram"
]
},
"max_gram": {
"description": "Maximum length of characters in a gram. Defaults to `2`.",
"type": "number"
},
"min_gram": {
"description": "Minimum length of characters in a gram. Defaults to `1`.",
"type": "number"
},
"preserve_original": {
"description": "Emits original token when set to `true`. Defaults to `false`.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.NoriPartOfSpeechTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"nori_part_of_speech"
]
},
"stoptags": {
"description": "An array of part-of-speech tags that should be removed.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.PatternCaptureTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pattern_capture"
]
},
"patterns": {
"description": "A list of regular expressions to match.",
"type": "array",
"items": {
"type": "string"
}
},
"preserve_original": {
"description": "If set to `true` (the default) it will emit the original token.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
}
},
"required": [
"type",
"patterns"
]
}
]
},
"_types.analysis.PatternReplaceTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pattern_replace"
]
},
"all": {
"description": "If `true`, all substrings matching the pattern parameter’s regular expression are replaced. If `false`, the filter replaces only the first matching substring in each token. Defaults to `true`.",
"type": "boolean"
},
"flags": {
"type": "string"
},
"pattern": {
"description": "Regular expression, written in Java’s regular expression syntax. The filter replaces token substrings matching this pattern with the substring in the `replacement` parameter.",
"type": "string"
},
"replacement": {
"description": "Replacement substring. Defaults to an empty substring (`\"\"`).",
"type": "string"
}
},
"required": [
"type",
"pattern"
]
}
]
},
"_types.analysis.PersianNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"persian_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.PersianStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"persian_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.PorterStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"porter_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.PredicateTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"predicate_token_filter"
]
},
"script": {
"description": "Script containing a condition used to filter incoming tokens. Only tokens that match this script are included in the output.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"type",
"script"
]
}
]
},
"_types.analysis.RemoveDuplicatesTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"remove_duplicates"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.ReverseTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"reverse"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.RussianStemTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"russian_stem"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.ScandinavianFoldingTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"scandinavian_folding"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.ScandinavianNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"scandinavian_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.SerbianNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"serbian_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.ShingleTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"shingle"
]
},
"filler_token": {
"description": "String used in shingles as a replacement for empty positions that do not contain a token. This filler token is only used in shingles, not original unigrams. Defaults to an underscore (`_`).",
"type": "string"
},
"max_shingle_size": {
"description": "Maximum number of tokens to concatenate when creating shingles. Defaults to `2`.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
}
]
},
"min_shingle_size": {
"description": "Minimum number of tokens to concatenate when creating shingles. Defaults to `2`.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
}
]
},
"output_unigrams": {
"description": "If `true`, the output includes the original input tokens. If `false`, the output only includes shingles; the original input tokens are removed. Defaults to `true`.",
"type": "boolean"
},
"output_unigrams_if_no_shingles": {
"description": "If `true`, the output includes the original input tokens only if no shingles are produced; if shingles are produced, the output only includes shingles. Defaults to `false`.",
"type": "boolean"
},
"token_separator": {
"description": "Separator used to concatenate adjacent tokens to form a shingle. Defaults to a space (`\" \"`).",
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.SnowballTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"snowball"
]
},
"language": {
"description": "Controls the language used by the stemmer.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.SnowballLanguage"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.SoraniNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"sorani_normalization"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.StemmerOverrideTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"stemmer_override"
]
},
"rules": {
"description": "A list of mapping rules to use.",
"type": "array",
"items": {
"type": "string"
}
},
"rules_path": {
"description": "A path (either relative to `config` location, or absolute) to a list of mappings.",
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.StemmerTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"stemmer"
]
},
"language": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.StopTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"stop"
]
},
"ignore_case": {
"description": "If `true`, stop word matching is case insensitive. For example, if `true`, a stop word of the matches and removes `The`, `THE`, or `the`. Defaults to `false`.",
"type": "boolean"
},
"remove_trailing": {
"description": "If `true`, the last token of a stream is removed if it’s a stop word. Defaults to `true`.",
"type": "boolean"
},
"stopwords": {
"description": "Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
},
"stopwords_path": {
"description": "Path to a file that contains a list of stop words to remove.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break.",
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.SynonymGraphTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.SynonymTokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"synonym_graph"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.SynonymTokenFilterBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"expand": {
"description": "Expands definitions for equivalent synonym rules. Defaults to `true`.",
"type": "boolean"
},
"format": {
"description": "Sets the synonym rules format.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.SynonymFormat"
}
]
},
"lenient": {
"description": "If `true` ignores errors while parsing the synonym rules. It is important to note that only those synonym rules which cannot get parsed are ignored. Defaults to the value of the `updateable` setting.",
"type": "boolean"
},
"synonyms": {
"description": "Used to define inline synonyms.",
"type": "array",
"items": {
"type": "string"
}
},
"synonyms_path": {
"description": "Used to provide a synonym file. This path must be absolute or relative to the `config` location.",
"type": "string"
},
"synonyms_set": {
"description": "Provide one or more synonym sets created via Synonyms Management APIs.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"tokenizer": {
"deprecated": true,
"description": "Controls the tokenizers that will be used to tokenize the synonym, this parameter is for backwards compatibility for indices that created before 6.0.",
"type": "string"
},
"updateable": {
"description": "If `true` allows reloading search analyzers to pick up changes to synonym files. Only to be used for search analyzers. Defaults to `false`.",
"type": "boolean"
}
}
}
]
},
"_types.analysis.SynonymFormat": {
"type": "string",
"enum": [
"solr",
"wordnet"
]
},
"_types.analysis.SynonymTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.SynonymTokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"synonym"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.TrimTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"trim"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.TruncateTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"truncate"
]
},
"length": {
"description": "Character limit for each token. Tokens exceeding this limit are truncated. Defaults to `10`.",
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.UniqueTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"unique"
]
},
"only_on_same_position": {
"description": "If `true`, only remove duplicate tokens in the same position. Defaults to `false`.",
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.UppercaseTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"uppercase"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.WordDelimiterGraphTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.WordDelimiterTokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"word_delimiter_graph"
]
},
"adjust_offsets": {
"description": "If `true`, the filter adjusts the offsets of split or catenated tokens to better reflect their actual position in the token stream. Defaults to `true`.",
"type": "boolean"
},
"ignore_keywords": {
"description": "If `true`, the filter skips tokens with a keyword attribute of true. Defaults to `false`.",
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.WordDelimiterTokenFilterBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"catenate_all": {
"description": "If `true`, the filter produces catenated tokens for chains of alphanumeric characters separated by non-alphabetic delimiters. Defaults to `false`.",
"type": "boolean"
},
"catenate_numbers": {
"description": "If `true`, the filter produces catenated tokens for chains of numeric characters separated by non-alphabetic delimiters. Defaults to `false`.",
"type": "boolean"
},
"catenate_words": {
"description": "If `true`, the filter produces catenated tokens for chains of alphabetical characters separated by non-alphabetic delimiters. Defaults to `false`.",
"type": "boolean"
},
"generate_number_parts": {
"description": "If `true`, the filter includes tokens consisting of only numeric characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`.",
"type": "boolean"
},
"generate_word_parts": {
"description": "If `true`, the filter includes tokens consisting of only alphabetical characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`.",
"type": "boolean"
},
"preserve_original": {
"description": "If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. Defaults to `false`.",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
},
"protected_words": {
"description": "Array of tokens the filter won’t split.",
"type": "array",
"items": {
"type": "string"
}
},
"protected_words_path": {
"description": "Path to a file that contains a list of tokens the filter won’t split.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.",
"type": "string"
},
"split_on_case_change": {
"description": "If `true`, the filter splits tokens at letter case transitions. For example: camelCase -> [ camel, Case ]. Defaults to `true`.",
"type": "boolean"
},
"split_on_numerics": {
"description": "If `true`, the filter splits tokens at letter-number transitions. For example: j2se -> [ j, 2, se ]. Defaults to `true`.",
"type": "boolean"
},
"stem_english_possessive": {
"description": "If `true`, the filter removes the English possessive (`'s`) from the end of each token. For example: O'Neil's -> [ O, Neil ]. Defaults to `true`.",
"type": "boolean"
},
"type_table": {
"description": "Array of custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters.",
"type": "array",
"items": {
"type": "string"
}
},
"type_table_path": {
"description": "Path to a file that contains custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters.",
"type": "string"
}
}
}
]
},
"_types.analysis.WordDelimiterTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.WordDelimiterTokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"word_delimiter"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.JaStopTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ja_stop"
]
},
"stopwords": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.StopWords"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.KuromojiStemmerTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kuromoji_stemmer"
]
},
"minimum_length": {
"type": "number"
}
},
"required": [
"type",
"minimum_length"
]
}
]
},
"_types.analysis.KuromojiReadingFormTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kuromoji_readingform"
]
},
"use_romaji": {
"type": "boolean"
}
},
"required": [
"type",
"use_romaji"
]
}
]
},
"_types.analysis.KuromojiPartOfSpeechTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kuromoji_part_of_speech"
]
},
"stoptags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"stoptags"
]
}
]
},
"_types.analysis.IcuCollationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"icu_collation"
]
},
"alternate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate"
}
]
},
"caseFirst": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst"
}
]
},
"caseLevel": {
"type": "boolean"
},
"country": {
"type": "string"
},
"decomposition": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition"
}
]
},
"hiraganaQuaternaryMode": {
"type": "boolean"
},
"language": {
"type": "string"
},
"numeric": {
"type": "boolean"
},
"rules": {
"type": "string"
},
"strength": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationStrength"
}
]
},
"variableTop": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.IcuCollationAlternate": {
"type": "string",
"enum": [
"shifted",
"non-ignorable"
]
},
"_types.analysis.IcuCollationCaseFirst": {
"type": "string",
"enum": [
"lower",
"upper"
]
},
"_types.analysis.IcuCollationDecomposition": {
"type": "string",
"enum": [
"no",
"identical"
]
},
"_types.analysis.IcuCollationStrength": {
"type": "string",
"enum": [
"primary",
"secondary",
"tertiary",
"quaternary",
"identical"
]
},
"_types.analysis.IcuFoldingTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"icu_folding"
]
},
"unicode_set_filter": {
"type": "string"
}
},
"required": [
"type",
"unicode_set_filter"
]
}
]
},
"_types.analysis.IcuNormalizationTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"icu_normalizer"
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuNormalizationType"
}
]
}
},
"required": [
"type",
"name"
]
}
]
},
"_types.analysis.IcuTransformTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"icu_transform"
]
},
"dir": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuTransformDirection"
}
]
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
}
]
},
"_types.analysis.IcuTransformDirection": {
"type": "string",
"enum": [
"forward",
"reverse"
]
},
"_types.analysis.PhoneticTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"phonetic"
]
},
"encoder": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.PhoneticEncoder"
}
]
},
"languageset": {
"description": "\n\nSupported values include: `any`, `common`, `cyrillic`, `english`, `french`, `german`, `hebrew`, `hungarian`, `polish`, `romanian`, `russian`, `spanish`\n\n",
"oneOf": [
{
"$ref": "#/components/schemas/_types.analysis.PhoneticLanguage"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.analysis.PhoneticLanguage"
}
}
]
},
"max_code_len": {
"type": "number"
},
"name_type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.PhoneticNameType"
}
]
},
"replace": {
"type": "boolean"
},
"rule_type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.PhoneticRuleType"
}
]
}
},
"required": [
"type",
"encoder"
]
}
]
},
"_types.analysis.PhoneticEncoder": {
"type": "string",
"enum": [
"metaphone",
"double_metaphone",
"soundex",
"refined_soundex",
"caverphone1",
"caverphone2",
"cologne",
"nysiis",
"koelnerphonetik",
"haasephonetik",
"beider_morse",
"daitch_mokotoff"
]
},
"_types.analysis.PhoneticLanguage": {
"type": "string",
"enum": [
"any",
"common",
"cyrillic",
"english",
"french",
"german",
"hebrew",
"hungarian",
"polish",
"romanian",
"russian",
"spanish"
]
},
"_types.analysis.PhoneticNameType": {
"type": "string",
"enum": [
"generic",
"ashkenazi",
"sephardic"
]
},
"_types.analysis.PhoneticRuleType": {
"type": "string",
"enum": [
"approx",
"exact"
]
},
"_types.analysis.DictionaryDecompounderTokenFilter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.CompoundWordTokenFilterBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dictionary_decompounder"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.Normalizer": {
"discriminator": {
"propertyName": "type",
"mapping": {
"custom": "#/components/schemas/_types.analysis.CustomNormalizer",
"lowercase": "#/components/schemas/_types.analysis.LowercaseNormalizer"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.analysis.LowercaseNormalizer"
},
{
"$ref": "#/components/schemas/_types.analysis.CustomNormalizer"
}
]
},
"_types.analysis.LowercaseNormalizer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"lowercase"
]
}
},
"required": [
"type"
]
},
"_types.analysis.CustomNormalizer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom"
]
},
"char_filter": {
"type": "array",
"items": {
"type": "string"
}
},
"filter": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
"_types.analysis.Tokenizer": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference"
},
"x-model": true
},
"_types.analysis.TokenizerDefinition": {
"discriminator": {
"propertyName": "type",
"mapping": {
"char_group": "#/components/schemas/_types.analysis.CharGroupTokenizer",
"classic": "#/components/schemas/_types.analysis.ClassicTokenizer",
"edge_ngram": "#/components/schemas/_types.analysis.EdgeNGramTokenizer",
"icu_tokenizer": "#/components/schemas/_types.analysis.IcuTokenizer",
"keyword": "#/components/schemas/_types.analysis.KeywordTokenizer",
"kuromoji_tokenizer": "#/components/schemas/_types.analysis.KuromojiTokenizer",
"letter": "#/components/schemas/_types.analysis.LetterTokenizer",
"lowercase": "#/components/schemas/_types.analysis.LowercaseTokenizer",
"ngram": "#/components/schemas/_types.analysis.NGramTokenizer",
"nori_tokenizer": "#/components/schemas/_types.analysis.NoriTokenizer",
"path_hierarchy": "#/components/schemas/_types.analysis.PathHierarchyTokenizer",
"pattern": "#/components/schemas/_types.analysis.PatternTokenizer",
"simple_pattern": "#/components/schemas/_types.analysis.SimplePatternTokenizer",
"simple_pattern_split": "#/components/schemas/_types.analysis.SimplePatternSplitTokenizer",
"standard": "#/components/schemas/_types.analysis.StandardTokenizer",
"thai": "#/components/schemas/_types.analysis.ThaiTokenizer",
"uax_url_email": "#/components/schemas/_types.analysis.UaxEmailUrlTokenizer",
"whitespace": "#/components/schemas/_types.analysis.WhitespaceTokenizer"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.analysis.CharGroupTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.ClassicTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.EdgeNGramTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.KeywordTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.LetterTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.LowercaseTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.NGramTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.PathHierarchyTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.PatternTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.SimplePatternTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.SimplePatternSplitTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.StandardTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.ThaiTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.UaxEmailUrlTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.WhitespaceTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.IcuTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.KuromojiTokenizer"
},
{
"$ref": "#/components/schemas/_types.analysis.NoriTokenizer"
}
]
},
"_types.analysis.CharGroupTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"char_group"
]
},
"tokenize_on_chars": {
"type": "array",
"items": {
"type": "string"
}
},
"max_token_length": {
"type": "number"
}
},
"required": [
"type",
"tokenize_on_chars"
]
}
]
},
"_types.analysis.TokenizerBase": {
"type": "object",
"properties": {
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
}
},
"_types.analysis.ClassicTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"classic"
]
},
"max_token_length": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.EdgeNGramTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"edge_ngram"
]
},
"custom_token_chars": {
"type": "string"
},
"max_gram": {
"type": "number"
},
"min_gram": {
"type": "number"
},
"token_chars": {
"default": [],
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.analysis.TokenChar"
}
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.TokenChar": {
"type": "string",
"enum": [
"letter",
"digit",
"whitespace",
"punctuation",
"symbol",
"custom"
]
},
"_types.analysis.KeywordTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"keyword"
]
},
"buffer_size": {
"default": 256,
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.LetterTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"letter"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.LowercaseTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"lowercase"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.NGramTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ngram"
]
},
"custom_token_chars": {
"type": "string"
},
"max_gram": {
"type": "number"
},
"min_gram": {
"type": "number"
},
"token_chars": {
"default": [],
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.analysis.TokenChar"
}
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.PathHierarchyTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"path_hierarchy"
]
},
"buffer_size": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
}
]
},
"delimiter": {
"type": "string"
},
"replacement": {
"type": "string"
},
"reverse": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
}
]
},
"skip": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.PatternTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pattern"
]
},
"flags": {
"type": "string"
},
"group": {
"type": "number"
},
"pattern": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.SimplePatternTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"simple_pattern"
]
},
"pattern": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.SimplePatternSplitTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"simple_pattern_split"
]
},
"pattern": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.StandardTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"standard"
]
},
"max_token_length": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.ThaiTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"thai"
]
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.UaxEmailUrlTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"uax_url_email"
]
},
"max_token_length": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.WhitespaceTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"whitespace"
]
},
"max_token_length": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.analysis.IcuTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"icu_tokenizer"
]
},
"rule_files": {
"type": "string"
}
},
"required": [
"type",
"rule_files"
]
}
]
},
"_types.analysis.KuromojiTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kuromoji_tokenizer"
]
},
"discard_punctuation": {
"type": "boolean"
},
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode"
}
]
},
"nbest_cost": {
"type": "number"
},
"nbest_examples": {
"type": "string"
},
"user_dictionary": {
"type": "string"
},
"user_dictionary_rules": {
"type": "array",
"items": {
"type": "string"
}
},
"discard_compound_token": {
"type": "boolean"
}
},
"required": [
"type",
"mode"
]
}
]
},
"_types.analysis.NoriTokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.TokenizerBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"nori_tokenizer"
]
},
"decompound_mode": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode"
}
]
},
"discard_punctuation": {
"type": "boolean"
},
"user_dictionary": {
"type": "string"
},
"user_dictionary_rules": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
}
]
},
"indices._types.IndexSettingsTimeSeries": {
"type": "object",
"properties": {
"end_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"start_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
}
},
"indices._types.Queries": {
"type": "object",
"properties": {
"cache": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.CacheQueries"
}
]
}
}
},
"indices._types.CacheQueries": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"indices._types.SettingsSimilarity": {
"discriminator": {
"propertyName": "type",
"mapping": {
"BM25": "#/components/schemas/indices._types.SettingsSimilarityBm25",
"DFI": "#/components/schemas/indices._types.SettingsSimilarityDfi",
"DFR": "#/components/schemas/indices._types.SettingsSimilarityDfr",
"IB": "#/components/schemas/indices._types.SettingsSimilarityIb",
"LMDirichlet": "#/components/schemas/indices._types.SettingsSimilarityLmd",
"LMJelinekMercer": "#/components/schemas/indices._types.SettingsSimilarityLmj",
"boolean": "#/components/schemas/indices._types.SettingsSimilarityBoolean",
"scripted": "#/components/schemas/indices._types.SettingsSimilarityScripted"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/indices._types.SettingsSimilarityBm25"
},
{
"$ref": "#/components/schemas/indices._types.SettingsSimilarityBoolean"
},
{
"$ref": "#/components/schemas/indices._types.SettingsSimilarityDfi"
},
{
"$ref": "#/components/schemas/indices._types.SettingsSimilarityDfr"
},
{
"$ref": "#/components/schemas/indices._types.SettingsSimilarityIb"
},
{
"$ref": "#/components/schemas/indices._types.SettingsSimilarityLmd"
},
{
"$ref": "#/components/schemas/indices._types.SettingsSimilarityLmj"
},
{
"$ref": "#/components/schemas/indices._types.SettingsSimilarityScripted"
}
]
},
"indices._types.SettingsSimilarityBm25": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"BM25"
]
},
"b": {
"type": "number"
},
"discount_overlaps": {
"type": "boolean"
},
"k1": {
"type": "number"
}
},
"required": [
"type"
]
},
"indices._types.SettingsSimilarityBoolean": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"boolean"
]
}
},
"required": [
"type"
]
},
"indices._types.SettingsSimilarityDfi": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DFI"
]
},
"independence_measure": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DFIIndependenceMeasure"
}
]
}
},
"required": [
"type",
"independence_measure"
]
},
"_types.DFIIndependenceMeasure": {
"type": "string",
"enum": [
"standardized",
"saturated",
"chisquared"
]
},
"indices._types.SettingsSimilarityDfr": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DFR"
]
},
"after_effect": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DFRAfterEffect"
}
]
},
"basic_model": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DFRBasicModel"
}
]
},
"normalization": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Normalization"
}
]
}
},
"required": [
"type",
"after_effect",
"basic_model",
"normalization"
]
},
"_types.DFRAfterEffect": {
"type": "string",
"enum": [
"no",
"b",
"l"
]
},
"_types.DFRBasicModel": {
"type": "string",
"enum": [
"be",
"d",
"g",
"if",
"in",
"ine",
"p"
]
},
"_types.Normalization": {
"type": "string",
"enum": [
"no",
"h1",
"h2",
"h3",
"z"
]
},
"indices._types.SettingsSimilarityIb": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"IB"
]
},
"distribution": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IBDistribution"
}
]
},
"lambda": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IBLambda"
}
]
},
"normalization": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Normalization"
}
]
}
},
"required": [
"type",
"distribution",
"lambda",
"normalization"
]
},
"_types.IBDistribution": {
"type": "string",
"enum": [
"ll",
"spl"
]
},
"_types.IBLambda": {
"type": "string",
"enum": [
"df",
"ttf"
]
},
"indices._types.SettingsSimilarityLmd": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"LMDirichlet"
]
},
"mu": {
"type": "number"
}
},
"required": [
"type"
]
},
"indices._types.SettingsSimilarityLmj": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"LMJelinekMercer"
]
},
"lambda": {
"type": "number"
}
},
"required": [
"type"
]
},
"indices._types.SettingsSimilarityScripted": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"scripted"
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"weight_script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"type",
"script"
]
},
"indices._types.MappingLimitSettings": {
"description": "Mapping Limit Settings",
"type": "object",
"properties": {
"coerce": {
"type": "boolean"
},
"total_fields": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.MappingLimitSettingsTotalFields"
}
]
},
"depth": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.MappingLimitSettingsDepth"
}
]
},
"nested_fields": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedFields"
}
]
},
"nested_objects": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedObjects"
}
]
},
"field_name_length": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.MappingLimitSettingsFieldNameLength"
}
]
},
"dimension_fields": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.MappingLimitSettingsDimensionFields"
}
]
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.MappingLimitSettingsSourceFields"
}
]
},
"ignore_malformed": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
}
},
"indices._types.MappingLimitSettingsTotalFields": {
"type": "object",
"properties": {
"limit": {
"description": "The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.\nThe limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance\ndegradations and memory issues, especially in clusters with a high load or few resources.",
"default": "1000",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"ignore_dynamic_beyond_limit": {
"description": "This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set\nto false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail\nwith the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.\nInstead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.\nThe fields that were not added to the mapping will be added to the _ignored field.",
"default": "false",
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
}
},
"indices._types.MappingLimitSettingsDepth": {
"type": "object",
"properties": {
"limit": {
"description": "The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined\nat the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.",
"default": 20,
"type": "number"
}
}
},
"indices._types.MappingLimitSettingsNestedFields": {
"type": "object",
"properties": {
"limit": {
"description": "The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when\narrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this\nsetting limits the number of unique nested types per index.",
"default": 50,
"type": "number"
}
}
},
"indices._types.MappingLimitSettingsNestedObjects": {
"type": "object",
"properties": {
"limit": {
"description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps\nto prevent out of memory errors when a document contains too many nested objects.",
"default": 10000,
"type": "number"
}
}
},
"indices._types.MappingLimitSettingsFieldNameLength": {
"type": "object",
"properties": {
"limit": {
"description": "Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but\nmight still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The\ndefault is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).",
"type": "number"
}
}
},
"indices._types.MappingLimitSettingsDimensionFields": {
"type": "object",
"properties": {
"limit": {
"description": "[preview] This functionality is in technical preview and may be changed or removed in a future release.\nElastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.",
"type": "number"
}
}
},
"indices._types.MappingLimitSettingsSourceFields": {
"type": "object",
"properties": {
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SourceMode"
}
]
}
},
"required": [
"mode"
]
},
"indices._types.SourceMode": {
"type": "string",
"enum": [
"disabled",
"stored",
"synthetic"
]
},
"indices._types.IndexingSlowlogSettings": {
"type": "object",
"properties": {
"level": {
"type": "string"
},
"source": {
"type": "number"
},
"reformat": {
"type": "boolean"
},
"threshold": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexingSlowlogTresholds"
}
]
}
}
},
"indices._types.IndexingSlowlogTresholds": {
"type": "object",
"properties": {
"index": {
"description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels"
}
]
}
}
},
"indices._types.IndexingPressure": {
"type": "object",
"properties": {
"memory": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexingPressureMemory"
}
]
}
},
"required": [
"memory"
]
},
"indices._types.IndexingPressureMemory": {
"type": "object",
"properties": {
"limit": {
"description": "Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,\nthe node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,\nthe node will reject new replica operations. Defaults to 10% of the heap.",
"type": "number"
}
}
},
"indices._types.Storage": {
"type": "object",
"properties": {
"type": {
"description": "\n\nSupported values include:\n - `fs`: Default file system implementation. This will pick the best implementation depending on the operating environment, which\nis currently hybridfs on all supported systems but is subject to change.\n - `niofs`: The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple\nthreads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java\nimplementation and disables some optimizations for heap memory usage.\n - `mmapfs`: The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into\nmemory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size\nof the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space.\n - `hybridfs`: The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file\nbased on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory\nmapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed\nplenty of virtual address space.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.StorageType"
}
]
},
"allow_mmap": {
"description": "You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.\nThis is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This\nsetting is useful, for example, if you are in an environment where you can not control the ability to create a lot\nof memory maps so you need disable the ability to use memory-mapping.",
"type": "boolean"
},
"stats_refresh_interval": {
"description": "How often store statistics are refreshed",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"type"
]
},
"indices._types.StorageType": {
"anyOf": [
{
"type": "string",
"enum": [
"fs",
"niofs",
"mmapfs",
"hybridfs"
]
},
{
"type": "string"
}
]
},
"ccr.follow_info.FollowerIndex": {
"type": "object",
"properties": {
"follower_index": {
"description": "The name of the follower index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"leader_index": {
"description": "The name of the index in the leader cluster that is followed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"parameters": {
"description": "An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/ccr.follow_info.FollowerIndexParameters"
}
]
},
"remote_cluster": {
"description": "The remote cluster that contains the leader index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"status": {
"description": "The status of the index following: `active` or `paused`.",
"allOf": [
{
"$ref": "#/components/schemas/ccr.follow_info.FollowerIndexStatus"
}
]
}
},
"required": [
"follower_index",
"leader_index",
"remote_cluster",
"status"
]
},
"ccr.follow_info.FollowerIndexParameters": {
"type": "object",
"properties": {
"max_outstanding_read_requests": {
"description": "The maximum number of outstanding reads requests from the remote cluster.",
"type": "number"
},
"max_outstanding_write_requests": {
"description": "The maximum number of outstanding write requests on the follower.",
"type": "number"
},
"max_read_request_operation_count": {
"description": "The maximum number of operations to pull per read from the remote cluster.",
"type": "number"
},
"max_read_request_size": {
"description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_retry_delay": {
"description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_write_buffer_count": {
"description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.",
"type": "number"
},
"max_write_buffer_size": {
"description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_write_request_operation_count": {
"description": "The maximum number of operations per bulk write request executed on the follower.",
"type": "number"
},
"max_write_request_size": {
"description": "The maximum total bytes of operations per bulk write request executed on the follower.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"read_poll_timeout": {
"description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"ccr.follow_info.FollowerIndexStatus": {
"type": "string",
"enum": [
"active",
"paused"
]
},
"ccr._types.FollowIndexStats": {
"type": "object",
"properties": {
"index": {
"description": "The name of the follower index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shards": {
"description": "An array of shard-level following task statistics.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ccr._types.ShardStats"
}
}
},
"required": [
"index",
"shards"
]
},
"ccr._types.ShardStats": {
"type": "object",
"properties": {
"bytes_read": {
"description": "The total of transferred bytes read from the leader.\nThis is only an estimate and does not account for compression if enabled.",
"type": "number"
},
"failed_read_requests": {
"description": "The number of failed reads.",
"type": "number"
},
"failed_write_requests": {
"description": "The number of failed bulk write requests on the follower.",
"type": "number"
},
"fatal_exception": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"follower_aliases_version": {
"description": "The index aliases version the follower is synced up to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"follower_global_checkpoint": {
"description": "The current global checkpoint on the follower.\nThe difference between the `leader_global_checkpoint` and the `follower_global_checkpoint` is an indication of how much the follower is lagging the leader.",
"type": "number"
},
"follower_index": {
"description": "The name of the follower index.",
"type": "string"
},
"follower_mapping_version": {
"description": "The mapping version the follower is synced up to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"follower_max_seq_no": {
"description": "The current maximum sequence number on the follower.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"follower_settings_version": {
"description": "The index settings version the follower is synced up to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"last_requested_seq_no": {
"description": "The starting sequence number of the last batch of operations requested from the leader.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"leader_global_checkpoint": {
"description": "The current global checkpoint on the leader known to the follower task.",
"type": "number"
},
"leader_index": {
"description": "The name of the index in the leader cluster being followed.",
"type": "string"
},
"leader_max_seq_no": {
"description": "The current maximum sequence number on the leader known to the follower task.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"operations_read": {
"description": "The total number of operations read from the leader.",
"type": "number"
},
"operations_written": {
"description": "The number of operations written on the follower.",
"type": "number"
},
"outstanding_read_requests": {
"description": "The number of active read requests from the follower.",
"type": "number"
},
"outstanding_write_requests": {
"description": "The number of active bulk write requests on the follower.",
"type": "number"
},
"read_exceptions": {
"description": "An array of objects representing failed reads.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ccr._types.ReadException"
}
},
"remote_cluster": {
"description": "The remote cluster containing the leader index.",
"type": "string"
},
"shard_id": {
"description": "The numerical shard ID, with values from 0 to one less than the number of replicas.",
"type": "number"
},
"successful_read_requests": {
"description": "The number of successful fetches.",
"type": "number"
},
"successful_write_requests": {
"description": "The number of bulk write requests run on the follower.",
"type": "number"
},
"time_since_last_read": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_since_last_read_millis": {
"description": "The number of milliseconds since a read request was sent to the leader.\nWhen the follower is caught up to the leader, this number will increase up to the configured `read_poll_timeout` at which point another read request will be sent to the leader.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_read_remote_exec_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_read_remote_exec_time_millis": {
"description": "The total time reads spent running on the remote cluster.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_read_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_read_time_millis": {
"description": "The total time reads were outstanding, measured from the time a read was sent to the leader to the time a reply was returned to the follower.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_write_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_write_time_millis": {
"description": "The total time spent writing on the follower.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"write_buffer_operation_count": {
"description": "The number of write operations queued on the follower.",
"type": "number"
},
"write_buffer_size_in_bytes": {
"description": "The total number of bytes of operations currently queued for writing.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
},
"required": [
"bytes_read",
"failed_read_requests",
"failed_write_requests",
"follower_aliases_version",
"follower_global_checkpoint",
"follower_index",
"follower_mapping_version",
"follower_max_seq_no",
"follower_settings_version",
"last_requested_seq_no",
"leader_global_checkpoint",
"leader_index",
"leader_max_seq_no",
"operations_read",
"operations_written",
"outstanding_read_requests",
"outstanding_write_requests",
"read_exceptions",
"remote_cluster",
"shard_id",
"successful_read_requests",
"successful_write_requests",
"time_since_last_read_millis",
"total_read_remote_exec_time_millis",
"total_read_time_millis",
"total_write_time_millis",
"write_buffer_operation_count",
"write_buffer_size_in_bytes"
]
},
"ccr._types.ReadException": {
"type": "object",
"properties": {
"exception": {
"description": "The exception that caused the read to fail.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"from_seq_no": {
"description": "The starting sequence number of the batch requested from the leader.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"retries": {
"description": "The number of times the batch has been retried.",
"type": "number"
}
},
"required": [
"exception",
"from_seq_no",
"retries"
]
},
"ccr.get_auto_follow_pattern.AutoFollowPattern": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"pattern": {
"allOf": [
{
"$ref": "#/components/schemas/ccr.get_auto_follow_pattern.AutoFollowPatternSummary"
}
]
}
},
"required": [
"name",
"pattern"
]
},
"ccr.get_auto_follow_pattern.AutoFollowPatternSummary": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"remote_cluster": {
"description": "The remote cluster containing the leader indices to match against.",
"type": "string"
},
"follow_index_pattern": {
"description": "The name of follower index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexPattern"
}
]
},
"leader_index_patterns": {
"description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexPatterns"
}
]
},
"leader_index_exclusion_patterns": {
"description": "An array of simple index patterns that can be used to exclude indices from being auto-followed.",
"x-state": "Generally available; Added in 7.14.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexPatterns"
}
]
},
"max_outstanding_read_requests": {
"description": "The maximum number of outstanding reads requests from the remote cluster.",
"type": "number"
}
},
"required": [
"active",
"remote_cluster",
"leader_index_patterns",
"leader_index_exclusion_patterns",
"max_outstanding_read_requests"
]
},
"_types.IndexPattern": {
"type": "string"
},
"_types.IndexPatterns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexPattern"
}
},
"ccr.stats.AutoFollowStats": {
"type": "object",
"properties": {
"auto_followed_clusters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ccr.stats.AutoFollowedCluster"
}
},
"number_of_failed_follow_indices": {
"description": "The number of indices that the auto-follow coordinator failed to automatically follow.\nThe causes of recent failures are captured in the logs of the elected master node and in the `auto_follow_stats.recent_auto_follow_errors` field.",
"type": "number"
},
"number_of_failed_remote_cluster_state_requests": {
"description": "The number of times that the auto-follow coordinator failed to retrieve the cluster state from a remote cluster registered in a collection of auto-follow patterns.",
"type": "number"
},
"number_of_successful_follow_indices": {
"description": "The number of indices that the auto-follow coordinator successfully followed.",
"type": "number"
},
"recent_auto_follow_errors": {
"description": "An array of objects representing failures by the auto-follow coordinator.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
}
},
"required": [
"auto_followed_clusters",
"number_of_failed_follow_indices",
"number_of_failed_remote_cluster_state_requests",
"number_of_successful_follow_indices",
"recent_auto_follow_errors"
]
},
"ccr.stats.AutoFollowedCluster": {
"type": "object",
"properties": {
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"last_seen_metadata_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"time_since_last_check_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"cluster_name",
"last_seen_metadata_version",
"time_since_last_check_millis"
]
},
"ccr.stats.FollowStats": {
"type": "object",
"properties": {
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ccr._types.FollowIndexStats"
}
}
},
"required": [
"indices"
]
},
"_types.ScrollIds": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.ScrollId"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ScrollId"
}
}
]
},
"cluster.allocation_explain.Decision": {
"type": "string",
"enum": [
"yes",
"no",
"worse_balance",
"throttled",
"awaiting_info",
"allocation_delayed",
"no_valid_shard_copy",
"no_attempt"
]
},
"cluster.allocation_explain.AllocationDecision": {
"type": "object",
"properties": {
"decider": {
"type": "string"
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.AllocationExplainDecision"
}
]
},
"explanation": {
"type": "string"
}
},
"required": [
"decider",
"decision",
"explanation"
]
},
"cluster.allocation_explain.AllocationExplainDecision": {
"type": "string",
"enum": [
"NO",
"YES",
"THROTTLE",
"ALWAYS"
]
},
"cluster.allocation_explain.ClusterInfo": {
"type": "object",
"properties": {
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster.allocation_explain.NodeDiskUsage"
}
},
"shard_sizes": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"shard_data_set_sizes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"shard_paths": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"reserved_sizes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.allocation_explain.ReservedSize"
}
}
},
"required": [
"nodes",
"shard_sizes",
"shard_paths",
"reserved_sizes"
]
},
"cluster.allocation_explain.NodeDiskUsage": {
"type": "object",
"properties": {
"node_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"least_available": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.DiskUsage"
}
]
},
"most_available": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.DiskUsage"
}
]
}
},
"required": [
"node_name",
"least_available",
"most_available"
]
},
"cluster.allocation_explain.DiskUsage": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"total_bytes": {
"type": "number"
},
"used_bytes": {
"type": "number"
},
"free_bytes": {
"type": "number"
},
"free_disk_percent": {
"type": "number"
},
"used_disk_percent": {
"type": "number"
}
},
"required": [
"path",
"total_bytes",
"used_bytes",
"free_bytes",
"free_disk_percent",
"used_disk_percent"
]
},
"cluster.allocation_explain.ReservedSize": {
"type": "object",
"properties": {
"node_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"path": {
"type": "string"
},
"total": {
"type": "number"
},
"shards": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"node_id",
"path",
"total",
"shards"
]
},
"cluster.allocation_explain.CurrentNode": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"roles": {
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeRoles"
}
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"transport_address": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"weight_ranking": {
"type": "number"
}
},
"required": [
"id",
"name",
"roles",
"attributes",
"transport_address",
"weight_ranking"
]
},
"_types.NodeRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.NodeRole"
}
},
"_types.NodeRole": {
"type": "string",
"enum": [
"master",
"data",
"data_cold",
"data_content",
"data_frozen",
"data_hot",
"data_warm",
"client",
"ingest",
"ml",
"voting_only",
"transform",
"remote_cluster_client",
"coordinating_only"
]
},
"_types.TransportAddress": {
"type": "string"
},
"cluster.allocation_explain.NodeAllocationExplanation": {
"type": "object",
"properties": {
"deciders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.allocation_explain.AllocationDecision"
}
},
"node_attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"node_decision": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.Decision"
}
]
},
"node_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"node_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"roles": {
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeRoles"
}
]
},
"store": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.AllocationStore"
}
]
},
"transport_address": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"weight_ranking": {
"type": "number"
}
},
"required": [
"node_attributes",
"node_decision",
"node_id",
"node_name",
"roles",
"transport_address"
]
},
"cluster.allocation_explain.AllocationStore": {
"type": "object",
"properties": {
"allocation_id": {
"type": "string"
},
"found": {
"type": "boolean"
},
"in_sync": {
"type": "boolean"
},
"matching_size_in_bytes": {
"type": "number"
},
"matching_sync_id": {
"type": "boolean"
},
"store_exception": {
"type": "string"
}
},
"required": [
"allocation_id",
"found",
"in_sync",
"matching_size_in_bytes",
"matching_sync_id",
"store_exception"
]
},
"cluster.allocation_explain.UnassignedInformation": {
"type": "object",
"properties": {
"at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"last_allocation_status": {
"type": "string"
},
"reason": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformationReason"
}
]
},
"details": {
"type": "string"
},
"failed_allocation_attempts": {
"type": "number"
},
"delayed": {
"type": "boolean"
},
"allocation_status": {
"type": "string"
}
},
"required": [
"at",
"reason"
]
},
"cluster.allocation_explain.UnassignedInformationReason": {
"type": "string",
"enum": [
"INDEX_CREATED",
"CLUSTER_RECOVERED",
"INDEX_REOPENED",
"DANGLING_INDEX_IMPORTED",
"NEW_INDEX_RESTORED",
"EXISTING_INDEX_RESTORED",
"REPLICA_ADDED",
"ALLOCATION_FAILED",
"NODE_LEFT",
"REROUTE_CANCELLED",
"REINITIALIZED",
"REALLOCATED_REPLICA",
"PRIMARY_FAILED",
"FORCED_EMPTY_PRIMARY",
"MANUAL_ALLOCATION"
]
},
"cluster._types.ComponentTemplate": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"component_template": {
"allOf": [
{
"$ref": "#/components/schemas/cluster._types.ComponentTemplateNodeWithRollover"
}
]
}
},
"required": [
"name",
"component_template"
]
},
"cluster._types.ComponentTemplateNodeWithRollover": {
"type": "object",
"properties": {
"template": {
"allOf": [
{
"$ref": "#/components/schemas/cluster._types.ComponentTemplateSummaryRes"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"_meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"deprecated": {
"type": "boolean"
},
"created_date": {
"description": "Date and time when the component template was created. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"created_date_millis": {
"description": "Date and time when the component template was created, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"modified_date": {
"description": "Date and time when the component template was last modified. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"modified_date_millis": {
"description": "Date and time when the component template was last modified, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"template"
]
},
"cluster._types.ComponentTemplateSummaryRes": {
"type": "object",
"properties": {
"lifecycle": {
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
}
]
},
"_meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"settings": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"aliases": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.AliasDefinition"
}
},
"data_stream_options": {
"x-state": "Generally available; Added in 8.19.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamOptions"
}
]
}
}
},
"indices._types.DataStreamLifecycleWithRollover": {
"description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycle"
},
{
"type": "object",
"properties": {
"rollover": {
"description": "The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.\nThis property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.\nThe contents of this field are subject to change.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycleRolloverConditions"
}
]
}
}
}
]
},
"indices._types.DataStreamLifecycleRolloverConditions": {
"type": "object",
"properties": {
"min_age": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_age": {
"type": "string"
},
"min_docs": {
"type": "number"
},
"max_docs": {
"type": "number"
},
"min_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"min_primary_shard_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_primary_shard_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"min_primary_shard_docs": {
"type": "number"
},
"max_primary_shard_docs": {
"type": "number"
}
}
},
"indices._types.DataStreamLifecycle": {
"description": "Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.",
"type": "object",
"properties": {
"data_retention": {
"description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"effective_retention": {
"description": "The least amount of time data should be kept by elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"retention_determined_by": {
"description": "Configuration source that can influence the retention of a data stream.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.RetentionSource"
}
]
},
"downsampling": {
"description": "The list of downsampling rounds to execute as part of this downsampling configuration",
"type": "array",
"items": {
"$ref": "#/components/schemas/indices._types.DownsamplingRound"
}
},
"downsampling_method": {
"description": "The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SamplingMethod"
}
]
},
"enabled": {
"description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.",
"default": true,
"type": "boolean"
},
"frozen_after": {
"description": "Only available with feature flag dlm_searchable_snapshots.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"indices._types.RetentionSource": {
"type": "string",
"enum": [
"data_stream_configuration",
"default_global_retention",
"max_global_retention",
"default_failures_retention"
]
},
"indices._types.DownsamplingRound": {
"type": "object",
"properties": {
"after": {
"description": "The duration since rollover when this downsampling round should execute",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"fixed_interval": {
"description": "The downsample interval.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationLarge"
}
]
}
},
"required": [
"after",
"fixed_interval"
]
},
"indices._types.SamplingMethod": {
"type": "string",
"enum": [
"aggregate",
"last_value"
]
},
"_types.mapping.TypeMapping": {
"type": "object",
"properties": {
"all_field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.AllField"
}
]
},
"date_detection": {
"type": "boolean"
},
"dynamic": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DynamicMapping"
}
]
},
"dynamic_date_formats": {
"type": "array",
"items": {
"type": "string"
}
},
"dynamic_templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.DynamicTemplate"
},
"minProperties": 1,
"maxProperties": 1
}
},
"_field_names": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.FieldNamesField"
}
]
},
"index_field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.IndexField"
}
]
},
"_meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"numeric_detection": {
"type": "boolean"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.Property"
}
},
"_routing": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RoutingField"
}
]
},
"_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.SizeField"
}
]
},
"_source": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.SourceField"
}
]
},
"runtime": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.RuntimeField"
}
},
"enabled": {
"type": "boolean"
},
"subobjects": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.Subobjects"
}
]
},
"_data_stream_timestamp": {
"x-state": "Generally available; Added in 7.16.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DataStreamTimestamp"
}
]
}
}
},
"_types.mapping.AllField": {
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"omit_norms": {
"type": "boolean"
},
"search_analyzer": {
"type": "string"
},
"similarity": {
"type": "string"
},
"store": {
"type": "boolean"
},
"store_term_vector_offsets": {
"type": "boolean"
},
"store_term_vector_payloads": {
"type": "boolean"
},
"store_term_vector_positions": {
"type": "boolean"
},
"store_term_vectors": {
"type": "boolean"
}
},
"required": [
"analyzer",
"enabled",
"omit_norms",
"search_analyzer",
"similarity",
"store",
"store_term_vector_offsets",
"store_term_vector_payloads",
"store_term_vector_positions",
"store_term_vectors"
]
},
"_types.mapping.DynamicMapping": {
"type": "string",
"enum": [
"strict",
"runtime",
"true",
"false"
]
},
"_types.mapping.DynamicTemplate": {
"allOf": [
{
"type": "object",
"properties": {
"match": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"path_match": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"unmatch": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"path_unmatch": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"match_mapping_type": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"unmatch_mapping_type": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"match_pattern": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.MatchType"
}
]
}
}
},
{
"type": "object",
"properties": {
"mapping": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.Property"
}
]
},
"runtime": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeField"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"_types.mapping.Property": {
"discriminator": {
"propertyName": "type",
"mapping": {
"aggregate_metric_double": "#/components/schemas/_types.mapping.AggregateMetricDoubleProperty",
"alias": "#/components/schemas/_types.mapping.FieldAliasProperty",
"binary": "#/components/schemas/_types.mapping.BinaryProperty",
"boolean": "#/components/schemas/_types.mapping.BooleanProperty",
"byte": "#/components/schemas/_types.mapping.ByteNumberProperty",
"completion": "#/components/schemas/_types.mapping.CompletionProperty",
"constant_keyword": "#/components/schemas/_types.mapping.ConstantKeywordProperty",
"counted_keyword": "#/components/schemas/_types.mapping.CountedKeywordProperty",
"date": "#/components/schemas/_types.mapping.DateProperty",
"date_nanos": "#/components/schemas/_types.mapping.DateNanosProperty",
"date_range": "#/components/schemas/_types.mapping.DateRangeProperty",
"dense_vector": "#/components/schemas/_types.mapping.DenseVectorProperty",
"double": "#/components/schemas/_types.mapping.DoubleNumberProperty",
"double_range": "#/components/schemas/_types.mapping.DoubleRangeProperty",
"exponential_histogram": "#/components/schemas/_types.mapping.ExponentialHistogramProperty",
"flattened": "#/components/schemas/_types.mapping.FlattenedProperty",
"float": "#/components/schemas/_types.mapping.FloatNumberProperty",
"float_range": "#/components/schemas/_types.mapping.FloatRangeProperty",
"geo_point": "#/components/schemas/_types.mapping.GeoPointProperty",
"geo_shape": "#/components/schemas/_types.mapping.GeoShapeProperty",
"half_float": "#/components/schemas/_types.mapping.HalfFloatNumberProperty",
"histogram": "#/components/schemas/_types.mapping.HistogramProperty",
"icu_collation_keyword": "#/components/schemas/_types.mapping.IcuCollationProperty",
"integer": "#/components/schemas/_types.mapping.IntegerNumberProperty",
"integer_range": "#/components/schemas/_types.mapping.IntegerRangeProperty",
"ip": "#/components/schemas/_types.mapping.IpProperty",
"ip_range": "#/components/schemas/_types.mapping.IpRangeProperty",
"join": "#/components/schemas/_types.mapping.JoinProperty",
"keyword": "#/components/schemas/_types.mapping.KeywordProperty",
"long": "#/components/schemas/_types.mapping.LongNumberProperty",
"long_range": "#/components/schemas/_types.mapping.LongRangeProperty",
"match_only_text": "#/components/schemas/_types.mapping.MatchOnlyTextProperty",
"murmur3": "#/components/schemas/_types.mapping.Murmur3HashProperty",
"nested": "#/components/schemas/_types.mapping.NestedProperty",
"object": "#/components/schemas/_types.mapping.ObjectProperty",
"passthrough": "#/components/schemas/_types.mapping.PassthroughObjectProperty",
"percolator": "#/components/schemas/_types.mapping.PercolatorProperty",
"point": "#/components/schemas/_types.mapping.PointProperty",
"rank_feature": "#/components/schemas/_types.mapping.RankFeatureProperty",
"rank_features": "#/components/schemas/_types.mapping.RankFeaturesProperty",
"rank_vectors": "#/components/schemas/_types.mapping.RankVectorProperty",
"scaled_float": "#/components/schemas/_types.mapping.ScaledFloatNumberProperty",
"search_as_you_type": "#/components/schemas/_types.mapping.SearchAsYouTypeProperty",
"semantic_text": "#/components/schemas/_types.mapping.SemanticTextProperty",
"shape": "#/components/schemas/_types.mapping.ShapeProperty",
"short": "#/components/schemas/_types.mapping.ShortNumberProperty",
"sparse_vector": "#/components/schemas/_types.mapping.SparseVectorProperty",
"text": "#/components/schemas/_types.mapping.TextProperty",
"token_count": "#/components/schemas/_types.mapping.TokenCountProperty",
"unsigned_long": "#/components/schemas/_types.mapping.UnsignedLongNumberProperty",
"version": "#/components/schemas/_types.mapping.VersionProperty",
"wildcard": "#/components/schemas/_types.mapping.WildcardProperty",
"{dynamic_type}": "#/components/schemas/_types.mapping.DynamicProperty"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/_types.mapping.BinaryProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.BooleanProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.DynamicProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.JoinProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.KeywordProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.MatchOnlyTextProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.PercolatorProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.RankFeatureProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.RankFeaturesProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.SearchAsYouTypeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.TextProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.VersionProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.WildcardProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.DateNanosProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.DateProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.AggregateMetricDoubleProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.DenseVectorProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.FlattenedProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.NestedProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.ObjectProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.PassthroughObjectProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.RankVectorProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.SemanticTextProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.SparseVectorProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.CompletionProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.ConstantKeywordProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.CountedKeywordProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.FieldAliasProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.HistogramProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.ExponentialHistogramProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.IpProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.Murmur3HashProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.TokenCountProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.GeoPointProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.GeoShapeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.PointProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.ShapeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.ByteNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.DoubleNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.FloatNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.HalfFloatNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.IntegerNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.LongNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.ScaledFloatNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.ShortNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.UnsignedLongNumberProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.DateRangeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.DoubleRangeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.FloatRangeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.IntegerRangeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.IpRangeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.LongRangeProperty"
},
{
"$ref": "#/components/schemas/_types.mapping.IcuCollationProperty"
}
]
},
"_types.mapping.BinaryProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"binary"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.DocValuesPropertyBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
},
{
"type": "object",
"properties": {
"doc_values": {
"type": "boolean"
}
}
}
]
},
"_types.mapping.CorePropertyBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"copy_to": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"store": {
"type": "boolean"
}
}
}
]
},
"_types.mapping.PropertyBase": {
"type": "object",
"properties": {
"meta": {
"description": "Metadata about the field.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.Property"
}
},
"ignore_above": {
"type": "number"
},
"dynamic": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DynamicMapping"
}
]
},
"fields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.Property"
}
},
"synthetic_source_keep": {
"description": "\n\nSupported values include:\n - `none`: Synthetic source diverges from the original source (default)\n - `arrays`: Arrays of the corresponding field or object preserve the original element ordering and duplicate elements.\nThe synthetic source fragment for such arrays is not guaranteed to match the original source exactly,\ne.g. array [1, 2, [5], [[4, [3]]], 5] may appear as-is or in an equivalent format like [1, 2, 5, 4, 3, 5].\nThe exact format may change in the future, in an effort to reduce the storage overhead of this option.\n - `all`: The source for both singleton instances and arrays of the corresponding field or object gets recorded.\nWhen applied to objects, the source of all sub-objects and sub-fields gets captured.\nFurthermore, the original source of arrays gets captured and appears in synthetic source with no modifications.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.SyntheticSourceKeepEnum"
}
]
}
}
},
"_types.mapping.SyntheticSourceKeepEnum": {
"type": "string",
"enum": [
"none",
"arrays",
"all"
]
},
"_types.mapping.BooleanProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"fielddata": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.NumericFielddata"
}
]
},
"index": {
"type": "boolean"
},
"null_value": {
"type": "boolean"
},
"ignore_malformed": {
"type": "boolean"
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"on_script_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.OnScriptError"
}
]
},
"time_series_dimension": {
"description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
"x-state": "Experimental",
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"boolean"
]
}
},
"required": [
"type"
]
}
]
},
"indices._types.NumericFielddata": {
"type": "object",
"properties": {
"format": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.NumericFielddataFormat"
}
]
}
},
"required": [
"format"
]
},
"indices._types.NumericFielddataFormat": {
"type": "string",
"enum": [
"array",
"disabled"
]
},
"_types.mapping.OnScriptError": {
"type": "string",
"enum": [
"fail",
"continue"
]
},
"_types.mapping.DynamicProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"{dynamic_type}"
]
},
"enabled": {
"type": "boolean"
},
"null_value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
}
]
},
"boost": {
"type": "number"
},
"coerce": {
"type": "boolean"
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"on_script_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.OnScriptError"
}
]
},
"ignore_malformed": {
"type": "boolean"
},
"time_series_metric": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
}
]
},
"analyzer": {
"type": "string"
},
"eager_global_ordinals": {
"type": "boolean"
},
"index": {
"type": "boolean"
},
"index_options": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.IndexOptions"
}
]
},
"index_phrases": {
"type": "boolean"
},
"index_prefixes": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.mapping.TextIndexPrefixes"
},
{
"nullable": true,
"type": "string"
}
]
},
"norms": {
"type": "boolean"
},
"position_increment_gap": {
"type": "number"
},
"search_analyzer": {
"type": "string"
},
"search_quote_analyzer": {
"type": "string"
},
"term_vector": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TermVectorOption"
}
]
},
"format": {
"type": "string"
},
"precision_step": {
"type": "number"
},
"locale": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.TimeSeriesMetricType": {
"type": "string",
"enum": [
"gauge",
"counter",
"summary",
"histogram",
"position"
]
},
"_types.mapping.IndexOptions": {
"type": "string",
"enum": [
"docs",
"freqs",
"positions",
"offsets"
]
},
"_types.mapping.TextIndexPrefixes": {
"type": "object",
"properties": {
"max_chars": {
"type": "number"
},
"min_chars": {
"type": "number"
}
},
"required": [
"max_chars",
"min_chars"
]
},
"_types.mapping.TermVectorOption": {
"type": "string",
"enum": [
"no",
"yes",
"with_offsets",
"with_positions",
"with_positions_offsets",
"with_positions_offsets_payloads",
"with_positions_payloads"
]
},
"_types.mapping.JoinProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"relations": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.RelationName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.RelationName"
}
}
]
}
},
"eager_global_ordinals": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"join"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.KeywordProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"eager_global_ordinals": {
"type": "boolean"
},
"index": {
"type": "boolean"
},
"index_options": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.IndexOptions"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"on_script_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.OnScriptError"
}
]
},
"normalizer": {
"type": "string"
},
"norms": {
"type": "boolean"
},
"null_value": {
"type": "string"
},
"similarity": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"split_queries_on_whitespace": {
"type": "boolean"
},
"time_series_dimension": {
"description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
"x-state": "Experimental",
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"keyword"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.MatchOnlyTextProperty": {
"description": "A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field\neffectively stores data the same way as a text field that only indexes documents (index_options: docs) and\ndisables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries\nthat need positions such as the match_phrase query perform slower as they need to look at the _source document\nto verify whether a phrase matches. All queries return constant scores that are equal to 1.0.",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"match_only_text"
]
},
"fields": {
"description": "Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one\nfield for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.Property"
}
},
"meta": {
"description": "Metadata about the field.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"copy_to": {
"description": "Allows you to copy the values of multiple fields into a group\nfield, which can then be queried as a single field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
}
},
"required": [
"type"
]
},
"_types.mapping.PercolatorProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"percolator"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.RankFeatureProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"positive_score_impact": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"rank_feature"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.RankFeaturesProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"positive_score_impact": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"rank_features"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.SearchAsYouTypeProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"index": {
"type": "boolean"
},
"index_options": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.IndexOptions"
}
]
},
"max_shingle_size": {
"type": "number"
},
"norms": {
"type": "boolean"
},
"search_analyzer": {
"type": "string"
},
"search_quote_analyzer": {
"type": "string"
},
"similarity": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"term_vector": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TermVectorOption"
}
]
},
"type": {
"type": "string",
"enum": [
"search_as_you_type"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.TextProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"eager_global_ordinals": {
"type": "boolean"
},
"fielddata": {
"type": "boolean"
},
"fielddata_frequency_filter": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.FielddataFrequencyFilter"
}
]
},
"index": {
"type": "boolean"
},
"index_options": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.IndexOptions"
}
]
},
"index_phrases": {
"type": "boolean"
},
"index_prefixes": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.mapping.TextIndexPrefixes"
},
{
"nullable": true,
"type": "string"
}
]
},
"norms": {
"type": "boolean"
},
"position_increment_gap": {
"type": "number"
},
"search_analyzer": {
"type": "string"
},
"search_quote_analyzer": {
"type": "string"
},
"similarity": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"term_vector": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TermVectorOption"
}
]
},
"type": {
"type": "string",
"enum": [
"text"
]
}
},
"required": [
"type"
]
}
]
},
"indices._types.FielddataFrequencyFilter": {
"type": "object",
"properties": {
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"min_segment_size": {
"type": "number"
}
},
"required": [
"max",
"min",
"min_segment_size"
]
},
"_types.mapping.VersionProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"version"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.WildcardProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"wildcard"
]
},
"null_value": {
"x-state": "Generally available; Added in 7.15.0",
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.DateNanosProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"format": {
"type": "string"
},
"ignore_malformed": {
"type": "boolean"
},
"index": {
"type": "boolean"
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"on_script_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.OnScriptError"
}
]
},
"null_value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"precision_step": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"date_nanos"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.DateProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"fielddata": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.NumericFielddata"
}
]
},
"format": {
"type": "string"
},
"ignore_malformed": {
"type": "boolean"
},
"index": {
"type": "boolean"
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"on_script_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.OnScriptError"
}
]
},
"null_value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"precision_step": {
"type": "number"
},
"locale": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"date"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.AggregateMetricDoubleProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"aggregate_metric_double"
]
},
"default_metric": {
"type": "string"
},
"ignore_malformed": {
"type": "boolean"
},
"metrics": {
"type": "array",
"items": {
"type": "string"
}
},
"time_series_metric": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
}
]
}
},
"required": [
"type",
"default_metric",
"metrics"
]
}
]
},
"_types.mapping.DenseVectorProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dense_vector"
]
},
"dims": {
"description": "Number of vector dimensions. Can't exceed `4096`. If `dims` is not specified, it will be set to the length of\nthe first vector added to the field.",
"type": "number"
},
"element_type": {
"description": "The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`.\n\nSupported values include:\n - `bit`: Indexes a single bit per dimension. Useful for very high-dimensional vectors or models that specifically support\nbit vectors.\n\nNOTE: when using `bit`, the number of dimensions must be a multiple of `8` and must represent the number of bits.\n - `byte`: Indexes a 1-byte integer value per dimension.\n - `float`: Indexes a 4-byte floating-point value per dimension.\n - `bfloat16`: Indexes a 2-byte floating-point value per dimension.\n\n",
"default": "float",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DenseVectorElementType"
}
]
},
"index": {
"description": "If `true`, you can search this field using the kNN search API.",
"default": true,
"type": "boolean"
},
"index_options": {
"description": "An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters\nthat influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the\nexpense of slower indexing speed.\n\nThis parameter can only be specified when `index` is `true`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions"
}
]
},
"similarity": {
"description": "The vector similarity metric to use in kNN search.\n\nDocuments are ranked by their vector field's similarity to the query vector. The `_score` of each document will\nbe derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds\nto a higher ranking.\n\nDefaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`.\n\n`bit` vectors only support `l2_norm` as their similarity metric.\n\nThis parameter can only be specified when `index` is `true`.\n\nSupported values include:\n - `cosine`: Computes the cosine similarity. During indexing Elasticsearch automatically normalizes vectors with `cosine`\nsimilarity to unit length. This allows to internally use `dot_product` for computing similarity, which is more\nefficient. Original un-normalized vectors can be still accessed through scripts.\n\nThe document `_score` is computed as `(1 + cosine(query, vector)) / 2`.\n\nThe `cosine` similarity does not allow vectors with zero magnitude, since cosine is not defined in this case.\n - `dot_product`: Computes the dot product of two unit vectors. This option provides an optimized way to perform cosine similarity.\nThe constraints and computed score are defined by `element_type`.\n\nWhen `element_type` is `float`, all vectors must be unit length, including both document and query vectors.\n\nThe document `_score` is computed as `(1 + dot_product(query, vector)) / 2`.\n\nWhen `element_type` is `byte`, all vectors must have the same length including both document and query vectors or\nresults will be inaccurate.\n\nThe document `_score` is computed as `0.5 + (dot_product(query, vector) / (32768 * dims))` where `dims` is the\nnumber of dimensions per vector.\n - `l2_norm`: Computes similarity based on the `L2` distance (also known as Euclidean distance) between the vectors.\n\nThe document `_score` is computed as `1 / (1 + l2_norm(query, vector)^2)`.\n\nFor `bit` vectors, instead of using `l2_norm`, the `hamming` distance between the vectors is used.\n\nThe `_score` transformation is `(numBits - hamming(a, b)) / numBits`.\n - `max_inner_product`: Computes the maximum inner product of two vectors. This is similar to `dot_product`, but doesn't require vectors\nto be normalized. This means that each vector’s magnitude can significantly effect the score.\n\nThe document `_score` is adjusted to prevent negative values. For `max_inner_product` values `< 0`, the `_score`\nis `1 / (1 + -1 * max_inner_product(query, vector))`. For non-negative `max_inner_product` results the `_score`\nis calculated `max_inner_product(query, vector) + 1`.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DenseVectorSimilarity"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.DenseVectorElementType": {
"type": "string",
"enum": [
"bit",
"byte",
"float",
"bfloat16"
]
},
"_types.mapping.DenseVectorIndexOptions": {
"type": "object",
"properties": {
"confidence_interval": {
"description": "The confidence interval to use when quantizing the vectors. Can be any value between and including `0.90` and\n`1.0` or exactly `0`. When the value is `0`, this indicates that dynamic quantiles should be calculated for\noptimized quantization. When between `0.90` and `1.0`, this value restricts the values used when calculating\nthe quantization thresholds.\n\nFor example, a value of `0.95` will only use the middle `95%` of the values when calculating the quantization\nthresholds (e.g. the highest and lowest `2.5%` of values will be ignored).\n\nDefaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4` for dynamic quantile calculation.\n\nOnly applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat` index types.",
"type": "number"
},
"ef_construction": {
"description": "The number of candidates to track while assembling the list of nearest neighbors for each new node.\n\nOnly applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types.",
"default": 100,
"type": "number"
},
"m": {
"description": "The number of neighbors each node will be connected to in the HNSW graph.\n\nOnly applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types.",
"default": 16,
"type": "number"
},
"type": {
"description": "The type of kNN algorithm to use.\n\nSupported values include:\n - `bbq_flat`: This utilizes a brute-force search algorithm in addition to automatically quantizing to binary vectors.\nOnly supports `element_type` of `float`.\n - `bbq_hnsw`: This utilizes the HNSW algorithm in addition to automatic binary quantization for scalable approximate kNN\nsearch with `element_type` of `float`.\n\nThis can reduce the memory footprint by nearly 32x at the cost of some accuracy.\n - `bbq_disk`: This utilizes the DiskBBQ algorithm, a version of Inverted Vector File (IVF) that uses BBQ to quantize vectors.\nOnly supports `element_type` of `float`.\n\nThis not only significantly reduces memory usage, but also allows for indexing and searching of very large datasets that do not fit in memory.\nUnlike HNSW, this index type loses performance gracefully as the index grows larger than memory.\n - `flat`: This utilizes a brute-force search algorithm for exact kNN search. This supports all `element_type` values.\n - `hnsw`: This utilizes the HNSW algorithm for scalable approximate kNN search. This supports all `element_type` values.\n - `int4_flat`: This utilizes a brute-force search algorithm in addition to automatically half-byte scalar quantization.\nOnly supports `element_type` of `float`.\n - `int4_hnsw`: This utilizes the HNSW algorithm in addition to automatically scalar quantization for scalable approximate kNN\nsearch with `element_type` of `float`.\n\nThis can reduce the memory footprint by 8x at the cost of some accuracy.\n - `int8_flat`: This utilizes a brute-force search algorithm in addition to automatically scalar quantization. Only supports\n`element_type` of `float`.\n - `int8_hnsw`: The default index type for `float` vectors. This utilizes the HNSW algorithm in addition to automatically scalar\nquantization for scalable approximate kNN search with `element_type` of `float`.\n\nThis can reduce the memory footprint by 4x at the cost of some accuracy.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsType"
}
]
},
"rescore_vector": {
"description": "The rescore vector options. This is only applicable to `bbq_disk`, `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`, `bbq_flat`, `int4_flat`, and `int8_flat` index types.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsRescoreVector"
}
]
},
"on_disk_rescore": {
"description": "`true` if vector rescoring should be done on-disk\n\nOnly applicable to `bbq_disk`, `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`",
"default": false,
"x-state": "Experimental; Added in 9.3.0",
"type": "boolean"
},
"flat_index_threshold": {
"description": "The segment document count threshold below which HNSW graph construction is skipped in favor of brute-force flat\nsearch. `-1` (default) defers to format defaults: `300` for `bbq_hnsw`, `150` for `hnsw`, `int8_hnsw`, and\n`int4_hnsw`. `0` always builds the graph. A positive value overrides the format default.\n\nOnly applicable to `hnsw`, `int8_hnsw`, `int4_hnsw`, and `bbq_hnsw` index types.",
"default": -1,
"x-state": "Generally available; Added in 9.4.0",
"type": "number"
}
},
"required": [
"type"
]
},
"_types.mapping.DenseVectorIndexOptionsType": {
"type": "string",
"enum": [
"bbq_flat",
"bbq_hnsw",
"bbq_disk",
"flat",
"hnsw",
"int4_flat",
"int4_hnsw",
"int8_flat",
"int8_hnsw"
]
},
"_types.mapping.DenseVectorIndexOptionsRescoreVector": {
"type": "object",
"properties": {
"oversample": {
"description": "The oversampling factor to use when searching for the nearest neighbor. This is only applicable to the quantized formats: `bbq_*`, `int4_*`, and `int8_*`.\nWhen provided, `oversample * k` vectors will be gathered and then their scores will be re-computed with the original vectors.\n\nvalid values are between `1.0` and `10.0` (inclusive), or `0` exactly to disable oversampling.",
"type": "number"
}
},
"required": [
"oversample"
]
},
"_types.mapping.DenseVectorSimilarity": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm",
"max_inner_product"
]
},
"_types.mapping.FlattenedProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"depth_limit": {
"type": "number"
},
"doc_values": {
"type": "boolean"
},
"eager_global_ordinals": {
"type": "boolean"
},
"index": {
"type": "boolean"
},
"index_options": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.IndexOptions"
}
]
},
"null_value": {
"type": "string"
},
"similarity": {
"type": "string"
},
"split_queries_on_whitespace": {
"type": "boolean"
},
"time_series_dimensions": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"enum": [
"flattened"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.NestedProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"include_in_parent": {
"type": "boolean"
},
"include_in_root": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"nested"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.ObjectProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"subobjects": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.Subobjects"
}
]
},
"type": {
"type": "string",
"enum": [
"object"
]
}
}
}
]
},
"_types.mapping.Subobjects": {
"type": "string",
"enum": [
"true",
"false"
]
},
"_types.mapping.PassthroughObjectProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"passthrough"
]
},
"enabled": {
"type": "boolean"
},
"priority": {
"type": "number"
},
"time_series_dimension": {
"type": "boolean"
}
}
}
]
},
"_types.mapping.RankVectorProperty": {
"description": "Technical preview",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"rank_vectors"
]
},
"element_type": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RankVectorElementType"
}
]
},
"dims": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.RankVectorElementType": {
"type": "string",
"enum": [
"byte",
"float",
"bit"
]
},
"_types.mapping.SemanticTextProperty": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"semantic_text"
]
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"inference_id": {
"description": "Inference endpoint that will be used to generate embeddings for the field.\nThis parameter cannot be updated. Use the Create inference API to create the endpoint.\nIf `search_inference_id` is specified, the inference endpoint will only be used at index time.",
"default": ".elser-2-elasticsearch",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"search_inference_id": {
"description": "Inference endpoint that will be used to generate embeddings at query time.\nYou can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint.\nIf not specified, the inference endpoint defined by inference_id will be used at both index and query time.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"index_options": {
"description": "Settings for index_options that override any defaults used by semantic_text, for example\nspecific quantization settings.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.SemanticTextIndexOptions"
}
]
},
"chunking_settings": {
"description": "Settings for chunking text into smaller passages. If specified, these will override the\nchunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated,\nthey will not be applied to existing documents until they are reindexed.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.mapping.ChunkingSettings"
},
{
"nullable": true,
"type": "string"
}
]
},
"fields": {
"description": "Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one\nfield for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.Property"
}
}
},
"required": [
"type"
]
},
"_types.mapping.SemanticTextIndexOptions": {
"type": "object",
"properties": {
"dense_vector": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions"
}
]
},
"sparse_vector": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.SparseVectorIndexOptions"
}
]
}
}
},
"_types.mapping.SparseVectorIndexOptions": {
"type": "object",
"properties": {
"prune": {
"description": "Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.\nIf prune is true but the pruning_config is not specified, pruning will occur but default values will be used.\nDefault: false",
"x-state": "Generally available; Added in 8.19.0",
"type": "boolean"
},
"pruning_config": {
"description": "Optional pruning configuration.\nIf enabled, this will omit non-significant tokens from the query in order to improve query performance.\nThis is only used if prune is set to true.\nIf prune is set to true but pruning_config is not specified, default values will be used.",
"x-state": "Generally available; Added in 8.19.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.TokenPruningConfig"
}
]
}
}
},
"_types.mapping.ChunkingSettings": {
"type": "object",
"properties": {
"strategy": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies"
},
"description": "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation.",
"default": "sentence",
"type": "string"
},
"max_chunk_size": {
"description": "The maximum size of a chunk in words.\nThis value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).\nThis value should not exceed the window size for the associated model.",
"default": 250,
"type": "number"
},
"overlap": {
"description": "The number of overlapping words for chunks.\nIt is applicable only to a `word` chunking strategy.\nThis value cannot be higher than half the `max_chunk_size` value.",
"default": 100,
"type": "number"
},
"sentence_overlap": {
"description": "The number of overlapping sentences for chunks.\nIt is applicable only for a `sentence` chunking strategy.\nIt can be either `1` or `0`.",
"default": 1,
"type": "number"
},
"separator_group": {
"description": "Only applicable to the `recursive` strategy and required when using it.\n\nSets a predefined list of separators in the saved chunking settings based on the selected text type.\nValues can be `markdown` or `plaintext`.\n\nUsing this parameter is an alternative to manually specifying a custom `separators` list.",
"type": "string"
},
"separators": {
"description": "Only applicable to the `recursive` strategy and required when using it.\n\nA list of strings used as possible split points when chunking text.\n\nEach string can be a plain string or a regular expression (regex) pattern.\nThe system tries each separator in order to split the text, starting from the first item in the list.\n\nAfter splitting, it attempts to recombine smaller pieces into larger chunks that stay within\nthe `max_chunk_size` limit, to reduce the total number of chunks generated.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"strategy",
"max_chunk_size"
]
},
"_types.mapping.SparseVectorProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"store": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"sparse_vector"
]
},
"index_options": {
"description": "Additional index options for the sparse vector field that controls the\ntoken pruning behavior of the sparse vector field.",
"x-state": "Generally available; Added in 8.19.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.SparseVectorIndexOptions"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.CompletionProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.mapping.SuggestContext"
}
},
"max_input_length": {
"type": "number"
},
"preserve_position_increments": {
"type": "boolean"
},
"preserve_separators": {
"type": "boolean"
},
"search_analyzer": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"completion"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.SuggestContext": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"path": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"type": {
"type": "string"
},
"precision": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"type"
]
},
"_types.mapping.ConstantKeywordProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"value": {
"type": "object"
},
"type": {
"type": "string",
"enum": [
"constant_keyword"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.CountedKeywordProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"counted_keyword"
]
},
"index": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.FieldAliasProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"path": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"type": {
"type": "string",
"enum": [
"alias"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.HistogramProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"ignore_malformed": {
"type": "boolean"
},
"time_series_metric": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
}
]
},
"type": {
"type": "string",
"enum": [
"histogram"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.ExponentialHistogramProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.PropertyBase"
},
{
"type": "object",
"properties": {
"time_series_metric": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
}
]
},
"type": {
"type": "string",
"enum": [
"exponential_histogram"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.IpProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"index": {
"type": "boolean"
},
"ignore_malformed": {
"type": "boolean"
},
"null_value": {
"type": "string"
},
"on_script_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.OnScriptError"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"time_series_dimension": {
"description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
"x-state": "Experimental",
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"ip"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.Murmur3HashProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"murmur3"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.TokenCountProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"boost": {
"type": "number"
},
"index": {
"type": "boolean"
},
"null_value": {
"type": "number"
},
"enable_position_increments": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"token_count"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.GeoPointProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"ignore_malformed": {
"type": "boolean"
},
"ignore_z_value": {
"type": "boolean"
},
"null_value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoLocation"
}
]
},
"index": {
"type": "boolean"
},
"on_script_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.OnScriptError"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"type": {
"type": "string",
"enum": [
"geo_point"
]
},
"time_series_metric": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.GeoPointMetricType"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.GeoPointMetricType": {
"type": "string",
"enum": [
"gauge",
"counter",
"position"
]
},
"_types.mapping.GeoShapeProperty": {
"description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"coerce": {
"type": "boolean"
},
"ignore_malformed": {
"type": "boolean"
},
"ignore_z_value": {
"type": "boolean"
},
"index": {
"type": "boolean"
},
"orientation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.GeoOrientation"
}
]
},
"strategy": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.GeoStrategy"
}
]
},
"type": {
"type": "string",
"enum": [
"geo_shape"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.GeoOrientation": {
"type": "string",
"enum": [
"right",
"RIGHT",
"counterclockwise",
"ccw",
"left",
"LEFT",
"clockwise",
"cw"
]
},
"_types.mapping.GeoStrategy": {
"type": "string",
"enum": [
"recursive",
"term"
]
},
"_types.mapping.PointProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"ignore_malformed": {
"type": "boolean"
},
"ignore_z_value": {
"type": "boolean"
},
"null_value": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"point"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.ShapeProperty": {
"description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"coerce": {
"type": "boolean"
},
"ignore_malformed": {
"type": "boolean"
},
"ignore_z_value": {
"type": "boolean"
},
"orientation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.GeoOrientation"
}
]
},
"type": {
"type": "string",
"enum": [
"shape"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.ByteNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"byte"
]
},
"null_value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.byte"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.byte": {
"type": "number"
},
"_types.mapping.NumberPropertyBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"coerce": {
"type": "boolean"
},
"ignore_malformed": {
"type": "boolean"
},
"index": {
"type": "boolean"
},
"on_script_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.OnScriptError"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"time_series_metric": {
"description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
"x-state": "Experimental",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
}
]
},
"time_series_dimension": {
"description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
"default": false,
"x-state": "Experimental",
"type": "boolean"
}
}
}
]
},
"_types.mapping.DoubleNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"double"
]
},
"null_value": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.FloatNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"float"
]
},
"null_value": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.HalfFloatNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"half_float"
]
},
"null_value": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.IntegerNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"integer"
]
},
"null_value": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.LongNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"long"
]
},
"null_value": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.ScaledFloatNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"scaled_float"
]
},
"null_value": {
"type": "number"
},
"scaling_factor": {
"type": "number"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.ShortNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"short"
]
},
"null_value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.short"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.short": {
"type": "number"
},
"_types.mapping.UnsignedLongNumberProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"unsigned_long"
]
},
"null_value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ulong"
}
]
}
},
"required": [
"type"
]
}
]
},
"_types.ulong": {
"type": "number"
},
"_types.mapping.DateRangeProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
},
{
"type": "object",
"properties": {
"format": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"date_range"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.RangePropertyBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"coerce": {
"type": "boolean"
},
"index": {
"type": "boolean"
}
}
}
]
},
"_types.mapping.DoubleRangeProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"double_range"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.FloatRangeProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"float_range"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.IntegerRangeProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"integer_range"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.IpRangeProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ip_range"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.LongRangeProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"long_range"
]
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.IcuCollationProperty": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"icu_collation_keyword"
]
},
"norms": {
"type": "boolean"
},
"index_options": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.IndexOptions"
}
]
},
"index": {
"description": "Should the field be searchable?",
"type": "boolean"
},
"null_value": {
"description": "Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing.",
"type": "string"
},
"rules": {
"type": "string"
},
"language": {
"type": "string"
},
"country": {
"type": "string"
},
"variant": {
"type": "string"
},
"strength": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationStrength"
}
]
},
"decomposition": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition"
}
]
},
"alternate": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate"
}
]
},
"case_level": {
"type": "boolean"
},
"case_first": {
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst"
}
]
},
"numeric": {
"type": "boolean"
},
"variable_top": {
"type": "string"
},
"hiragana_quaternary_mode": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"_types.mapping.MatchType": {
"type": "string",
"enum": [
"simple",
"regex"
]
},
"_types.mapping.FieldNamesField": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"_types.mapping.IndexField": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"_types.mapping.RoutingField": {
"type": "object",
"properties": {
"required": {
"type": "boolean"
}
},
"required": [
"required"
]
},
"_types.mapping.SizeField": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"_types.mapping.SourceField": {
"type": "object",
"properties": {
"compress": {
"type": "boolean"
},
"compress_threshold": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"excludes": {
"type": "array",
"items": {
"type": "string"
}
},
"includes": {
"type": "array",
"items": {
"type": "string"
}
},
"mode": {
"description": "\n\nSupported values include:\n - `disabled`\n - `stored`\n - `synthetic`: Instead of storing source documents on disk exactly as you send them,\n Elasticsearch can reconstruct source content on the fly upon retrieval.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.SourceFieldMode"
}
]
}
}
},
"_types.mapping.SourceFieldMode": {
"type": "string",
"enum": [
"disabled",
"stored",
"synthetic"
]
},
"_types.mapping.DataStreamTimestamp": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"indices._types.AliasDefinition": {
"type": "object",
"properties": {
"filter": {
"description": "Query used to limit documents the alias can access.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"index_routing": {
"description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.",
"type": "string"
},
"is_write_index": {
"description": "If `true`, the index is the write index for the alias.",
"default": false,
"type": "boolean"
},
"routing": {
"description": "Value used to route indexing and search operations to a specific shard.",
"type": "string"
},
"search_routing": {
"description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.",
"type": "string"
},
"is_hidden": {
"description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.",
"default": false,
"x-state": "Generally available; Added in 7.16.0",
"type": "boolean"
}
}
},
"indices._types.DataStreamOptions": {
"description": "Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration.",
"type": "object",
"properties": {
"failure_store": {
"description": "If defined, it specifies configuration for the failure store of this data stream.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamFailureStore"
}
]
}
}
},
"indices._types.DataStreamFailureStore": {
"description": "Data stream failure store contains the configuration of the failure store for a given data stream.",
"type": "object",
"properties": {
"enabled": {
"description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.",
"default": true,
"type": "boolean"
},
"lifecycle": {
"description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.FailureStoreLifecycle"
}
]
}
}
},
"indices._types.FailureStoreLifecycle": {
"description": "The failure store lifecycle configures the data stream lifecycle configuration for failure indices.",
"type": "object",
"properties": {
"data_retention": {
"description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"enabled": {
"description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.",
"default": true,
"type": "boolean"
}
}
},
"_types.Level": {
"type": "string",
"enum": [
"cluster",
"indices",
"shards"
]
},
"_types.WaitForEvents": {
"type": "string",
"enum": [
"immediate",
"urgent",
"high",
"normal",
"low",
"languid"
]
},
"cluster.health.WaitForNodes": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"cluster.health.HealthResponseBody": {
"type": "object",
"properties": {
"active_primary_shards": {
"description": "The number of active primary shards.",
"type": "number"
},
"active_shards": {
"description": "The total number of active primary and replica shards.",
"type": "number"
},
"active_shards_percent": {
"description": "The ratio of active shards in the cluster expressed as a string formatted percentage.",
"type": "string"
},
"active_shards_percent_as_number": {
"description": "The ratio of active shards in the cluster expressed as a percentage.",
"type": "number"
},
"cluster_name": {
"description": "The name of the cluster.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"delayed_unassigned_shards": {
"description": "The number of shards whose allocation has been delayed by the timeout settings.",
"type": "number"
},
"indices": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster.health.IndexHealthStats"
}
},
"initializing_shards": {
"description": "The number of shards that are under initialization.",
"type": "number"
},
"number_of_data_nodes": {
"description": "The number of nodes that are dedicated data nodes.",
"type": "number"
},
"number_of_in_flight_fetch": {
"description": "The number of unfinished fetches.",
"type": "number"
},
"number_of_nodes": {
"description": "The number of nodes within the cluster.",
"type": "number"
},
"number_of_pending_tasks": {
"description": "The number of cluster-level changes that have not yet been executed.",
"type": "number"
},
"relocating_shards": {
"description": "The number of shards that are under relocation.",
"type": "number"
},
"status": {
"description": "\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",
"allOf": [
{
"$ref": "#/components/schemas/_types.HealthStatus"
}
]
},
"task_max_waiting_in_queue": {
"description": "The time since the earliest initiated task is waiting for being performed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"task_max_waiting_in_queue_millis": {
"description": "The time expressed in milliseconds since the earliest initiated task is waiting for being performed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"timed_out": {
"description": "If false the response returned within the period of time that is specified by the timeout parameter (30s by default)",
"type": "boolean"
},
"unassigned_primary_shards": {
"description": "The number of primary shards that are not allocated.",
"type": "number"
},
"unassigned_shards": {
"description": "The number of shards that are not allocated.",
"type": "number"
}
},
"required": [
"active_primary_shards",
"active_shards",
"active_shards_percent_as_number",
"cluster_name",
"delayed_unassigned_shards",
"initializing_shards",
"number_of_data_nodes",
"number_of_in_flight_fetch",
"number_of_nodes",
"number_of_pending_tasks",
"relocating_shards",
"status",
"task_max_waiting_in_queue_millis",
"timed_out",
"unassigned_primary_shards",
"unassigned_shards"
]
},
"cluster.health.IndexHealthStats": {
"type": "object",
"properties": {
"active_primary_shards": {
"type": "number"
},
"active_shards": {
"type": "number"
},
"initializing_shards": {
"type": "number"
},
"number_of_replicas": {
"type": "number"
},
"number_of_shards": {
"type": "number"
},
"relocating_shards": {
"type": "number"
},
"shards": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster.health.ShardHealthStats"
}
},
"status": {
"description": "\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",
"allOf": [
{
"$ref": "#/components/schemas/_types.HealthStatus"
}
]
},
"unassigned_shards": {
"type": "number"
},
"unassigned_primary_shards": {
"type": "number"
}
},
"required": [
"active_primary_shards",
"active_shards",
"initializing_shards",
"number_of_replicas",
"number_of_shards",
"relocating_shards",
"status",
"unassigned_shards",
"unassigned_primary_shards"
]
},
"cluster.health.ShardHealthStats": {
"type": "object",
"properties": {
"active_shards": {
"type": "number"
},
"initializing_shards": {
"type": "number"
},
"primary_active": {
"type": "boolean"
},
"relocating_shards": {
"type": "number"
},
"status": {
"description": "\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",
"allOf": [
{
"$ref": "#/components/schemas/_types.HealthStatus"
}
]
},
"unassigned_shards": {
"type": "number"
},
"unassigned_primary_shards": {
"type": "number"
}
},
"required": [
"active_shards",
"initializing_shards",
"primary_active",
"relocating_shards",
"status",
"unassigned_shards",
"unassigned_primary_shards"
]
},
"_types.ClusterInfoTargets": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.ClusterInfoTarget"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ClusterInfoTarget"
}
}
]
},
"_types.ClusterInfoTarget": {
"type": "string",
"enum": [
"_all",
"http",
"ingest",
"thread_pool",
"script"
]
},
"nodes._types.Http": {
"type": "object",
"properties": {
"current_open": {
"description": "Current number of open HTTP connections for the node.",
"type": "number"
},
"total_opened": {
"description": "Total number of HTTP connections opened for the node.",
"type": "number"
},
"clients": {
"description": "Information on current and recently-closed HTTP client connections.\nClients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here.",
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.Client"
}
},
"routes": {
"description": "Detailed HTTP stats broken down by route",
"x-state": "Generally available; Added in 8.12.0",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.HttpRoute"
}
}
},
"required": [
"routes"
]
},
"nodes._types.Client": {
"type": "object",
"properties": {
"id": {
"description": "Unique ID for the HTTP client.",
"type": "number"
},
"agent": {
"description": "Reported agent for the HTTP client.\nIf unavailable, this property is not included in the response.",
"type": "string"
},
"local_address": {
"description": "Local address for the HTTP connection.",
"type": "string"
},
"remote_address": {
"description": "Remote address for the HTTP connection.",
"type": "string"
},
"last_uri": {
"description": "The URI of the client’s most recent request.",
"type": "string"
},
"opened_time_millis": {
"description": "Time at which the client opened the connection.",
"type": "number"
},
"closed_time_millis": {
"description": "Time at which the client closed the connection if the connection is closed.",
"type": "number"
},
"last_request_time_millis": {
"description": "Time of the most recent request from this client.",
"type": "number"
},
"request_count": {
"description": "Number of requests from this client.",
"type": "number"
},
"request_size_bytes": {
"description": "Cumulative size in bytes of all requests from this client.",
"type": "number"
},
"x_opaque_id": {
"description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.",
"type": "string"
}
}
},
"nodes._types.HttpRoute": {
"type": "object",
"properties": {
"requests": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.HttpRouteRequests"
}
]
},
"responses": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.HttpRouteResponses"
}
]
}
},
"required": [
"requests",
"responses"
]
},
"nodes._types.HttpRouteRequests": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total_size_in_bytes": {
"type": "number"
},
"size_histogram": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.SizeHttpHistogram"
}
}
},
"required": [
"count",
"total_size_in_bytes",
"size_histogram"
]
},
"nodes._types.SizeHttpHistogram": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"ge_bytes": {
"type": "number"
},
"lt_bytes": {
"type": "number"
}
},
"required": [
"count"
]
},
"nodes._types.HttpRouteResponses": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total_size_in_bytes": {
"type": "number"
},
"handling_time_histogram": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.TimeHttpHistogram"
}
},
"size_histogram": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.SizeHttpHistogram"
}
}
},
"required": [
"count",
"total_size_in_bytes",
"handling_time_histogram",
"size_histogram"
]
},
"nodes._types.TimeHttpHistogram": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"ge_millis": {
"type": "number"
},
"lt_millis": {
"type": "number"
}
},
"required": [
"count"
]
},
"nodes._types.Ingest": {
"type": "object",
"properties": {
"pipelines": {
"description": "Contains statistics about ingest pipelines for the node.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.IngestStats"
}
},
"total": {
"description": "Contains statistics about ingest operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.IngestTotal"
}
]
}
}
},
"nodes._types.IngestStats": {
"type": "object",
"properties": {
"count": {
"description": "Total number of documents ingested during the lifetime of this node.",
"type": "number"
},
"current": {
"description": "Total number of documents currently being ingested.",
"type": "number"
},
"failed": {
"description": "Total number of failed ingest operations during the lifetime of this node.",
"type": "number"
},
"processors": {
"description": "Total number of ingest processors.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.KeyedProcessor"
}
}
},
"time_in_millis": {
"description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"ingested_as_first_pipeline_in_bytes": {
"description": "Total number of bytes of all documents ingested by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.",
"x-state": "Generally available; Added in 8.15.0",
"type": "number"
},
"produced_as_first_pipeline_in_bytes": {
"description": "Total number of bytes of all documents produced by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.\nIn situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.",
"x-state": "Generally available; Added in 8.15.0",
"type": "number"
}
},
"required": [
"count",
"current",
"failed",
"processors",
"time_in_millis",
"ingested_as_first_pipeline_in_bytes",
"produced_as_first_pipeline_in_bytes"
]
},
"nodes._types.KeyedProcessor": {
"type": "object",
"properties": {
"stats": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Processor"
}
]
},
"type": {
"type": "string"
}
}
},
"nodes._types.Processor": {
"type": "object",
"properties": {
"count": {
"description": "Number of documents transformed by the processor.",
"type": "number"
},
"current": {
"description": "Number of documents currently being transformed by the processor.",
"type": "number"
},
"failed": {
"description": "Number of failed operations for the processor.",
"type": "number"
},
"time_in_millis": {
"description": "Time, in milliseconds, spent by the processor transforming documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
}
},
"nodes._types.IngestTotal": {
"type": "object",
"properties": {
"count": {
"description": "Total number of documents ingested during the lifetime of this node.",
"type": "number"
},
"current": {
"description": "Total number of documents currently being ingested.",
"type": "number"
},
"failed": {
"description": "Total number of failed ingest operations during the lifetime of this node.",
"type": "number"
},
"time_in_millis": {
"description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"count",
"current",
"failed",
"time_in_millis"
]
},
"nodes._types.ThreadCount": {
"type": "object",
"properties": {
"active": {
"description": "Number of active threads in the thread pool.",
"type": "number"
},
"completed": {
"description": "Number of tasks completed by the thread pool executor.",
"type": "number"
},
"largest": {
"description": "Highest number of active threads in the thread pool.",
"type": "number"
},
"queue": {
"description": "Number of tasks in queue for the thread pool.",
"type": "number"
},
"rejected": {
"description": "Number of tasks rejected by the thread pool executor.",
"type": "number"
},
"threads": {
"description": "Number of threads in the thread pool.",
"type": "number"
}
}
},
"nodes._types.Scripting": {
"type": "object",
"properties": {
"cache_evictions": {
"description": "Total number of times the script cache has evicted old data.",
"type": "number"
},
"compilations": {
"description": "Total number of inline script compilations performed by the node.",
"type": "number"
},
"compilations_history": {
"description": "Contains this recent history of script compilations.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"compilation_limit_triggered": {
"description": "Total number of times the script compilation circuit breaker has limited inline script compilations.",
"type": "number"
},
"contexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.Context"
}
}
}
},
"nodes._types.Context": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"compilations": {
"type": "number"
},
"cache_evictions": {
"type": "number"
},
"compilation_limit_triggered": {
"type": "number"
}
}
},
"cluster.pending_tasks.PendingTask": {
"type": "object",
"properties": {
"executing": {
"description": "Indicates whether the pending tasks are currently executing or not.",
"type": "boolean"
},
"insert_order": {
"description": "The number that represents when the task has been inserted into the task queue.",
"type": "number"
},
"priority": {
"description": "The priority of the pending task.\nThe valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`.",
"type": "string"
},
"source": {
"description": "A general description of the cluster task that may include a reason and origin.",
"type": "string"
},
"time_in_queue": {
"description": "The time since the task is waiting for being performed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_in_queue_millis": {
"description": "The time expressed in milliseconds since the task is waiting for being performed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"executing",
"insert_order",
"priority",
"source",
"time_in_queue_millis"
]
},
"indices.put_index_template.IndexTemplateMapping": {
"type": "object",
"properties": {
"aliases": {
"description": "Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"mappings": {
"description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"settings": {
"description": "Configuration options for the index.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"lifecycle": {
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycle"
}
]
},
"data_stream_options": {
"x-state": "Generally available; Added in 8.19.0",
"oneOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamOptionsTemplate"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"indices._types.Alias": {
"type": "object",
"properties": {
"filter": {
"description": "Query used to limit documents the alias can access.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"index_routing": {
"description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.",
"type": "string"
},
"is_hidden": {
"description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.",
"default": false,
"type": "boolean"
},
"is_write_index": {
"description": "If `true`, the index is the write index for the alias.",
"default": false,
"type": "boolean"
},
"routing": {
"description": "Value used to route indexing and search operations to a specific shard.",
"type": "string"
},
"search_routing": {
"description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.",
"type": "string"
}
}
},
"indices._types.DataStreamOptionsTemplate": {
"description": "Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.",
"type": "object",
"properties": {
"failure_store": {
"oneOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamFailureStoreTemplate"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"indices._types.DataStreamFailureStoreTemplate": {
"description": "Template equivalent of DataStreamFailureStore that allows nullable values.",
"type": "object",
"properties": {
"enabled": {
"description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.",
"default": "true",
"oneOf": [
{
"type": "boolean"
},
{
"nullable": true,
"type": "string"
}
]
},
"lifecycle": {
"description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.",
"oneOf": [
{
"$ref": "#/components/schemas/indices._types.FailureStoreLifecycleTemplate"
},
{
"nullable": true,
"type": "string"
}
]
}
}
},
"indices._types.FailureStoreLifecycleTemplate": {
"description": "Template equivalent of FailureStoreLifecycle that allows nullable values.",
"type": "object",
"properties": {
"data_retention": {
"description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.Duration"
},
{
"nullable": true,
"type": "string"
}
]
},
"enabled": {
"description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.",
"default": true,
"type": "boolean"
}
}
},
"cluster.remote_info.ClusterRemoteInfo": {
"discriminator": {
"propertyName": "mode",
"mapping": {
"proxy": "#/components/schemas/cluster.remote_info.ClusterRemoteProxyInfo",
"sniff": "#/components/schemas/cluster.remote_info.ClusterRemoteSniffInfo"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/cluster.remote_info.ClusterRemoteSniffInfo"
},
{
"$ref": "#/components/schemas/cluster.remote_info.ClusterRemoteProxyInfo"
}
]
},
"cluster.remote_info.ClusterRemoteSniffInfo": {
"type": "object",
"properties": {
"mode": {
"description": "The connection mode for the remote cluster.",
"type": "string",
"enum": [
"sniff"
]
},
"connected": {
"description": "If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.",
"type": "boolean"
},
"max_connections_per_cluster": {
"description": "The maximum number of connections maintained for the remote cluster when sniff mode is configured.",
"type": "number"
},
"num_nodes_connected": {
"description": "The number of connected nodes in the remote cluster when sniff mode is configured.",
"type": "number"
},
"initial_connect_timeout": {
"description": "The initial connect timeout for remote cluster connections.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"skip_unavailable": {
"description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.",
"type": "boolean"
},
"seeds": {
"description": "The initial seed transport addresses of the remote cluster when sniff mode is configured.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"mode",
"connected",
"max_connections_per_cluster",
"num_nodes_connected",
"initial_connect_timeout",
"skip_unavailable",
"seeds"
]
},
"cluster.remote_info.ClusterRemoteProxyInfo": {
"type": "object",
"properties": {
"mode": {
"description": "The connection mode for the remote cluster.",
"type": "string",
"enum": [
"proxy"
]
},
"connected": {
"description": "If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.",
"type": "boolean"
},
"initial_connect_timeout": {
"description": "The initial connect timeout for remote cluster connections.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"skip_unavailable": {
"description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.",
"type": "boolean"
},
"proxy_address": {
"description": "The address for remote connections when proxy mode is configured.",
"type": "string"
},
"server_name": {
"type": "string"
},
"num_proxy_sockets_connected": {
"description": "The number of open socket connections to the remote cluster when proxy mode is configured.",
"type": "number"
},
"max_proxy_socket_connections": {
"description": "The maximum number of socket connections to the remote cluster when proxy mode is configured.",
"type": "number"
},
"cluster_credentials": {
"description": "This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present.",
"type": "string"
}
},
"required": [
"mode",
"connected",
"initial_connect_timeout",
"skip_unavailable",
"proxy_address",
"server_name",
"num_proxy_sockets_connected",
"max_proxy_socket_connections"
]
},
"cluster.reroute.Command": {
"type": "object",
"properties": {
"cancel": {
"description": "Cancel allocation of a shard (or recovery). Accepts index and shard for index name and shard number, and node for the node to cancel the shard allocation on. This can be used to force resynchronization of existing replicas from the primary shard by cancelling them and allowing them to be reinitialized through the standard recovery process. By default only replica shard allocations can be cancelled. If it is necessary to cancel the allocation of a primary shard then the allow_primary flag must also be included in the request.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.reroute.CommandCancelAction"
}
]
},
"move": {
"description": "Move a started shard from one node to another node. Accepts index and shard for index name and shard number, from_node for the node to move the shard from, and to_node for the node to move the shard to.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.reroute.CommandMoveAction"
}
]
},
"allocate_replica": {
"description": "Allocate an unassigned replica shard to a node. Accepts index and shard for index name and shard number, and node to allocate the shard to. Takes allocation deciders into account.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.reroute.CommandAllocateReplicaAction"
}
]
},
"allocate_stale_primary": {
"description": "Allocate a primary shard to a node that holds a stale copy. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command may lead to data loss for the provided shard id. If a node which has the good copy of the data rejoins the cluster later on, that data will be deleted or overwritten with the data of the stale copy that was forcefully allocated with this command. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.reroute.CommandAllocatePrimaryAction"
}
]
},
"allocate_empty_primary": {
"description": "Allocate an empty primary shard to a node. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command leads to a complete loss of all data that was indexed into this shard, if it was previously started. If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.reroute.CommandAllocatePrimaryAction"
}
]
}
}
},
"cluster.reroute.CommandCancelAction": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shard": {
"type": "number"
},
"node": {
"type": "string"
},
"allow_primary": {
"type": "boolean"
}
},
"required": [
"index",
"shard",
"node"
]
},
"cluster.reroute.CommandMoveAction": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shard": {
"type": "number"
},
"from_node": {
"description": "The node to move the shard from",
"type": "string"
},
"to_node": {
"description": "The node to move the shard to",
"type": "string"
}
},
"required": [
"index",
"shard",
"from_node",
"to_node"
]
},
"cluster.reroute.CommandAllocateReplicaAction": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shard": {
"type": "number"
},
"node": {
"type": "string"
}
},
"required": [
"index",
"shard",
"node"
]
},
"cluster.reroute.CommandAllocatePrimaryAction": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shard": {
"type": "number"
},
"node": {
"type": "string"
},
"accept_data_loss": {
"description": "If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true",
"type": "boolean"
}
},
"required": [
"index",
"shard",
"node",
"accept_data_loss"
]
},
"cluster.reroute.RerouteExplanation": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.reroute.RerouteDecision"
}
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.reroute.RerouteParameters"
}
]
}
},
"required": [
"command",
"decisions",
"parameters"
]
},
"cluster.reroute.RerouteDecision": {
"type": "object",
"properties": {
"decider": {
"type": "string"
},
"decision": {
"type": "string"
},
"explanation": {
"type": "string"
}
},
"required": [
"decider",
"decision",
"explanation"
]
},
"cluster.reroute.RerouteParameters": {
"type": "object",
"properties": {
"allow_primary": {
"type": "boolean"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"node": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeName"
}
]
},
"shard": {
"type": "number"
},
"from_node": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeName"
}
]
},
"to_node": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeName"
}
]
}
},
"required": [
"allow_primary",
"index",
"node",
"shard"
]
},
"_types.NodeName": {
"type": "string"
},
"cluster.state.ClusterStateMetrics": {
"oneOf": [
{
"$ref": "#/components/schemas/cluster.state.ClusterStateMetric"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.state.ClusterStateMetric"
}
}
]
},
"cluster.state.ClusterStateMetric": {
"type": "string",
"enum": [
"_all",
"version",
"master_node",
"blocks",
"nodes",
"metadata",
"routing_table",
"routing_nodes",
"customs"
]
},
"cluster.stats.StatsResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.NodesResponseBase"
},
{
"type": "object",
"properties": {
"cluster_name": {
"description": "Name of the cluster, based on the cluster name setting.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"cluster_uuid": {
"description": "Unique identifier for the cluster.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
},
"indices": {
"description": "Contains statistics about indices with shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterIndices"
}
]
},
"nodes": {
"description": "Contains statistics about nodes selected by the request’s node filters.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterNodes"
}
]
},
"repositories": {
"description": "Contains stats on repository feature usage exposed in cluster stats for telemetry.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"snapshots": {
"description": "Contains stats cluster snapshots.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterSnapshotStats"
}
]
},
"status": {
"description": "Health status of the cluster, based on the state of its primary and replica shards.\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",
"allOf": [
{
"$ref": "#/components/schemas/_types.HealthStatus"
}
]
},
"timestamp": {
"description": "Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.",
"type": "number"
},
"ccs": {
"description": "Cross-cluster stats",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.CCSStats"
}
]
}
},
"required": [
"cluster_name",
"cluster_uuid",
"indices",
"nodes",
"repositories",
"snapshots",
"timestamp",
"ccs"
]
}
]
},
"cluster.stats.ClusterIndices": {
"type": "object",
"properties": {
"analysis": {
"description": "Contains statistics about analyzers and analyzer components used in selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.CharFilterTypes"
}
]
},
"completion": {
"description": "Contains statistics about memory used for completion in selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.CompletionStats"
}
]
},
"count": {
"description": "Total number of indices with shards assigned to selected nodes.",
"type": "number"
},
"docs": {
"description": "Contains counts for documents in selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DocStats"
}
]
},
"fielddata": {
"description": "Contains statistics about the field data cache of selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.FielddataStats"
}
]
},
"query_cache": {
"description": "Contains statistics about the query cache of selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryCacheStats"
}
]
},
"search": {
"description": "Holds a snapshot of the search usage statistics.\nUsed to hold the stats for a single node that's part of a ClusterStatsNodeResponse, as well as to\naccumulate stats for the entire cluster and return them as part of the ClusterStatsResponse.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.SearchUsageStats"
}
]
},
"segments": {
"description": "Contains statistics about segments in selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SegmentsStats"
}
]
},
"shards": {
"description": "Contains statistics about indices with shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterIndicesShards"
}
]
},
"store": {
"description": "Contains statistics about the size of shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.StoreStats"
}
]
},
"mappings": {
"description": "Contains statistics about field mappings in selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.FieldTypesMappings"
}
]
},
"versions": {
"description": "Contains statistics about analyzers and analyzer components used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.IndicesVersions"
}
},
"dense_vector": {
"description": "Contains statistics about indexed dense vector",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.DenseVectorStats"
}
]
},
"sparse_vector": {
"description": "Contains statistics about indexed sparse vector",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.SparseVectorStats"
}
]
}
},
"required": [
"completion",
"count",
"docs",
"fielddata",
"query_cache",
"search",
"segments",
"shards",
"store",
"dense_vector",
"sparse_vector"
]
},
"cluster.stats.CharFilterTypes": {
"type": "object",
"properties": {
"analyzer_types": {
"description": "Contains statistics about analyzer types used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"built_in_analyzers": {
"description": "Contains statistics about built-in analyzers used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"built_in_char_filters": {
"description": "Contains statistics about built-in character filters used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"built_in_filters": {
"description": "Contains statistics about built-in token filters used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"built_in_tokenizers": {
"description": "Contains statistics about built-in tokenizers used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"char_filter_types": {
"description": "Contains statistics about character filter types used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"multiple_synonym_graph_filters": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.MultipleSynonymGraphFilter"
}
]
},
"filter_types": {
"description": "Contains statistics about token filter types used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"tokenizer_types": {
"description": "Contains statistics about tokenizer types used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"synonyms": {
"description": "Contains statistics about synonyms types used in selected nodes.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster.stats.SynonymsStats"
}
}
},
"required": [
"analyzer_types",
"built_in_analyzers",
"built_in_char_filters",
"built_in_filters",
"built_in_tokenizers",
"char_filter_types",
"filter_types",
"tokenizer_types",
"synonyms"
]
},
"cluster.stats.FieldTypes": {
"type": "object",
"properties": {
"name": {
"description": "The name for the field type in selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"count": {
"description": "The number of occurrences of the field type in selected nodes.",
"type": "number"
},
"index_count": {
"description": "The number of indices containing the field type in selected nodes.",
"type": "number"
},
"indexed_vector_count": {
"description": "For dense_vector field types, number of indexed vector types in selected nodes.",
"type": "number"
},
"indexed_vector_dim_max": {
"description": "For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.",
"type": "number"
},
"indexed_vector_dim_min": {
"description": "For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.",
"type": "number"
},
"script_count": {
"description": "The number of fields that declare a script.",
"x-state": "Generally available; Added in 7.13.0",
"type": "number"
},
"vector_index_type_count": {
"description": "For dense_vector field types, count of mappings by index type",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"vector_similarity_type_count": {
"description": "For dense_vector field types, count of mappings by similarity",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"vector_element_type_count": {
"description": "For dense_vector field types, count of mappings by element type",
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"name",
"count",
"index_count"
]
},
"cluster.stats.MultipleSynonymGraphFilter": {
"type": "object",
"properties": {
"analyzer_count": {
"description": "Number of analyzers across the cluster whose filter chain contains more than one synonym_graph filter.",
"default": 0,
"type": "number"
},
"index_count": {
"description": "Number of indices that contain at least one analyzer with more than one synonym_graph filter.",
"default": 0,
"type": "number"
}
}
},
"cluster.stats.SynonymsStats": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"index_count": {
"type": "number"
}
},
"required": [
"count",
"index_count"
]
},
"_types.CompletionStats": {
"type": "object",
"properties": {
"size_in_bytes": {
"description": "Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.",
"type": "number"
},
"size": {
"description": "Total amount of memory used for completion across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"fields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.FieldSizeUsage"
}
}
},
"required": [
"size_in_bytes"
]
},
"_types.FieldSizeUsage": {
"type": "object",
"properties": {
"size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"size_in_bytes": {
"type": "number"
}
},
"required": [
"size_in_bytes"
]
},
"_types.DocStats": {
"type": "object",
"properties": {
"count": {
"description": "Total number of non-deleted documents across all primary shards assigned to selected nodes.\nThis number is based on documents in Lucene segments and may include documents from nested fields.",
"type": "number"
},
"deleted": {
"description": "Total number of deleted documents across all primary shards assigned to selected nodes.\nThis number is based on documents in Lucene segments.\nElasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.",
"type": "number"
},
"total_size_in_bytes": {
"description": "Returns the total size in bytes of all documents in this stats.\nThis value may be more reliable than store_stats.size_in_bytes in estimating the index size.",
"type": "number"
},
"total_size": {
"description": "Human readable total_size_in_bytes",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
},
"required": [
"count",
"total_size_in_bytes"
]
},
"_types.FielddataStats": {
"type": "object",
"properties": {
"evictions": {
"type": "number"
},
"memory_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"memory_size_in_bytes": {
"type": "number"
},
"fields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.FieldMemoryUsage"
}
},
"global_ordinals": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GlobalOrdinalsStats"
}
]
}
},
"required": [
"memory_size_in_bytes",
"global_ordinals"
]
},
"_types.FieldMemoryUsage": {
"type": "object",
"properties": {
"memory_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"memory_size_in_bytes": {
"type": "number"
}
},
"required": [
"memory_size_in_bytes"
]
},
"_types.GlobalOrdinalsStats": {
"type": "object",
"properties": {
"build_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitMillis"
}
]
},
"build_time": {
"type": "string"
},
"fields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.GlobalOrdinalFieldStats"
}
}
},
"required": [
"build_time_in_millis"
]
},
"_types.GlobalOrdinalFieldStats": {
"type": "object",
"properties": {
"build_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitMillis"
}
]
},
"build_time": {
"type": "string"
},
"shard_max_value_count": {
"type": "number"
}
},
"required": [
"build_time_in_millis",
"shard_max_value_count"
]
},
"_types.QueryCacheStats": {
"type": "object",
"properties": {
"cache_count": {
"description": "Total number of entries added to the query cache across all shards assigned to selected nodes.\nThis number includes current and evicted entries.",
"type": "number"
},
"cache_size": {
"description": "Total number of entries currently in the query cache across all shards assigned to selected nodes.",
"type": "number"
},
"evictions": {
"description": "Total number of query cache evictions across all shards assigned to selected nodes.",
"type": "number"
},
"hit_count": {
"description": "Total count of query cache hits across all shards assigned to selected nodes.",
"type": "number"
},
"memory_size": {
"description": "Total amount of memory used for the query cache across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"memory_size_in_bytes": {
"description": "Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.",
"type": "number"
},
"miss_count": {
"description": "Total count of query cache misses across all shards assigned to selected nodes.",
"type": "number"
},
"total_count": {
"description": "Total count of hits and misses in the query cache across all shards assigned to selected nodes.",
"type": "number"
}
},
"required": [
"cache_count",
"cache_size",
"evictions",
"hit_count",
"memory_size_in_bytes",
"miss_count",
"total_count"
]
},
"cluster.stats.SearchUsageStats": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"queries": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"rescorers": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"sections": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"retrievers": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"extended": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ExtendedSearchUsage"
}
]
}
},
"required": [
"total",
"queries",
"rescorers",
"sections",
"retrievers",
"extended"
]
},
"cluster.stats.ExtendedSearchUsage": {
"type": "object",
"properties": {
"retrievers": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ExtendedRetrieversSearchUsage"
}
]
},
"section": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ExtendedSectionSearchUsage"
}
]
}
}
},
"cluster.stats.ExtendedRetrieversSearchUsage": {
"type": "object",
"properties": {
"text_similarity_reranker": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ExtendedTextSimilarityRetrieverUsage"
}
]
}
}
},
"cluster.stats.ExtendedTextSimilarityRetrieverUsage": {
"type": "object",
"properties": {
"chunk_rescorer": {
"type": "number"
}
}
},
"cluster.stats.ExtendedSectionSearchUsage": {
"type": "object",
"properties": {
"sort": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
}
},
"_types.SegmentsStats": {
"type": "object",
"properties": {
"count": {
"description": "Total number of segments across all shards assigned to selected nodes.",
"type": "number"
},
"doc_values_memory": {
"description": "Total amount of memory used for doc values across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"doc_values_memory_in_bytes": {
"description": "Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.",
"type": "number"
},
"file_sizes": {
"description": "This object is not populated by the cluster stats API.\nTo get information on segment files, use the node stats API.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.stats.ShardFileSizeInfo"
}
},
"fixed_bit_set": {
"description": "Total amount of memory used by fixed bit sets across all shards assigned to selected nodes.\nFixed bit sets are used for nested object field types and type filters for join fields.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"fixed_bit_set_memory_in_bytes": {
"description": "Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.",
"type": "number"
},
"index_writer_memory": {
"description": "Total amount of memory used by all index writers across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"index_writer_memory_in_bytes": {
"description": "Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.",
"type": "number"
},
"max_unsafe_auto_id_timestamp": {
"description": "Unix timestamp, in milliseconds, of the most recently retried indexing request.",
"type": "number"
},
"memory": {
"description": "Total amount of memory used for segments across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"memory_in_bytes": {
"description": "Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.",
"type": "number"
},
"norms_memory": {
"description": "Total amount of memory used for normalization factors across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"norms_memory_in_bytes": {
"description": "Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.",
"type": "number"
},
"points_memory": {
"description": "Total amount of memory used for points across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"points_memory_in_bytes": {
"description": "Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.",
"type": "number"
},
"stored_fields_memory_in_bytes": {
"description": "Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.",
"type": "number"
},
"stored_fields_memory": {
"description": "Total amount of memory used for stored fields across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"terms_memory_in_bytes": {
"description": "Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.",
"type": "number"
},
"terms_memory": {
"description": "Total amount of memory used for terms across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"term_vectors_memory": {
"description": "Total amount of memory used for term vectors across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"term_vectors_memory_in_bytes": {
"description": "Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.",
"type": "number"
},
"version_map_memory": {
"description": "Total amount of memory used by all version maps across all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"version_map_memory_in_bytes": {
"description": "Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.",
"type": "number"
}
},
"required": [
"count",
"doc_values_memory_in_bytes",
"file_sizes",
"fixed_bit_set_memory_in_bytes",
"index_writer_memory_in_bytes",
"max_unsafe_auto_id_timestamp",
"memory_in_bytes",
"norms_memory_in_bytes",
"points_memory_in_bytes",
"stored_fields_memory_in_bytes",
"terms_memory_in_bytes",
"term_vectors_memory_in_bytes",
"version_map_memory_in_bytes"
]
},
"indices.stats.ShardFileSizeInfo": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"size_in_bytes": {
"type": "number"
},
"min_size_in_bytes": {
"type": "number"
},
"max_size_in_bytes": {
"type": "number"
},
"average_size_in_bytes": {
"type": "number"
},
"count": {
"type": "number"
}
},
"required": [
"description",
"size_in_bytes"
]
},
"cluster.stats.ClusterIndicesShards": {
"description": "Contains statistics about shards assigned to selected nodes.",
"type": "object",
"properties": {
"index": {
"description": "Contains statistics about shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterIndicesShardsIndex"
}
]
},
"primaries": {
"description": "Number of primary shards assigned to selected nodes.",
"type": "number"
},
"replication": {
"description": "Ratio of replica shards to primary shards across all selected nodes.",
"type": "number"
},
"total": {
"description": "Total number of shards assigned to selected nodes.",
"type": "number"
}
}
},
"cluster.stats.ClusterIndicesShardsIndex": {
"type": "object",
"properties": {
"primaries": {
"description": "Contains statistics about the number of primary shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics"
}
]
},
"replication": {
"description": "Contains statistics about the number of replication shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics"
}
]
},
"shards": {
"description": "Contains statistics about the number of shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics"
}
]
}
},
"required": [
"primaries",
"replication",
"shards"
]
},
"cluster.stats.ClusterShardMetrics": {
"type": "object",
"properties": {
"avg": {
"description": "Mean number of shards in an index, counting only shards assigned to selected nodes.",
"type": "number"
},
"max": {
"description": "Maximum number of shards in an index, counting only shards assigned to selected nodes.",
"type": "number"
},
"min": {
"description": "Minimum number of shards in an index, counting only shards assigned to selected nodes.",
"type": "number"
}
},
"required": [
"avg",
"max",
"min"
]
},
"_types.StoreStats": {
"type": "object",
"properties": {
"size": {
"description": "Total size of all shards assigned to selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"size_in_bytes": {
"description": "Total size, in bytes, of all shards assigned to selected nodes.",
"type": "number"
},
"reserved": {
"description": "A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"reserved_in_bytes": {
"description": "A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.",
"type": "number"
},
"total_data_set_size": {
"description": "Total data set size of all shards assigned to selected nodes.\nThis includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_data_set_size_in_bytes": {
"description": "Total data set size, in bytes, of all shards assigned to selected nodes.\nThis includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.",
"type": "number"
}
},
"required": [
"size_in_bytes",
"reserved_in_bytes"
]
},
"cluster.stats.FieldTypesMappings": {
"type": "object",
"properties": {
"field_types": {
"description": "Contains statistics about field data types used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.FieldTypes"
}
},
"runtime_field_types": {
"description": "Contains statistics about runtime field data types used in selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.RuntimeFieldTypes"
}
},
"total_field_count": {
"description": "Total number of fields in all non-system indices.",
"type": "number"
},
"total_deduplicated_field_count": {
"description": "Total number of fields in all non-system indices, accounting for mapping deduplication.",
"type": "number"
},
"total_deduplicated_mapping_size": {
"description": "Total size of all mappings after deduplication and compression.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_deduplicated_mapping_size_in_bytes": {
"description": "Total size of all mappings, in bytes, after deduplication and compression.",
"type": "number"
},
"source_modes": {
"description": "Source mode usage count.",
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"field_types",
"runtime_field_types",
"source_modes"
]
},
"cluster.stats.RuntimeFieldTypes": {
"type": "object",
"properties": {
"chars_max": {
"description": "Maximum number of characters for a single runtime field script.",
"type": "number"
},
"chars_total": {
"description": "Total number of characters for the scripts that define the current runtime field data type.",
"type": "number"
},
"count": {
"description": "Number of runtime fields mapped to the field data type in selected nodes.",
"type": "number"
},
"doc_max": {
"description": "Maximum number of accesses to doc_values for a single runtime field script",
"type": "number"
},
"doc_total": {
"description": "Total number of accesses to doc_values for the scripts that define the current runtime field data type.",
"type": "number"
},
"index_count": {
"description": "Number of indices containing a mapping of the runtime field data type in selected nodes.",
"type": "number"
},
"lang": {
"description": "Script languages used for the runtime fields scripts.",
"type": "array",
"items": {
"type": "string"
}
},
"lines_max": {
"description": "Maximum number of lines for a single runtime field script.",
"type": "number"
},
"lines_total": {
"description": "Total number of lines for the scripts that define the current runtime field data type.",
"type": "number"
},
"name": {
"description": "Field data type used in selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"scriptless_count": {
"description": "Number of runtime fields that don’t declare a script.",
"type": "number"
},
"shadowed_count": {
"description": "Number of runtime fields that shadow an indexed field.",
"type": "number"
},
"source_max": {
"description": "Maximum number of accesses to _source for a single runtime field script.",
"type": "number"
},
"source_total": {
"description": "Total number of accesses to _source for the scripts that define the current runtime field data type.",
"type": "number"
}
},
"required": [
"chars_max",
"chars_total",
"count",
"doc_max",
"doc_total",
"index_count",
"lang",
"lines_max",
"lines_total",
"name",
"scriptless_count",
"shadowed_count",
"source_max",
"source_total"
]
},
"cluster.stats.IndicesVersions": {
"type": "object",
"properties": {
"index_count": {
"type": "number"
},
"primary_shard_count": {
"type": "number"
},
"total_primary_bytes": {
"type": "number"
},
"total_primary_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
},
"required": [
"index_count",
"primary_shard_count",
"total_primary_bytes",
"version"
]
},
"cluster.stats.DenseVectorStats": {
"type": "object",
"properties": {
"value_count": {
"type": "number"
},
"off_heap": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.DenseVectorOffHeapStats"
}
]
}
},
"required": [
"value_count"
]
},
"cluster.stats.DenseVectorOffHeapStats": {
"type": "object",
"properties": {
"total_size_bytes": {
"type": "number"
},
"total_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_veb_size_bytes": {
"type": "number"
},
"total_veb_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_vec_size_bytes": {
"type": "number"
},
"total_vec_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_veq_size_bytes": {
"type": "number"
},
"total_veq_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_vex_size_bytes": {
"type": "number"
},
"total_vex_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_cenif_size_bytes": {
"type": "number"
},
"total_cenif_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_clivf_size_bytes": {
"type": "number"
},
"total_clivf_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"fielddata": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
}
},
"required": [
"total_size_bytes",
"total_veb_size_bytes",
"total_vec_size_bytes",
"total_veq_size_bytes",
"total_vex_size_bytes",
"total_cenif_size_bytes",
"total_clivf_size_bytes"
]
},
"cluster.stats.SparseVectorStats": {
"type": "object",
"properties": {
"value_count": {
"type": "number"
}
},
"required": [
"value_count"
]
},
"cluster.stats.ClusterNodes": {
"type": "object",
"properties": {
"count": {
"description": "Contains counts for nodes selected by the request’s node filters.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterNodeCount"
}
]
},
"discovery_types": {
"description": "Contains statistics about the discovery types used by selected nodes.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"fs": {
"description": "Contains statistics about file stores by selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterFileSystem"
}
]
},
"indexing_pressure": {
"x-state": "Generally available; Added in 7.16.0",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.IndexingPressure"
}
]
},
"ingest": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterIngest"
}
]
},
"jvm": {
"description": "Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterJvm"
}
]
},
"network_types": {
"description": "Contains statistics about the transport and HTTP networks used by selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterNetworkTypes"
}
]
},
"os": {
"description": "Contains statistics about the operating systems used by selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterOperatingSystem"
}
]
},
"packaging_types": {
"description": "Contains statistics about Elasticsearch distributions installed on selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.NodePackagingType"
}
},
"plugins": {
"description": "Contains statistics about installed plugins and modules by selected nodes.\nIf no plugins or modules are installed, this array is empty.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.PluginStats"
}
},
"process": {
"description": "Contains statistics about processes used by selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterProcess"
}
]
},
"versions": {
"description": "Array of Elasticsearch versions used on selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.VersionString"
}
}
},
"required": [
"count",
"discovery_types",
"fs",
"indexing_pressure",
"ingest",
"jvm",
"network_types",
"os",
"packaging_types",
"plugins",
"process",
"versions"
]
},
"cluster.stats.ClusterNodeCount": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"coordinating_only": {
"type": "number"
},
"data": {
"type": "number"
},
"data_cold": {
"type": "number"
},
"data_content": {
"type": "number"
},
"data_frozen": {
"x-state": "Generally available; Added in 7.13.0",
"type": "number"
},
"data_hot": {
"type": "number"
},
"data_warm": {
"type": "number"
},
"index": {
"type": "number"
},
"ingest": {
"type": "number"
},
"master": {
"type": "number"
},
"ml": {
"type": "number"
},
"remote_cluster_client": {
"type": "number"
},
"search": {
"type": "number"
},
"transform": {
"type": "number"
},
"voting_only": {
"type": "number"
}
},
"required": [
"total"
]
},
"cluster.stats.ClusterFileSystem": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"mount": {
"type": "string"
},
"type": {
"type": "string"
},
"available_in_bytes": {
"description": "Total number of bytes available to JVM in file stores across all selected nodes.\nDepending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.\nThis is the actual amount of free disk space the selected Elasticsearch nodes can use.",
"type": "number"
},
"available": {
"description": "Total number of bytes available to JVM in file stores across all selected nodes.\nDepending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.\nThis is the actual amount of free disk space the selected Elasticsearch nodes can use.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"free_in_bytes": {
"description": "Total number, in bytes, of unallocated bytes in file stores across all selected nodes.",
"type": "number"
},
"free": {
"description": "Total number of unallocated bytes in file stores across all selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_in_bytes": {
"description": "Total size, in bytes, of all file stores across all selected nodes.",
"type": "number"
},
"total": {
"description": "Total size of all file stores across all selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"low_watermark_free_space": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"low_watermark_free_space_in_bytes": {
"type": "number"
},
"high_watermark_free_space": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"high_watermark_free_space_in_bytes": {
"type": "number"
},
"flood_stage_free_space": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"flood_stage_free_space_in_bytes": {
"type": "number"
},
"frozen_flood_stage_free_space": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"frozen_flood_stage_free_space_in_bytes": {
"type": "number"
}
}
},
"cluster.stats.IndexingPressure": {
"type": "object",
"properties": {
"memory": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.IndexingPressureMemory"
}
]
}
},
"required": [
"memory"
]
},
"nodes._types.IndexingPressureMemory": {
"type": "object",
"properties": {
"limit": {
"description": "Configured memory limit for the indexing requests.\nReplica requests have an automatic limit that is 1.5x this value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"limit_in_bytes": {
"description": "Configured memory limit, in bytes, for the indexing requests.\nReplica requests have an automatic limit that is 1.5x this value.",
"type": "number"
},
"current": {
"description": "Contains statistics for current indexing load.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.PressureMemory"
}
]
},
"total": {
"description": "Contains statistics for the cumulative indexing load since the node started.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.PressureMemory"
}
]
}
}
},
"nodes._types.PressureMemory": {
"type": "object",
"properties": {
"all": {
"description": "Memory consumed by indexing requests in the coordinating, primary, or replica stage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"all_in_bytes": {
"description": "Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.",
"type": "number"
},
"combined_coordinating_and_primary": {
"description": "Memory consumed by indexing requests in the coordinating or primary stage.\nThis value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"combined_coordinating_and_primary_in_bytes": {
"description": "Memory consumed, in bytes, by indexing requests in the coordinating or primary stage.\nThis value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.",
"type": "number"
},
"coordinating": {
"description": "Memory consumed by indexing requests in the coordinating stage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"coordinating_in_bytes": {
"description": "Memory consumed, in bytes, by indexing requests in the coordinating stage.",
"type": "number"
},
"primary": {
"description": "Memory consumed by indexing requests in the primary stage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"primary_in_bytes": {
"description": "Memory consumed, in bytes, by indexing requests in the primary stage.",
"type": "number"
},
"replica": {
"description": "Memory consumed by indexing requests in the replica stage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"replica_in_bytes": {
"description": "Memory consumed, in bytes, by indexing requests in the replica stage.",
"type": "number"
},
"coordinating_rejections": {
"description": "Number of indexing requests rejected in the coordinating stage.",
"type": "number"
},
"primary_rejections": {
"description": "Number of indexing requests rejected in the primary stage.",
"type": "number"
},
"replica_rejections": {
"description": "Number of indexing requests rejected in the replica stage.",
"type": "number"
},
"primary_document_rejections": {
"type": "number"
},
"large_operation_rejections": {
"type": "number"
}
}
},
"cluster.stats.ClusterIngest": {
"type": "object",
"properties": {
"number_of_pipelines": {
"type": "number"
},
"processor_stats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster.stats.ClusterProcessor"
}
}
},
"required": [
"number_of_pipelines",
"processor_stats"
]
},
"cluster.stats.ClusterProcessor": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"current": {
"type": "number"
},
"failed": {
"type": "number"
},
"time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"count",
"current",
"failed",
"time_in_millis"
]
},
"cluster.stats.ClusterJvm": {
"type": "object",
"properties": {
"max_uptime_in_millis": {
"description": "Uptime duration, in milliseconds, since JVM last started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"max_uptime": {
"description": "Uptime duration since JVM last started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"mem": {
"description": "Contains statistics about memory used by selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterJvmMemory"
}
]
},
"threads": {
"description": "Number of active threads in use by JVM across all selected nodes.",
"type": "number"
},
"versions": {
"description": "Contains statistics about the JVM versions used by selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.ClusterJvmVersion"
}
}
},
"required": [
"max_uptime_in_millis",
"mem",
"threads",
"versions"
]
},
"cluster.stats.ClusterJvmMemory": {
"type": "object",
"properties": {
"heap_max_in_bytes": {
"description": "Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.",
"type": "number"
},
"heap_max": {
"description": "Maximum amount of memory available for use by the heap across all selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"heap_used_in_bytes": {
"description": "Memory, in bytes, currently in use by the heap across all selected nodes.",
"type": "number"
},
"heap_used": {
"description": "Memory currently in use by the heap across all selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
},
"required": [
"heap_max_in_bytes",
"heap_used_in_bytes"
]
},
"cluster.stats.ClusterJvmVersion": {
"type": "object",
"properties": {
"bundled_jdk": {
"description": "Always `true`. All distributions come with a bundled Java Development Kit (JDK).",
"type": "boolean"
},
"count": {
"description": "Total number of selected nodes using JVM.",
"type": "number"
},
"using_bundled_jdk": {
"description": "If `true`, a bundled JDK is in use by JVM.",
"type": "boolean"
},
"version": {
"description": "Version of JVM used by one or more selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"vm_name": {
"description": "Name of the JVM.",
"type": "string"
},
"vm_vendor": {
"description": "Vendor of the JVM.",
"type": "string"
},
"vm_version": {
"description": "Full version number of JVM.\nThe full version number includes a plus sign (+) followed by the build number.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
},
"required": [
"bundled_jdk",
"count",
"using_bundled_jdk",
"version",
"vm_name",
"vm_vendor",
"vm_version"
]
},
"cluster.stats.ClusterNetworkTypes": {
"type": "object",
"properties": {
"http_types": {
"description": "Contains statistics about the HTTP network types used by selected nodes.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"transport_types": {
"description": "Contains statistics about the transport network types used by selected nodes.",
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"http_types",
"transport_types"
]
},
"cluster.stats.ClusterOperatingSystem": {
"type": "object",
"properties": {
"allocated_processors": {
"description": "Number of processors used to calculate thread pool size across all selected nodes.\nThis number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system.\nIn both cases, this number will never be larger than 32.",
"type": "number"
},
"architectures": {
"description": "Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.ClusterOperatingSystemArchitecture"
}
},
"available_processors": {
"description": "Number of processors available to JVM across all selected nodes.",
"type": "number"
},
"mem": {
"description": "Contains statistics about memory used by selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.OperatingSystemMemoryInfo"
}
]
},
"names": {
"description": "Contains statistics about operating systems used by selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.ClusterOperatingSystemName"
}
},
"pretty_names": {
"description": "Contains statistics about operating systems used by selected nodes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.stats.ClusterOperatingSystemPrettyName"
}
}
},
"required": [
"allocated_processors",
"available_processors",
"mem",
"names",
"pretty_names"
]
},
"cluster.stats.ClusterOperatingSystemArchitecture": {
"type": "object",
"properties": {
"arch": {
"description": "Name of an architecture used by one or more selected nodes.",
"type": "string"
},
"count": {
"description": "Number of selected nodes using the architecture.",
"type": "number"
}
},
"required": [
"arch",
"count"
]
},
"cluster.stats.OperatingSystemMemoryInfo": {
"type": "object",
"properties": {
"adjusted_total_in_bytes": {
"description": "Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set.",
"x-state": "Generally available; Added in 7.16.0",
"type": "number"
},
"adjusted_total": {
"description": "Total amount of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set.",
"x-state": "Generally available; Added in 7.16.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"free_in_bytes": {
"description": "Amount, in bytes, of free physical memory across all selected nodes.",
"type": "number"
},
"free": {
"description": "Amount of free physical memory across all selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"free_percent": {
"description": "Percentage of free physical memory across all selected nodes.",
"type": "number"
},
"total_in_bytes": {
"description": "Total amount, in bytes, of physical memory across all selected nodes.",
"type": "number"
},
"total": {
"description": "Total amount of physical memory across all selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"used_in_bytes": {
"description": "Amount, in bytes, of physical memory in use across all selected nodes.",
"type": "number"
},
"used": {
"description": "Amount of physical memory in use across all selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"used_percent": {
"description": "Percentage of physical memory in use across all selected nodes.",
"type": "number"
}
},
"required": [
"free_in_bytes",
"free_percent",
"total_in_bytes",
"used_in_bytes",
"used_percent"
]
},
"cluster.stats.ClusterOperatingSystemName": {
"type": "object",
"properties": {
"count": {
"description": "Number of selected nodes using the operating system.",
"type": "number"
},
"name": {
"description": "Name of an operating system used by one or more selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"count",
"name"
]
},
"cluster.stats.ClusterOperatingSystemPrettyName": {
"type": "object",
"properties": {
"count": {
"description": "Number of selected nodes using the operating system.",
"type": "number"
},
"pretty_name": {
"description": "Human-readable name of an operating system used by one or more selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"count",
"pretty_name"
]
},
"cluster.stats.NodePackagingType": {
"type": "object",
"properties": {
"count": {
"description": "Number of selected nodes using the distribution flavor and file type.",
"type": "number"
},
"flavor": {
"description": "Type of Elasticsearch distribution. This is always `default`.",
"type": "string"
},
"type": {
"description": "File type (such as `tar` or `zip`) used for the distribution package.",
"type": "string"
}
},
"required": [
"count",
"flavor",
"type"
]
},
"_types.PluginStats": {
"type": "object",
"properties": {
"classname": {
"type": "string"
},
"description": {
"type": "string"
},
"elasticsearch_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"extended_plugins": {
"type": "array",
"items": {
"type": "string"
}
},
"has_native_controller": {
"type": "boolean"
},
"java_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"licensed": {
"type": "boolean"
}
},
"required": [
"classname",
"description",
"elasticsearch_version",
"extended_plugins",
"has_native_controller",
"java_version",
"name",
"version",
"licensed"
]
},
"cluster.stats.ClusterProcess": {
"type": "object",
"properties": {
"cpu": {
"description": "Contains statistics about CPU used by selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterProcessCpu"
}
]
},
"open_file_descriptors": {
"description": "Contains statistics about open file descriptors in selected nodes.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.ClusterProcessOpenFileDescriptors"
}
]
}
},
"required": [
"cpu",
"open_file_descriptors"
]
},
"cluster.stats.ClusterProcessCpu": {
"type": "object",
"properties": {
"percent": {
"description": "Percentage of CPU used across all selected nodes.\nReturns `-1` if not supported.",
"type": "number"
}
},
"required": [
"percent"
]
},
"cluster.stats.ClusterProcessOpenFileDescriptors": {
"type": "object",
"properties": {
"avg": {
"description": "Average number of concurrently open file descriptors.\nReturns `-1` if not supported.",
"type": "number"
},
"max": {
"description": "Maximum number of concurrently open file descriptors allowed across all selected nodes.\nReturns `-1` if not supported.",
"type": "number"
},
"min": {
"description": "Minimum number of concurrently open file descriptors across all selected nodes.\nReturns -1 if not supported.",
"type": "number"
}
},
"required": [
"avg",
"max",
"min"
]
},
"cluster.stats.ClusterSnapshotStats": {
"type": "object",
"properties": {
"current_counts": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.SnapshotCurrentCounts"
}
]
},
"repositories": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster.stats.PerRepositoryStats"
}
}
},
"required": [
"current_counts",
"repositories"
]
},
"cluster.stats.SnapshotCurrentCounts": {
"type": "object",
"properties": {
"snapshots": {
"description": "Snapshots currently in progress",
"type": "number"
},
"shard_snapshots": {
"description": "Incomplete shard snapshots",
"type": "number"
},
"snapshot_deletions": {
"description": "Snapshots deletions in progress",
"type": "number"
},
"concurrent_operations": {
"description": "Sum of snapshots and snapshot_deletions",
"type": "number"
},
"cleanups": {
"description": "Cleanups in progress, not counted in concurrent_operations as they are not concurrent",
"type": "number"
}
},
"required": [
"snapshots",
"shard_snapshots",
"snapshot_deletions",
"concurrent_operations",
"cleanups"
]
},
"cluster.stats.PerRepositoryStats": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"oldest_start_time_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitMillis"
}
]
},
"oldest_start_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateFormat"
}
]
},
"current_counts": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.RepositoryStatsCurrentCounts"
}
]
}
},
"required": [
"type",
"oldest_start_time_millis",
"current_counts"
]
},
"cluster.stats.RepositoryStatsCurrentCounts": {
"type": "object",
"properties": {
"snapshots": {
"type": "number"
},
"clones": {
"type": "number"
},
"finalizations": {
"type": "number"
},
"deletions": {
"type": "number"
},
"snapshot_deletions": {
"type": "number"
},
"active_deletions": {
"type": "number"
},
"shards": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.RepositoryStatsShards"
}
]
}
},
"required": [
"snapshots",
"clones",
"finalizations",
"deletions",
"snapshot_deletions",
"active_deletions",
"shards"
]
},
"cluster.stats.RepositoryStatsShards": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"complete": {
"type": "number"
},
"incomplete": {
"type": "number"
},
"states": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"total",
"complete",
"incomplete",
"states"
]
},
"cluster.stats.CCSStats": {
"type": "object",
"properties": {
"clusters": {
"description": "Contains remote cluster settings and metrics collected from them.\nThe keys are cluster names, and the values are per-cluster data.\nOnly present if `include_remotes` option is set to true.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster.stats.RemoteClusterInfo"
}
},
"_search": {
"description": "Information about cross-cluster search usage.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.CCSUsageStats"
}
]
},
"_esql": {
"description": "Information about ES|QL cross-cluster query usage.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.CCSUsageStats"
}
]
}
},
"required": [
"_search"
]
},
"cluster.stats.RemoteClusterInfo": {
"type": "object",
"properties": {
"cluster_uuid": {
"description": "The UUID of the remote cluster.",
"type": "string"
},
"mode": {
"description": "The connection mode used to communicate with the remote cluster.",
"type": "string"
},
"skip_unavailable": {
"description": "The `skip_unavailable` setting used for this remote cluster.",
"type": "boolean"
},
"transport.compress": {
"description": "Transport compression setting used for this remote cluster.",
"type": "string"
},
"status": {
"description": "Health status of the cluster, based on the state of its primary and replica shards.\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",
"allOf": [
{
"$ref": "#/components/schemas/_types.HealthStatus"
}
]
},
"version": {
"description": "The list of Elasticsearch versions used by the nodes on the remote cluster.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.VersionString"
}
},
"nodes_count": {
"description": "The total count of nodes in the remote cluster.",
"type": "number"
},
"shards_count": {
"description": "The total number of shards in the remote cluster.",
"type": "number"
},
"indices_count": {
"description": "The total number of indices in the remote cluster.",
"type": "number"
},
"indices_total_size_in_bytes": {
"description": "Total data set size, in bytes, of all shards assigned to selected nodes.",
"type": "number"
},
"indices_total_size": {
"description": "Total data set size of all shards assigned to selected nodes, as a human-readable string.",
"type": "string"
},
"max_heap_in_bytes": {
"description": "Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster.",
"type": "number"
},
"max_heap": {
"description": "Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string.",
"type": "string"
},
"mem_total_in_bytes": {
"description": "Total amount, in bytes, of physical memory across the nodes of the remote cluster.",
"type": "number"
},
"mem_total": {
"description": "Total amount of physical memory across the nodes of the remote cluster, as a human-readable string.",
"type": "string"
}
},
"required": [
"cluster_uuid",
"mode",
"skip_unavailable",
"transport.compress",
"status",
"version",
"nodes_count",
"shards_count",
"indices_count",
"indices_total_size_in_bytes",
"max_heap_in_bytes",
"mem_total_in_bytes"
]
},
"cluster.stats.CCSUsageStats": {
"type": "object",
"properties": {
"total": {
"description": "The total number of cross-cluster search requests that have been executed by the cluster.",
"type": "number"
},
"success": {
"description": "The total number of cross-cluster search requests that have been successfully executed by the cluster.",
"type": "number"
},
"skipped": {
"description": "The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.",
"type": "number"
},
"took": {
"description": "Statistics about the time taken to execute cross-cluster search requests.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue"
}
]
},
"took_mrt_true": {
"description": "Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `true`.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue"
}
]
},
"took_mrt_false": {
"description": "Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `false`.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue"
}
]
},
"remotes_per_search_max": {
"description": "The maximum number of remote clusters that were queried in a single cross-cluster search request.",
"type": "number"
},
"remotes_per_search_avg": {
"description": "The average number of remote clusters that were queried in a single cross-cluster search request.",
"type": "number"
},
"failure_reasons": {
"description": "Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"features": {
"description": "The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both `async` and `wildcard`).",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"clients": {
"description": "Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as `kibana` or `elasticsearch`) are counted.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"clusters": {
"description": "Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name `(local)`.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster.stats.CCSUsageClusterStats"
}
}
},
"required": [
"total",
"success",
"skipped",
"took",
"remotes_per_search_max",
"remotes_per_search_avg",
"failure_reasons",
"features",
"clients",
"clusters"
]
},
"cluster.stats.CCSUsageTimeValue": {
"type": "object",
"properties": {
"max": {
"description": "The maximum time taken to execute a request, in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"avg": {
"description": "The average time taken to execute a request, in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"p90": {
"description": "The 90th percentile of the time taken to execute requests, in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"max",
"avg",
"p90"
]
},
"cluster.stats.CCSUsageClusterStats": {
"type": "object",
"properties": {
"total": {
"description": "The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.",
"type": "number"
},
"skipped": {
"description": "The total number of cross-cluster search requests for which this cluster was skipped.",
"type": "number"
},
"took": {
"description": "Statistics about the time taken to execute requests against this cluster.",
"allOf": [
{
"$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue"
}
]
}
},
"required": [
"total",
"skipped",
"took"
]
},
"nodes._types.NodesResponseBase": {
"type": "object",
"properties": {
"_nodes": {
"description": "Contains statistics about the number of nodes selected by the request’s node filters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
}
}
},
"_types.NodeStatistics": {
"description": "Contains statistics about the number of nodes selected by the request.",
"type": "object",
"properties": {
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
},
"total": {
"description": "Total number of nodes selected by the request.",
"type": "number"
},
"successful": {
"description": "Number of nodes that responded successfully to the request.",
"type": "number"
},
"failed": {
"description": "Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.",
"type": "number"
}
},
"required": [
"total",
"successful",
"failed"
]
},
"_types.Result": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"not_found",
"noop"
]
},
"connector._types.Connector": {
"type": "object",
"properties": {
"api_key_id": {
"type": "string"
},
"api_key_secret_id": {
"type": "string"
},
"configuration": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorConfiguration"
}
]
},
"custom_scheduling": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorCustomScheduling"
}
]
},
"deleted": {
"type": "boolean"
},
"description": {
"type": "string"
},
"error": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"features": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorFeatures"
}
]
},
"filtering": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connector._types.FilteringConfig"
}
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"index_name": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"nullable": true,
"type": "string"
}
]
},
"is_native": {
"type": "boolean"
},
"language": {
"type": "string"
},
"last_access_control_sync_error": {
"type": "string"
},
"last_access_control_sync_scheduled_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"last_access_control_sync_status": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.SyncStatus"
}
]
},
"last_deleted_document_count": {
"type": "number"
},
"last_incremental_sync_scheduled_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"last_indexed_document_count": {
"type": "number"
},
"last_seen": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"last_sync_error": {
"type": "string"
},
"last_sync_scheduled_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"last_sync_status": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.SyncStatus"
}
]
},
"last_synced": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"name": {
"type": "string"
},
"pipeline": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.IngestPipelineParams"
}
]
},
"scheduling": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.SchedulingConfiguration"
}
]
},
"service_type": {
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorStatus"
}
]
},
"sync_cursor": {
"type": "object"
},
"sync_now": {
"type": "boolean"
}
},
"required": [
"configuration",
"custom_scheduling",
"deleted",
"filtering",
"is_native",
"scheduling",
"status",
"sync_now"
]
},
"connector._types.ConnectorConfiguration": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/connector._types.ConnectorConfigProperties"
}
},
"connector._types.ConnectorConfigProperties": {
"type": "object",
"properties": {
"category": {
"type": "string"
},
"default_value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScalarValue"
}
]
},
"depends_on": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connector._types.Dependency"
}
},
"display": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.DisplayType"
}
]
},
"label": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connector._types.SelectOption"
}
},
"order": {
"type": "number"
},
"placeholder": {
"type": "string"
},
"required": {
"type": "boolean"
},
"sensitive": {
"type": "boolean"
},
"tooltip": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorFieldType"
}
]
},
"ui_restrictions": {
"type": "array",
"items": {
"type": "string"
}
},
"validations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connector._types.Validation"
}
},
"value": {
"type": "object"
}
},
"required": [
"default_value",
"depends_on",
"display",
"label",
"options",
"required",
"sensitive",
"value"
]
},
"_types.ScalarValue": {
"description": "A scalar value.",
"oneOf": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"nullable": true,
"type": "string"
}
]
},
"connector._types.Dependency": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScalarValue"
}
]
}
},
"required": [
"field",
"value"
]
},
"connector._types.DisplayType": {
"type": "string",
"enum": [
"textbox",
"textarea",
"numeric",
"toggle",
"dropdown"
]
},
"connector._types.SelectOption": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScalarValue"
}
]
}
},
"required": [
"label",
"value"
]
},
"connector._types.ConnectorFieldType": {
"type": "string",
"enum": [
"str",
"int",
"list",
"bool"
]
},
"connector._types.Validation": {
"discriminator": {
"propertyName": "type",
"mapping": {
"greater_than": "#/components/schemas/connector._types.GreaterThanValidation",
"included_in": "#/components/schemas/connector._types.IncludedInValidation",
"less_than": "#/components/schemas/connector._types.LessThanValidation",
"list_type": "#/components/schemas/connector._types.ListTypeValidation",
"regex": "#/components/schemas/connector._types.RegexValidation"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/connector._types.LessThanValidation"
},
{
"$ref": "#/components/schemas/connector._types.GreaterThanValidation"
},
{
"$ref": "#/components/schemas/connector._types.ListTypeValidation"
},
{
"$ref": "#/components/schemas/connector._types.IncludedInValidation"
},
{
"$ref": "#/components/schemas/connector._types.RegexValidation"
}
]
},
"connector._types.LessThanValidation": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"less_than"
]
},
"constraint": {
"type": "number"
}
},
"required": [
"type",
"constraint"
]
},
"connector._types.GreaterThanValidation": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"greater_than"
]
},
"constraint": {
"type": "number"
}
},
"required": [
"type",
"constraint"
]
},
"connector._types.ListTypeValidation": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"list_type"
]
},
"constraint": {
"type": "string"
}
},
"required": [
"type",
"constraint"
]
},
"connector._types.IncludedInValidation": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"included_in"
]
},
"constraint": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ScalarValue"
}
}
},
"required": [
"type",
"constraint"
]
},
"connector._types.RegexValidation": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"regex"
]
},
"constraint": {
"type": "string"
}
},
"required": [
"type",
"constraint"
]
},
"connector._types.ConnectorCustomScheduling": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/connector._types.CustomScheduling"
}
},
"connector._types.CustomScheduling": {
"type": "object",
"properties": {
"configuration_overrides": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.CustomSchedulingConfigurationOverrides"
}
]
},
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"last_synced": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"name": {
"type": "string"
}
},
"required": [
"configuration_overrides",
"enabled",
"interval",
"name"
]
},
"connector._types.CustomSchedulingConfigurationOverrides": {
"type": "object",
"properties": {
"max_crawl_depth": {
"type": "number"
},
"sitemap_discovery_disabled": {
"type": "boolean"
},
"domain_allowlist": {
"type": "array",
"items": {
"type": "string"
}
},
"sitemap_urls": {
"type": "array",
"items": {
"type": "string"
}
},
"seed_urls": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"connector._types.ConnectorFeatures": {
"type": "object",
"properties": {
"document_level_security": {
"description": "Indicates whether document-level security is enabled.",
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FeatureEnabled"
}
]
},
"incremental_sync": {
"description": "Indicates whether incremental syncs are enabled.",
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FeatureEnabled"
}
]
},
"native_connector_api_keys": {
"description": "Indicates whether managed connector API keys are enabled.",
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FeatureEnabled"
}
]
},
"sync_rules": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.SyncRulesFeature"
}
]
}
}
},
"connector._types.FeatureEnabled": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"connector._types.SyncRulesFeature": {
"type": "object",
"properties": {
"advanced": {
"description": "Indicates whether advanced sync rules are enabled.",
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FeatureEnabled"
}
]
},
"basic": {
"description": "Indicates whether basic sync rules are enabled.",
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FeatureEnabled"
}
]
}
}
},
"connector._types.FilteringConfig": {
"type": "object",
"properties": {
"active": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FilteringRules"
}
]
},
"domain": {
"type": "string"
},
"draft": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FilteringRules"
}
]
}
},
"required": [
"active",
"draft"
]
},
"connector._types.FilteringRules": {
"type": "object",
"properties": {
"advanced_snippet": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet"
}
]
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connector._types.FilteringRule"
}
},
"validation": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FilteringRulesValidation"
}
]
}
},
"required": [
"advanced_snippet",
"rules",
"validation"
]
},
"connector._types.FilteringAdvancedSnippet": {
"type": "object",
"properties": {
"created_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"updated_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"value": {
"type": "object"
}
},
"required": [
"value"
]
},
"connector._types.FilteringRule": {
"type": "object",
"properties": {
"created_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"order": {
"type": "number"
},
"policy": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FilteringPolicy"
}
]
},
"rule": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FilteringRuleRule"
}
]
},
"updated_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"value": {
"type": "string"
}
},
"required": [
"field",
"id",
"order",
"policy",
"rule",
"value"
]
},
"connector._types.FilteringPolicy": {
"type": "string",
"enum": [
"exclude",
"include"
]
},
"connector._types.FilteringRuleRule": {
"type": "string",
"enum": [
"contains",
"ends_with",
"equals",
"regex",
"starts_with",
">",
"<"
]
},
"connector._types.FilteringRulesValidation": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connector._types.FilteringValidation"
}
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FilteringValidationState"
}
]
}
},
"required": [
"errors",
"state"
]
},
"connector._types.FilteringValidation": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ids",
"messages"
]
},
"connector._types.FilteringValidationState": {
"type": "string",
"enum": [
"edited",
"invalid",
"valid"
]
},
"connector._types.SyncStatus": {
"type": "string",
"enum": [
"canceling",
"canceled",
"completed",
"error",
"in_progress",
"pending",
"suspended"
]
},
"connector._types.IngestPipelineParams": {
"type": "object",
"properties": {
"extract_binary_content": {
"type": "boolean"
},
"name": {
"type": "string"
},
"reduce_whitespace": {
"type": "boolean"
},
"run_ml_inference": {
"type": "boolean"
}
},
"required": [
"extract_binary_content",
"name",
"reduce_whitespace",
"run_ml_inference"
]
},
"connector._types.SchedulingConfiguration": {
"type": "object",
"properties": {
"access_control": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorScheduling"
}
]
},
"full": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorScheduling"
}
]
},
"incremental": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorScheduling"
}
]
}
}
},
"connector._types.ConnectorScheduling": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"description": "The interval is expressed using the crontab syntax",
"type": "string"
}
},
"required": [
"enabled",
"interval"
]
},
"connector._types.ConnectorStatus": {
"type": "string",
"enum": [
"created",
"needs_configuration",
"configured",
"connected",
"error"
]
},
"connector._types.ConnectorSyncJob": {
"type": "object",
"properties": {
"cancelation_requested_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"canceled_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"completed_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"connector": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.SyncJobConnectorReference"
}
]
},
"created_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"deleted_document_count": {
"type": "number"
},
"error": {
"type": "string"
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"indexed_document_count": {
"type": "number"
},
"indexed_document_volume": {
"type": "number"
},
"job_type": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.SyncJobType"
}
]
},
"last_seen": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"started_at": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.SyncStatus"
}
]
},
"total_document_count": {
"type": "number"
},
"trigger_method": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod"
}
]
},
"worker_hostname": {
"type": "string"
}
},
"required": [
"connector",
"created_at",
"deleted_document_count",
"id",
"indexed_document_count",
"indexed_document_volume",
"job_type",
"metadata",
"status",
"total_document_count",
"trigger_method"
]
},
"connector._types.SyncJobConnectorReference": {
"type": "object",
"properties": {
"configuration": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.ConnectorConfiguration"
}
]
},
"filtering": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.FilteringRules"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"index_name": {
"type": "string"
},
"language": {
"type": "string"
},
"pipeline": {
"allOf": [
{
"$ref": "#/components/schemas/connector._types.IngestPipelineParams"
}
]
},
"service_type": {
"type": "string"
},
"sync_cursor": {
"type": "object"
}
},
"required": [
"configuration",
"filtering",
"id",
"index_name",
"service_type"
]
},
"connector._types.SyncJobType": {
"type": "string",
"enum": [
"full",
"incremental",
"access_control"
]
},
"connector._types.SyncJobTriggerMethod": {
"type": "string",
"enum": [
"on_demand",
"scheduled"
]
},
"_types.WriteResponseBase": {
"type": "object",
"properties": {
"_id": {
"description": "The unique identifier for the added document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "The name of the index the document was added to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_primary_term": {
"description": "The primary term assigned to the document for the indexing operation.",
"type": "number"
},
"result": {
"description": "The result of the indexing operation: `created` or `updated`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Result"
}
]
},
"_seq_no": {
"description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"_shards": {
"description": "Information about the replication process of the operation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"_version": {
"description": "The document version, which is incremented each time the document is updated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"failure_store": {
"description": "The role of the failure store in this document response",
"allOf": [
{
"$ref": "#/components/schemas/_global.bulk.FailureStoreStatus"
}
]
},
"forced_refresh": {
"type": "boolean"
}
},
"required": [
"_id",
"_index",
"result",
"_shards",
"_version"
]
},
"dangling_indices.list_dangling_indices.DanglingIndex": {
"type": "object",
"properties": {
"index_name": {
"type": "string"
},
"index_uuid": {
"type": "string"
},
"creation_date_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"node_ids": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Ids"
}
]
}
},
"required": [
"index_name",
"index_uuid",
"creation_date_millis",
"node_ids"
]
},
"_types.Conflicts": {
"type": "string",
"enum": [
"abort",
"proceed"
]
},
"_types.Slices": {
"description": "Slices configuration used to parallelize a process.",
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/components/schemas/_types.SlicesCalculation"
}
]
},
"_types.SlicesCalculation": {
"type": "string",
"enum": [
"auto"
]
},
"tasks._types.TaskListResponseBase": {
"type": "object",
"properties": {
"node_failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
},
"task_failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.TaskFailure"
}
},
"nodes": {
"description": "Task information grouped by node, if `group_by` was set to `node` (the default).",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/tasks._types.NodeTasks"
}
},
"tasks": {
"description": "Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if\n`group_by` was set to `parents`.",
"allOf": [
{
"$ref": "#/components/schemas/tasks._types.TaskInfos"
}
]
}
}
},
"_types.TaskFailure": {
"type": "object",
"properties": {
"task_id": {
"type": "number"
},
"node_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
}
]
},
"status": {
"type": "string"
},
"reason": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"task_id",
"node_id",
"status",
"reason"
]
},
"tasks._types.NodeTasks": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
}
]
},
"transport_address": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"host": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"ip": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Ip"
}
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/tasks._types.TaskInfo"
}
}
},
"required": [
"tasks"
]
},
"tasks._types.TaskInfo": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"cancelled": {
"type": "boolean"
},
"cancellable": {
"type": "boolean"
},
"description": {
"description": "Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.",
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "number"
},
"node": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
}
]
},
"running_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"running_time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"start_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"status": {
"description": "The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.",
"type": "object"
},
"type": {
"type": "string"
},
"parent_task_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TaskId"
}
]
},
"original_task_id": {
"description": "The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TaskId"
}
]
},
"original_start_time_in_millis": {
"description": "The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"original_start_time": {
"description": "The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter.",
"type": "string"
}
},
"required": [
"action",
"cancellable",
"headers",
"id",
"node",
"running_time_in_nanos",
"start_time_in_millis",
"type"
]
},
"tasks._types.TaskInfos": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/tasks._types.TaskInfo"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/tasks._types.ParentTaskInfo"
}
}
]
},
"tasks._types.ParentTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/tasks._types.TaskInfo"
},
{
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasks._types.TaskInfo"
}
}
}
}
]
},
"enrich.execute_policy.ExecuteEnrichPolicyStatus": {
"type": "object",
"properties": {
"phase": {
"allOf": [
{
"$ref": "#/components/schemas/enrich.execute_policy.EnrichPolicyPhase"
}
]
},
"step": {
"type": "string"
}
},
"required": [
"phase"
]
},
"enrich.execute_policy.EnrichPolicyPhase": {
"type": "string",
"enum": [
"SCHEDULED",
"RUNNING",
"COMPLETE",
"FAILED",
"CANCELLED"
]
},
"enrich._types.Summary": {
"type": "object",
"properties": {
"config": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/enrich._types.Policy"
},
"minProperties": 1,
"maxProperties": 1
}
},
"required": [
"config"
]
},
"enrich._types.Policy": {
"type": "object",
"properties": {
"enrich_fields": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"indices": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"match_field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"query": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"elasticsearch_version": {
"type": "string"
}
},
"required": [
"enrich_fields",
"indices",
"match_field"
]
},
"enrich.stats.CoordinatorStats": {
"type": "object",
"properties": {
"executed_searches_total": {
"type": "number"
},
"node_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"queue_size": {
"type": "number"
},
"remote_requests_current": {
"type": "number"
},
"remote_requests_total": {
"type": "number"
}
},
"required": [
"executed_searches_total",
"node_id",
"queue_size",
"remote_requests_current",
"remote_requests_total"
]
},
"enrich.stats.ExecutingPolicy": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"task": {
"allOf": [
{
"$ref": "#/components/schemas/tasks._types.TaskInfo"
}
]
}
},
"required": [
"name",
"task"
]
},
"enrich.stats.CacheStats": {
"type": "object",
"properties": {
"node_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"count": {
"type": "number"
},
"hits": {
"type": "number"
},
"hits_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"misses": {
"type": "number"
},
"misses_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"evictions": {
"type": "number"
},
"size_in_bytes": {
"type": "number"
}
},
"required": [
"node_id",
"count",
"hits",
"hits_time_in_millis",
"misses",
"misses_time_in_millis",
"evictions",
"size_in_bytes"
]
},
"eql._types.EqlSearchResponseBase": {
"type": "object",
"properties": {
"id": {
"description": "Identifier for the search.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"is_partial": {
"description": "If true, the response does not contain complete search results.",
"type": "boolean"
},
"is_running": {
"description": "If true, the search request is still executing.",
"type": "boolean"
},
"took": {
"description": "Milliseconds it took Elasticsearch to execute the request.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"timed_out": {
"description": "If true, the request timed out before completion.",
"type": "boolean"
},
"hits": {
"description": "Contains matching events and sequences. Also contains related metadata.",
"allOf": [
{
"$ref": "#/components/schemas/eql._types.EqlHits"
}
]
},
"shard_failures": {
"description": "Contains information about shard failures (if any), in case allow_partial_search_results=true",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ShardFailure"
}
}
},
"required": [
"hits"
]
},
"eql._types.EqlHits": {
"type": "object",
"properties": {
"total": {
"description": "Metadata about the number of matching events or sequences.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.TotalHits"
}
]
},
"events": {
"description": "Contains events matching the query. Each object represents a matching event.",
"type": "array",
"items": {
"$ref": "#/components/schemas/eql._types.HitsEvent"
}
},
"sequences": {
"description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.",
"type": "array",
"items": {
"$ref": "#/components/schemas/eql._types.HitsSequence"
}
}
}
},
"eql._types.HitsEvent": {
"type": "object",
"properties": {
"_index": {
"description": "Name of the index containing the event.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_id": {
"description": "Unique identifier for the event. This ID is only unique within the index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_source": {
"description": "Original JSON body passed for the event at index time.",
"type": "object"
},
"missing": {
"description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.",
"type": "boolean"
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"required": [
"_index",
"_id",
"_source"
]
},
"eql._types.HitsSequence": {
"type": "object",
"properties": {
"events": {
"description": "Contains events matching the query. Each object represents a matching event.",
"type": "array",
"items": {
"$ref": "#/components/schemas/eql._types.HitsEvent"
}
},
"join_keys": {
"description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.",
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"events"
]
},
"eql.search.ResultPosition": {
"type": "string",
"enum": [
"tail",
"head"
]
},
"esql._types.EsqlFormat": {
"type": "string",
"enum": [
"csv",
"json",
"tsv",
"txt",
"yaml",
"cbor",
"smile",
"arrow"
]
},
"esql._types.ESQLParams": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.SingleOrMultiValue"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.NamedValue"
}
}
]
},
"esql._types.SingleOrMultiValue": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.FieldValue"
}
}
]
},
"esql._types.NamedValue": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/esql._types.SingleOrMultiValue"
},
"minProperties": 1,
"maxProperties": 1
},
"esql._types.TableValuesContainer": {
"type": "object",
"properties": {
"integer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.TableValuesIntegerValue"
}
},
"keyword": {
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.TableValuesKeywordValue"
}
},
"long": {
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.TableValuesLongValue"
}
},
"double": {
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.TableValuesLongDouble"
}
}
},
"minProperties": 1,
"maxProperties": 1
},
"esql._types.TableValuesIntegerValue": {
"oneOf": [
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "number"
}
}
]
},
"esql._types.TableValuesKeywordValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"esql._types.TableValuesLongValue": {
"oneOf": [
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "number"
}
}
]
},
"esql._types.TableValuesLongDouble": {
"oneOf": [
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "number"
}
}
]
},
"esql._types.AsyncEsqlResult": {
"allOf": [
{
"$ref": "#/components/schemas/esql._types.EsqlResult"
},
{
"type": "object",
"properties": {
"id": {
"description": "The ID of the async query, to be used in subsequent requests to check the status or retrieve results.\n\nAlso available in the `X-Elasticsearch-Async-Id` HTTP header.",
"type": "string"
},
"is_running": {
"description": "Indicates whether the async query is still running or has completed.\n\nAlso available in the `X-Elasticsearch-Async-Is-Running` HTTP header.",
"type": "boolean"
}
},
"required": [
"is_running"
]
}
]
},
"esql._types.EsqlResult": {
"type": "object",
"properties": {
"took": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"is_partial": {
"type": "boolean"
},
"all_columns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.EsqlColumnInfo"
}
},
"columns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.EsqlColumnInfo"
}
},
"values": {
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.FieldValue"
}
}
},
"_clusters": {
"description": "Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request\nand a cross-cluster search was performed.",
"allOf": [
{
"$ref": "#/components/schemas/esql._types.EsqlClusterInfo"
}
]
},
"profile": {
"description": "Profiling information. Present if `profile` was `true` in the request.\nThe contents of this field are currently unstable.",
"type": "object"
}
},
"required": [
"columns",
"values"
]
},
"esql._types.EsqlColumnInfo": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
]
},
"esql._types.EsqlClusterInfo": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"successful": {
"type": "number"
},
"running": {
"type": "number"
},
"skipped": {
"type": "number"
},
"partial": {
"type": "number"
},
"failed": {
"type": "number"
},
"details": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/esql._types.EsqlClusterDetails"
}
}
},
"required": [
"total",
"successful",
"running",
"skipped",
"partial",
"failed",
"details"
]
},
"esql._types.EsqlClusterDetails": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/esql._types.EsqlClusterStatus"
}
]
},
"indices": {
"type": "string"
},
"took": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/esql._types.EsqlShardInfo"
}
]
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.EsqlShardFailure"
}
}
},
"required": [
"status",
"indices"
]
},
"esql._types.EsqlClusterStatus": {
"type": "string",
"enum": [
"running",
"successful",
"partial",
"skipped",
"failed"
]
},
"esql._types.EsqlShardInfo": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"successful": {
"type": "number"
},
"skipped": {
"type": "number"
},
"failed": {
"type": "number"
}
},
"required": [
"total"
]
},
"esql._types.EsqlShardFailure": {
"type": "object",
"properties": {
"shard": {
"type": "number"
},
"index": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"nullable": true,
"type": "string"
}
]
},
"node": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
}
]
},
"reason": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"shard",
"index",
"reason"
]
},
"esql._types.ESQLView": {
"description": "A non-materialized ES|QL view.",
"type": "object",
"properties": {
"name": {
"description": "The name of the ES|QL view",
"type": "string"
},
"query": {
"description": "The ES|QL query",
"type": "string"
}
},
"required": [
"name",
"query"
]
},
"esql.list_queries.Body": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"node": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
}
]
},
"start_time_millis": {
"type": "number"
},
"running_time_nanos": {
"type": "number"
},
"query": {
"type": "string"
}
},
"required": [
"id",
"node",
"start_time_millis",
"running_time_nanos",
"query"
]
},
"_types.InlineGet": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"found": {
"type": "boolean"
},
"_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"_primary_term": {
"type": "number"
},
"_routing": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Routing"
}
]
},
"_source": {
"type": "object"
}
},
"required": [
"found"
]
},
"features._types.Feature": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"name",
"description"
]
},
"_global.field_caps.FieldCapability": {
"type": "object",
"properties": {
"aggregatable": {
"description": "Whether this field can be aggregated on all indices.",
"type": "boolean"
},
"indices": {
"description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"meta": {
"description": "Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"non_aggregatable_indices": {
"description": "The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"non_searchable_indices": {
"description": "The list of indices where this field is not searchable, or null if all indices have the same definition for the field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"searchable": {
"description": "Whether this field is indexed for search on all indices.",
"type": "boolean"
},
"type": {
"type": "string"
},
"metadata_field": {
"description": "Whether this field is registered as a metadata field.",
"type": "boolean"
},
"time_series_dimension": {
"description": "Whether this field is used as a time series dimension.",
"x-state": "Experimental; Added in 8.0.0",
"type": "boolean"
},
"time_series_metric": {
"description": "Contains metric type if this fields is used as a time series\nmetrics, absent if the field is not used as metric.",
"x-state": "Experimental; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
}
]
},
"non_dimension_indices": {
"description": "If this list is present in response then some indices have the\nfield marked as a dimension and other indices, the ones in this list, do not.",
"x-state": "Experimental; Added in 8.0.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
},
"metric_conflicts_indices": {
"description": "The list of indices where this field is present if these indices\ndon’t have the same `time_series_metric` value for this field.",
"x-state": "Experimental; Added in 8.0.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
},
"required": [
"aggregatable",
"searchable",
"type"
]
},
"_types.IndexAlias": {
"type": "string"
},
"fleet._types.Checkpoint": {
"type": "number"
},
"_global.msearch.RequestItem": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.msearch.MultisearchHeader"
},
{
"$ref": "#/components/schemas/_global.search._types.SearchRequestBody"
}
]
},
"_global.msearch.MultisearchHeader": {
"description": "Contains parameters used to limit or change the subsequent search body request.",
"type": "object",
"properties": {
"allow_no_indices": {
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"type": "boolean"
},
"expand_wildcards": {
"description": "\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",
"allOf": [
{
"$ref": "#/components/schemas/_types.ExpandWildcards"
}
]
},
"ignore_unavailable": {
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"type": "boolean"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"preference": {
"type": "string"
},
"project_routing": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ProjectRouting"
}
]
},
"request_cache": {
"type": "boolean"
},
"routing": {
"description": "A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Routing"
}
]
},
"search_type": {
"description": "\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.SearchType"
}
]
},
"ccs_minimize_roundtrips": {
"type": "boolean"
},
"allow_partial_search_results": {
"type": "boolean"
},
"ignore_throttled": {
"type": "boolean"
}
}
},
"_types.ProjectRouting": {
"type": "string"
},
"_global.msearch.ResponseItem": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.msearch.MultiSearchItem"
},
{
"$ref": "#/components/schemas/_types.ErrorResponseBase"
}
]
},
"_global.msearch.MultiSearchItem": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search.ResponseBody"
},
{
"type": "object",
"properties": {
"status": {
"type": "number"
}
}
}
]
},
"_global.search.ResponseBody": {
"type": "object",
"properties": {
"took": {
"description": "The number of milliseconds it took Elasticsearch to run the request.\nThis value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response.\nIt includes:\n\n* Communication time between the coordinating node and data nodes\n* Time the request spends in the search thread pool, queued for execution\n* Actual run time\n\nIt does not include:\n\n* Time needed to send the request to Elasticsearch\n* Time needed to serialize the JSON response\n* Time needed to send the response to a client",
"type": "number"
},
"timed_out": {
"description": "If `true`, the request timed out before completion; returned results may be partial or empty.",
"type": "boolean"
},
"_shards": {
"description": "A count of shards used for the request.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"hits": {
"description": "The returned documents and metadata.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HitsMetadata"
}
]
},
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.Aggregate"
}
},
"_clusters": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ClusterStatistics"
}
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"max_score": {
"type": "number"
},
"num_reduce_phases": {
"type": "number"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Profile"
}
]
},
"pit_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_scroll_id": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results"
},
"description": "The identifier for the search and its search context.\nYou can use this scroll ID with the scroll API to retrieve the next batch of search results for the request.\nThis property is returned only if the `scroll` query parameter is specified in the request.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScrollId"
}
]
},
"suggest": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Suggest"
}
}
},
"terminated_early": {
"type": "boolean"
}
},
"required": [
"took",
"timed_out",
"_shards",
"hits"
]
},
"_types.ErrorResponseBase": {
"description": "The response returned by Elasticsearch when request execution did not succeed.",
"type": "object",
"properties": {
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"status": {
"type": "number"
}
},
"required": [
"error",
"status"
]
},
"_global.get.GetResult": {
"type": "object",
"properties": {
"_index": {
"description": "The name of the index the document belongs to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"fields": {
"description": "If the `stored_fields` parameter is set to `true` and `found` is `true`, it contains the document fields stored in the index.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"_ignored": {
"type": "array",
"items": {
"type": "string"
}
},
"found": {
"description": "Indicates whether the document exists.",
"type": "boolean"
},
"_id": {
"description": "The unique identifier for the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_primary_term": {
"description": "The primary term assigned to the document for the indexing operation.",
"type": "number"
},
"_routing": {
"description": "The explicit routing, if set.",
"type": "string"
},
"_seq_no": {
"description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"_source": {
"description": "If `found` is `true`, it contains the document data formatted in JSON.\nIf the `_source` parameter is set to `false` or the `stored_fields` parameter is set to `true`, it is excluded.",
"type": "object"
},
"_version": {
"description": "The document version, which is ncremented each time the document is updated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"_index",
"found",
"_id"
]
},
"_types.StoredScript": {
"type": "object",
"properties": {
"lang": {
"description": "The language the script is written in.\nFor search templates, use `mustache`.\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptLanguage"
}
]
},
"options": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"source": {
"description": "The script source.\nFor search templates, an object containing the search template.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSource"
}
]
}
},
"required": [
"lang",
"source"
]
},
"_global.get_script_context.Context": {
"type": "object",
"properties": {
"methods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.get_script_context.ContextMethod"
}
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"methods",
"name"
]
},
"_global.get_script_context.ContextMethod": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"return_type": {
"type": "string"
},
"params": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.get_script_context.ContextMethodParam"
}
}
},
"required": [
"name",
"return_type",
"params"
]
},
"_global.get_script_context.ContextMethodParam": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
]
},
"_global.get_script_languages.LanguageContext": {
"type": "object",
"properties": {
"contexts": {
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"description": "\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptLanguage"
}
]
}
},
"required": [
"contexts",
"language"
]
},
"graph._types.Hop": {
"type": "object",
"properties": {
"connections": {
"description": "Specifies one or more fields from which you want to extract terms that are associated with the specified vertices.",
"allOf": [
{
"$ref": "#/components/schemas/graph._types.Hop"
}
]
},
"query": {
"description": "An optional guiding query that constrains the Graph API as it explores connected terms.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"vertices": {
"description": "Contains the fields you are interested in.",
"type": "array",
"items": {
"$ref": "#/components/schemas/graph._types.VertexDefinition"
}
}
},
"required": [
"vertices"
]
},
"graph._types.VertexDefinition": {
"type": "object",
"properties": {
"exclude": {
"description": "Prevents the specified terms from being included in the results.",
"type": "array",
"items": {
"type": "string"
}
},
"field": {
"description": "Identifies a field in the documents of interest.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"include": {
"description": "Identifies the terms of interest that form the starting points from which you want to spider out.",
"type": "array",
"items": {
"$ref": "#/components/schemas/graph._types.VertexInclude"
}
},
"min_doc_count": {
"description": "Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.\nThis setting acts as a certainty threshold.",
"default": 3,
"type": "number"
},
"shard_min_doc_count": {
"description": "Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration.",
"default": 2,
"type": "number"
},
"size": {
"description": "Specifies the maximum number of vertex terms returned for each field.",
"default": 5,
"type": "number"
}
},
"required": [
"field"
]
},
"graph._types.VertexInclude": {
"type": "object",
"properties": {
"boost": {
"type": "number"
},
"term": {
"type": "string"
}
},
"required": [
"term"
]
},
"graph._types.ExploreControls": {
"type": "object",
"properties": {
"sample_diversity": {
"description": "To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.\nYou can do this by selecting a single-value field and setting a maximum number of documents per value for that field.",
"allOf": [
{
"$ref": "#/components/schemas/graph._types.SampleDiversity"
}
]
},
"sample_size": {
"description": "Each hop considers a sample of the best-matching documents on each shard.\nUsing samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.\nVery small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.\nVery large sample sizes can dilute the quality of the results and increase execution times.",
"default": 100,
"type": "number"
},
"timeout": {
"description": "The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.\nThis timeout is honored on a best-effort basis.\nExecution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"use_significance": {
"description": "Filters associated terms so only those that are significantly associated with your query are included.",
"type": "boolean"
}
},
"required": [
"use_significance"
]
},
"graph._types.SampleDiversity": {
"type": "object",
"properties": {
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"max_docs_per_value": {
"type": "number"
}
},
"required": [
"field",
"max_docs_per_value"
]
},
"graph._types.Connection": {
"type": "object",
"properties": {
"doc_count": {
"type": "number"
},
"source": {
"type": "number"
},
"target": {
"type": "number"
},
"weight": {
"type": "number"
}
},
"required": [
"doc_count",
"source",
"target",
"weight"
]
},
"graph._types.Vertex": {
"type": "object",
"properties": {
"depth": {
"type": "number"
},
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"term": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"required": [
"depth",
"field",
"term",
"weight"
]
},
"_global.health_report.Indicators": {
"type": "object",
"properties": {
"master_is_stable": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicator"
}
]
},
"shards_availability": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.ShardsAvailabilityIndicator"
}
]
},
"disk": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.DiskIndicator"
}
]
},
"repository_integrity": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.RepositoryIntegrityIndicator"
}
]
},
"data_stream_lifecycle": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.DataStreamLifecycleIndicator"
}
]
},
"ilm": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.IlmIndicator"
}
]
},
"slm": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.SlmIndicator"
}
]
},
"shards_capacity": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicator"
}
]
},
"file_settings": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.FileSettingsIndicator"
}
]
}
}
},
"_global.health_report.MasterIsStableIndicator": {
"description": "MASTER_IS_STABLE",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicatorDetails"
}
]
}
}
}
]
},
"_global.health_report.MasterIsStableIndicatorDetails": {
"type": "object",
"properties": {
"current_master": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.IndicatorNode"
}
]
},
"recent_masters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.health_report.IndicatorNode"
}
},
"exception_fetching_history": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicatorExceptionFetchingHistory"
}
]
},
"cluster_formation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicatorClusterFormationNode"
}
}
},
"required": [
"current_master",
"recent_masters"
]
},
"_global.health_report.IndicatorNode": {
"type": "object",
"properties": {
"name": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"node_id": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
}
},
"required": [
"name",
"node_id"
]
},
"_global.health_report.MasterIsStableIndicatorExceptionFetchingHistory": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"stack_trace": {
"type": "string"
}
},
"required": [
"message",
"stack_trace"
]
},
"_global.health_report.MasterIsStableIndicatorClusterFormationNode": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"cluster_formation_message": {
"type": "string"
}
},
"required": [
"node_id",
"cluster_formation_message"
]
},
"_global.health_report.BaseIndicator": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.IndicatorHealthStatus"
}
]
},
"symptom": {
"type": "string"
},
"impacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.health_report.Impact"
}
},
"diagnosis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.health_report.Diagnosis"
}
}
},
"required": [
"status",
"symptom"
]
},
"_global.health_report.IndicatorHealthStatus": {
"type": "string",
"enum": [
"green",
"yellow",
"red",
"unknown",
"unavailable"
]
},
"_global.health_report.Impact": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"impact_areas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.health_report.ImpactArea"
}
},
"severity": {
"type": "number"
}
},
"required": [
"description",
"id",
"impact_areas",
"severity"
]
},
"_global.health_report.ImpactArea": {
"type": "string",
"enum": [
"search",
"ingest",
"backup",
"deployment_management"
]
},
"_global.health_report.Diagnosis": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"action": {
"type": "string"
},
"affected_resources": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.DiagnosisAffectedResources"
}
]
},
"cause": {
"type": "string"
},
"help_url": {
"type": "string"
}
},
"required": [
"id",
"action",
"affected_resources",
"cause",
"help_url"
]
},
"_global.health_report.DiagnosisAffectedResources": {
"type": "object",
"properties": {
"indices": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.health_report.IndicatorNode"
}
},
"slm_policies": {
"type": "array",
"items": {
"type": "string"
}
},
"feature_states": {
"type": "array",
"items": {
"type": "string"
}
},
"snapshot_repositories": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"_global.health_report.ShardsAvailabilityIndicator": {
"description": "SHARDS_AVAILABILITY",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.ShardsAvailabilityIndicatorDetails"
}
]
}
}
}
]
},
"_global.health_report.ShardsAvailabilityIndicatorDetails": {
"type": "object",
"properties": {
"creating_primaries": {
"type": "number"
},
"creating_replicas": {
"type": "number"
},
"initializing_primaries": {
"type": "number"
},
"initializing_replicas": {
"type": "number"
},
"restarting_primaries": {
"type": "number"
},
"restarting_replicas": {
"type": "number"
},
"started_primaries": {
"type": "number"
},
"started_replicas": {
"type": "number"
},
"unassigned_primaries": {
"type": "number"
},
"unassigned_replicas": {
"type": "number"
}
},
"required": [
"creating_primaries",
"creating_replicas",
"initializing_primaries",
"initializing_replicas",
"restarting_primaries",
"restarting_replicas",
"started_primaries",
"started_replicas",
"unassigned_primaries",
"unassigned_replicas"
]
},
"_global.health_report.DiskIndicator": {
"description": "DISK",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.DiskIndicatorDetails"
}
]
}
}
}
]
},
"_global.health_report.DiskIndicatorDetails": {
"type": "object",
"properties": {
"indices_with_readonly_block": {
"type": "number"
},
"nodes_with_enough_disk_space": {
"type": "number"
},
"nodes_over_high_watermark": {
"type": "number"
},
"nodes_over_flood_stage_watermark": {
"type": "number"
},
"nodes_with_unknown_disk_status": {
"type": "number"
}
},
"required": [
"indices_with_readonly_block",
"nodes_with_enough_disk_space",
"nodes_over_high_watermark",
"nodes_over_flood_stage_watermark",
"nodes_with_unknown_disk_status"
]
},
"_global.health_report.RepositoryIntegrityIndicator": {
"description": "REPOSITORY_INTEGRITY",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.RepositoryIntegrityIndicatorDetails"
}
]
}
}
}
]
},
"_global.health_report.RepositoryIntegrityIndicatorDetails": {
"type": "object",
"properties": {
"total_repositories": {
"type": "number"
},
"corrupted_repositories": {
"type": "number"
},
"corrupted": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"_global.health_report.DataStreamLifecycleIndicator": {
"description": "DATA_STREAM_LIFECYCLE",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.DataStreamLifecycleDetails"
}
]
}
}
}
]
},
"_global.health_report.DataStreamLifecycleDetails": {
"type": "object",
"properties": {
"stagnating_backing_indices_count": {
"type": "number"
},
"total_backing_indices_in_error": {
"type": "number"
},
"stagnating_backing_indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.health_report.StagnatingBackingIndices"
}
}
},
"required": [
"stagnating_backing_indices_count",
"total_backing_indices_in_error"
]
},
"_global.health_report.StagnatingBackingIndices": {
"type": "object",
"properties": {
"index_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"first_occurrence_timestamp": {
"type": "number"
},
"retry_count": {
"type": "number"
}
},
"required": [
"index_name",
"first_occurrence_timestamp",
"retry_count"
]
},
"_global.health_report.IlmIndicator": {
"description": "ILM",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.IlmIndicatorDetails"
}
]
}
}
}
]
},
"_global.health_report.IlmIndicatorDetails": {
"type": "object",
"properties": {
"ilm_status": {
"allOf": [
{
"$ref": "#/components/schemas/_types.LifecycleOperationMode"
}
]
},
"policies": {
"type": "number"
},
"stagnating_indices": {
"type": "number"
}
},
"required": [
"ilm_status",
"policies",
"stagnating_indices"
]
},
"_types.LifecycleOperationMode": {
"type": "string",
"enum": [
"RUNNING",
"STOPPING",
"STOPPED"
]
},
"_global.health_report.SlmIndicator": {
"description": "SLM",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.SlmIndicatorDetails"
}
]
}
}
}
]
},
"_global.health_report.SlmIndicatorDetails": {
"type": "object",
"properties": {
"slm_status": {
"allOf": [
{
"$ref": "#/components/schemas/_types.LifecycleOperationMode"
}
]
},
"policies": {
"type": "number"
},
"unhealthy_policies": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.SlmIndicatorUnhealthyPolicies"
}
]
}
},
"required": [
"slm_status",
"policies"
]
},
"_global.health_report.SlmIndicatorUnhealthyPolicies": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"invocations_since_last_success": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"count"
]
},
"_global.health_report.ShardsCapacityIndicator": {
"description": "SHARDS_CAPACITY",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorDetails"
}
]
}
}
}
]
},
"_global.health_report.ShardsCapacityIndicatorDetails": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorTierDetail"
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorTierDetail"
}
]
}
},
"required": [
"data",
"frozen"
]
},
"_global.health_report.ShardsCapacityIndicatorTierDetail": {
"type": "object",
"properties": {
"max_shards_in_cluster": {
"type": "number"
},
"current_used_shards": {
"type": "number"
}
},
"required": [
"max_shards_in_cluster"
]
},
"_global.health_report.FileSettingsIndicator": {
"description": "FILE_SETTINGS",
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.BaseIndicator"
},
{
"type": "object",
"properties": {
"details": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.FileSettingsIndicatorDetails"
}
]
}
}
}
]
},
"_global.health_report.FileSettingsIndicatorDetails": {
"type": "object",
"properties": {
"failure_streak": {
"type": "number"
},
"most_recent_failure": {
"type": "string"
}
},
"required": [
"failure_streak",
"most_recent_failure"
]
},
"ilm.explain_lifecycle.LifecycleExplain": {
"discriminator": {
"propertyName": "managed",
"mapping": {
"false": "#/components/schemas/ilm.explain_lifecycle.LifecycleExplainUnmanaged",
"true": "#/components/schemas/ilm.explain_lifecycle.LifecycleExplainManaged"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/ilm.explain_lifecycle.LifecycleExplainManaged"
},
{
"$ref": "#/components/schemas/ilm.explain_lifecycle.LifecycleExplainUnmanaged"
}
]
},
"ilm.explain_lifecycle.LifecycleExplainManaged": {
"type": "object",
"properties": {
"action": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"action_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"action_time_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"age": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"age_in_millis": {
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"failed_step": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"failed_step_retry_count": {
"type": "number"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"index_creation_date": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"index_creation_date_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"is_auto_retryable_error": {
"type": "boolean"
},
"lifecycle_date": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"lifecycle_date_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"managed": {
"type": "string",
"enum": [
"true"
]
},
"phase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"phase_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"phase_time_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"policy": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"previous_step_info": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"repository_name": {
"type": "string"
},
"snapshot_name": {
"type": "string"
},
"shrink_index_name": {
"type": "string"
},
"step": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"step_info": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"step_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"step_time_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"phase_execution": {
"allOf": [
{
"$ref": "#/components/schemas/ilm.explain_lifecycle.LifecycleExplainPhaseExecution"
}
]
},
"time_since_index_creation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"skip": {
"type": "boolean"
}
},
"required": [
"index",
"managed",
"skip"
]
},
"ilm.explain_lifecycle.LifecycleExplainPhaseExecution": {
"type": "object",
"properties": {
"phase_definition": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Phase"
}
]
},
"policy": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"modified_date_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"policy",
"version",
"modified_date_in_millis"
]
},
"ilm._types.Phase": {
"type": "object",
"properties": {
"actions": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Actions"
}
]
},
"min_age": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"ilm._types.Actions": {
"type": "object",
"properties": {
"allocate": {
"description": "Phases allowed: warm, cold.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.AllocateAction"
}
]
},
"delete": {
"description": "Phases allowed: delete.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.DeleteAction"
}
]
},
"downsample": {
"description": "Phases allowed: hot, warm, cold.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.DownsampleAction"
}
]
},
"freeze": {
"deprecated": true,
"description": "The freeze action is a noop in 8.x",
"allOf": [
{
"$ref": "#/components/schemas/_types.EmptyObject"
}
]
},
"forcemerge": {
"description": "Phases allowed: hot, warm.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.ForceMergeAction"
}
]
},
"migrate": {
"description": "Phases allowed: warm, cold.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.MigrateAction"
}
]
},
"readonly": {
"description": "Phases allowed: hot, warm, cold.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EmptyObject"
}
]
},
"rollover": {
"description": "Phases allowed: hot.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.RolloverAction"
}
]
},
"set_priority": {
"description": "Phases allowed: hot, warm, cold.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.SetPriorityAction"
}
]
},
"searchable_snapshot": {
"description": "Phases allowed: hot, cold, frozen.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.SearchableSnapshotAction"
}
]
},
"shrink": {
"description": "Phases allowed: hot, warm.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.ShrinkAction"
}
]
},
"unfollow": {
"description": "Phases allowed: hot, warm, cold, frozen.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EmptyObject"
}
]
},
"wait_for_snapshot": {
"description": "Phases allowed: delete.",
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.WaitForSnapshotAction"
}
]
}
}
},
"ilm._types.AllocateAction": {
"type": "object",
"properties": {
"number_of_replicas": {
"type": "number"
},
"total_shards_per_node": {
"type": "number"
},
"include": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"exclude": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"require": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"ilm._types.DeleteAction": {
"type": "object",
"properties": {
"delete_searchable_snapshot": {
"type": "boolean"
}
}
},
"ilm._types.DownsampleAction": {
"type": "object",
"properties": {
"fixed_interval": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationLarge"
}
]
},
"wait_timeout": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"fixed_interval"
]
},
"ilm._types.ForceMergeAction": {
"type": "object",
"properties": {
"max_num_segments": {
"type": "number"
},
"index_codec": {
"type": "string"
}
},
"required": [
"max_num_segments"
]
},
"ilm._types.MigrateAction": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"ilm._types.RolloverAction": {
"type": "object",
"properties": {
"max_size": {
"deprecated": true,
"description": "The `max_size` condition has been deprecated in 9.3.0 and `max_primary_shard_size` should be used instead",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_primary_shard_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_age": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_docs": {
"type": "number"
},
"max_primary_shard_docs": {
"type": "number"
},
"min_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"min_primary_shard_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"min_age": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"min_docs": {
"type": "number"
},
"min_primary_shard_docs": {
"type": "number"
}
}
},
"ilm._types.SetPriorityAction": {
"type": "object",
"properties": {
"priority": {
"type": "number"
}
}
},
"ilm._types.SearchableSnapshotAction": {
"type": "object",
"properties": {
"snapshot_repository": {
"type": "string"
},
"force_merge_index": {
"type": "boolean"
}
},
"required": [
"snapshot_repository"
]
},
"ilm._types.ShrinkAction": {
"type": "object",
"properties": {
"number_of_shards": {
"type": "number"
},
"max_primary_shard_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"allow_write_after_shrink": {
"type": "boolean"
}
}
},
"ilm._types.WaitForSnapshotAction": {
"type": "object",
"properties": {
"policy": {
"type": "string"
}
},
"required": [
"policy"
]
},
"ilm.explain_lifecycle.LifecycleExplainUnmanaged": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"managed": {
"type": "string",
"enum": [
"false"
]
}
},
"required": [
"index",
"managed"
]
},
"ilm.get_lifecycle.Lifecycle": {
"type": "object",
"properties": {
"modified_date": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"policy": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Policy"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"modified_date",
"policy",
"version"
]
},
"ilm._types.Policy": {
"type": "object",
"properties": {
"phases": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Phases"
}
]
},
"_meta": {
"description": "Arbitrary metadata that is not automatically generated or used by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
},
"required": [
"phases"
]
},
"ilm._types.Phases": {
"type": "object",
"properties": {
"cold": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Phase"
}
]
},
"delete": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Phase"
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Phase"
}
]
},
"hot": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Phase"
}
]
},
"warm": {
"allOf": [
{
"$ref": "#/components/schemas/ilm._types.Phase"
}
]
}
}
},
"ilm.move_to_step.StepKey": {
"type": "object",
"properties": {
"action": {
"description": "The optional action to which the index will be moved.",
"type": "string"
},
"name": {
"description": "The optional step name to which the index will be moved.",
"type": "string"
},
"phase": {
"type": "string"
}
},
"required": [
"phase"
]
},
"_types.OpType": {
"type": "string",
"enum": [
"index",
"create"
]
},
"indices._types.IndicesBlockOptions": {
"type": "string",
"enum": [
"metadata",
"read",
"read_only",
"write"
]
},
"indices.add_block.AddIndicesBlockStatus": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"blocked": {
"type": "boolean"
}
},
"required": [
"name",
"blocked"
]
},
"indices.analyze.TextToAnalyze": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"indices.analyze.AnalyzeDetail": {
"type": "object",
"properties": {
"analyzer": {
"allOf": [
{
"$ref": "#/components/schemas/indices.analyze.AnalyzerDetail"
}
]
},
"charfilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.analyze.CharFilterDetail"
}
},
"custom_analyzer": {
"type": "boolean"
},
"tokenfilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.analyze.TokenDetail"
}
},
"tokenizer": {
"allOf": [
{
"$ref": "#/components/schemas/indices.analyze.TokenDetail"
}
]
}
},
"required": [
"custom_analyzer"
]
},
"indices.analyze.AnalyzerDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tokens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.analyze.ExplainAnalyzeToken"
}
}
},
"required": [
"name",
"tokens"
]
},
"indices.analyze.ExplainAnalyzeToken": {
"type": "object",
"properties": {
"bytes": {
"type": "string"
},
"end_offset": {
"type": "number"
},
"keyword": {
"type": "boolean"
},
"position": {
"type": "number"
},
"positionLength": {
"type": "number"
},
"start_offset": {
"type": "number"
},
"termFrequency": {
"type": "number"
},
"token": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"bytes",
"end_offset",
"position",
"positionLength",
"start_offset",
"termFrequency",
"token",
"type"
]
},
"indices.analyze.CharFilterDetail": {
"type": "object",
"properties": {
"filtered_text": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
}
},
"required": [
"filtered_text",
"name"
]
},
"indices.analyze.TokenDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tokens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.analyze.ExplainAnalyzeToken"
}
}
},
"required": [
"name",
"tokens"
]
},
"indices.analyze.AnalyzeToken": {
"type": "object",
"properties": {
"end_offset": {
"type": "number"
},
"position": {
"type": "number"
},
"positionLength": {
"type": "number"
},
"start_offset": {
"type": "number"
},
"token": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"end_offset",
"position",
"start_offset",
"token",
"type"
]
},
"_types.ShardsOperationResponseBase": {
"type": "object",
"properties": {
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
}
}
},
"indices.close.CloseIndexResult": {
"type": "object",
"properties": {
"closed": {
"type": "boolean"
},
"shards": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.close.CloseShardResult"
}
}
},
"required": [
"closed"
]
},
"indices.close.CloseShardResult": {
"type": "object",
"properties": {
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ShardFailure"
}
}
},
"required": [
"failures"
]
},
"_types.DataStreamName": {
"type": "string"
},
"indices.create_from.CreateFrom": {
"type": "object",
"properties": {
"mappings_override": {
"description": "Mappings overrides to be applied to the destination index (optional)",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"settings_override": {
"description": "Settings overrides to be applied to the destination index (optional)",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"remove_index_blocks": {
"description": "If index blocks should be removed when creating destination index (optional)",
"default": true,
"type": "boolean"
}
}
},
"indices.data_streams_stats.DataStreamsStatsItem": {
"type": "object",
"properties": {
"backing_indices": {
"description": "Current number of backing indices for the data stream.",
"type": "number"
},
"data_stream": {
"description": "Name of the data stream.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"maximum_timestamp": {
"description": "The data stream’s highest `@timestamp` value, converted to milliseconds since the Unix epoch.\nNOTE: This timestamp is provided as a best effort.\nThe data stream may contain `@timestamp` values higher than this if one or more of the following conditions are met:\nThe stream contains closed backing indices;\nBacking indices with a lower generation contain higher `@timestamp` values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"store_size": {
"description": "Total size of all shards for the data stream’s backing indices.\nThis parameter is only returned if the `human` query parameter is `true`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"store_size_bytes": {
"description": "Total size, in bytes, of all shards for the data stream’s backing indices.",
"type": "number"
}
},
"required": [
"backing_indices",
"data_stream",
"maximum_timestamp",
"store_size_bytes"
]
},
"_types.IndicesResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
{
"type": "object",
"properties": {
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
}
}
}
]
},
"indices.delete_alias.IndicesAliasesResponseBody": {
"allOf": [
{
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
{
"type": "object",
"properties": {
"errors": {
"type": "boolean"
}
}
}
]
},
"_types.DataStreamNames": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.DataStreamName"
}
}
]
},
"indices._types.DownsampleConfig": {
"type": "object",
"properties": {
"fixed_interval": {
"description": "The interval at which to aggregate the original time series index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationLarge"
}
]
},
"sampling_method": {
"description": "The sampling method used to reduce the documents; it can be either `aggregate` or `last_value`. Defaults to `aggregate`.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.SamplingMethod"
}
]
}
},
"required": [
"fixed_interval"
]
},
"indices.explain_data_lifecycle.DataStreamLifecycleExplain": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"managed_by_lifecycle": {
"type": "boolean"
},
"index_creation_date_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"time_since_index_creation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"rollover_date_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"time_since_rollover": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"lifecycle": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
}
]
},
"generation_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"error": {
"type": "string"
}
},
"required": [
"index",
"managed_by_lifecycle"
]
},
"indices.field_usage_stats.FieldsUsageBody": {
"type": "object",
"properties": {
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
}
},
"required": [
"_shards"
]
},
"indices.forcemerge._types.ForceMergeResponseBody": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardsOperationResponseBase"
},
{
"type": "object",
"properties": {
"task": {
"description": "task contains a task id returned when wait_for_completion=false,\nyou can use the task_id to get the status of the task at _tasks/",
"type": "string"
}
}
}
]
},
"indices.get.Features": {
"oneOf": [
{
"$ref": "#/components/schemas/indices.get.Feature"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.get.Feature"
}
}
]
},
"indices.get.Feature": {
"type": "string",
"enum": [
"aliases",
"mappings",
"settings"
]
},
"indices._types.IndexState": {
"type": "object",
"properties": {
"aliases": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"defaults": {
"description": "Default settings, included when the request's `include_default` is `true`.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"data_stream": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
}
]
},
"lifecycle": {
"description": "Data stream lifecycle applicable if this is a data stream.",
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycle"
}
]
}
}
},
"indices.get_alias._types.IndexAliases": {
"type": "object",
"properties": {
"aliases": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.AliasDefinition"
}
}
},
"required": [
"aliases"
]
},
"indices.get_data_lifecycle.DataStreamWithLifecycle": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
}
]
},
"lifecycle": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
}
]
}
},
"required": [
"name"
]
},
"indices.get_data_lifecycle._types.GlobalRetention": {
"type": "object",
"properties": {
"max_retention": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"default_retention": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"indices.get_data_lifecycle_stats.DataStreamStats": {
"type": "object",
"properties": {
"backing_indices_in_error": {
"description": "The count of the backing indices for the data stream.",
"type": "number"
},
"backing_indices_in_total": {
"description": "The count of the backing indices for the data stream that have encountered an error.",
"type": "number"
},
"name": {
"description": "The name of the data stream.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
}
]
}
},
"required": [
"backing_indices_in_error",
"backing_indices_in_total",
"name"
]
},
"indices._types.DataStream": {
"type": "object",
"properties": {
"_meta": {
"description": "Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"allow_custom_routing": {
"description": "If `true`, the data stream allows custom routing on write request.",
"type": "boolean"
},
"failure_store": {
"description": "Information about failure store backing indices",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.FailureStore"
}
]
},
"generation": {
"description": "Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.",
"type": "number"
},
"hidden": {
"description": "If `true`, the data stream is hidden.",
"type": "boolean"
},
"ilm_policy": {
"description": "Name of the current ILM lifecycle policy in the stream’s matching index template.\nThis lifecycle policy is set in the `index.lifecycle.name` setting.\nIf the template does not include a lifecycle policy, this property is not included in the response.\nNOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"next_generation_managed_by": {
"description": "Name of the lifecycle system that'll manage the next generation of the data stream.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.ManagedBy"
}
]
},
"prefer_ilm": {
"description": "Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.",
"type": "boolean"
},
"indices": {
"description": "Array of objects containing information about the data stream’s backing indices.\nThe last item in this array contains information about the stream’s current write index.",
"type": "array",
"items": {
"$ref": "#/components/schemas/indices._types.DataStreamIndex"
}
},
"lifecycle": {
"description": "Contains the configuration for the data stream lifecycle of this data stream.",
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
}
]
},
"name": {
"description": "Name of the data stream.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
}
]
},
"replicated": {
"description": "If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.",
"type": "boolean"
},
"rollover_on_write": {
"description": "If `true`, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too.",
"type": "boolean"
},
"settings": {
"description": "The settings specific to this data stream that will take precedence over the settings in the matching index\ntemplate.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"mappings": {
"description": "The mappings specific to this data stream that will take precedence over the mappings in the matching index\ntemplate.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"status": {
"description": "Health status of the data stream.\nThis health status is based on the state of the primary and replica shards of the stream’s backing indices.\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",
"allOf": [
{
"$ref": "#/components/schemas/_types.HealthStatus"
}
]
},
"system": {
"description": "If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.",
"x-state": "Generally available; Added in 7.10.0",
"type": "boolean"
},
"template": {
"description": "Name of the index template used to create the data stream’s backing indices.\nThe template’s index pattern must match the name of this data stream.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"timestamp_field": {
"description": "Information about the `@timestamp` field in the data stream.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamTimestampField"
}
]
},
"index_mode": {
"description": "The index mode for the data stream that will be used for newly created backing indices.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexMode"
}
]
}
},
"required": [
"generation",
"hidden",
"next_generation_managed_by",
"prefer_ilm",
"indices",
"name",
"rollover_on_write",
"settings",
"status",
"template",
"timestamp_field"
]
},
"indices._types.FailureStore": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices._types.DataStreamIndex"
}
},
"rollover_on_write": {
"type": "boolean"
}
},
"required": [
"enabled",
"indices",
"rollover_on_write"
]
},
"indices._types.DataStreamIndex": {
"type": "object",
"properties": {
"index_name": {
"description": "Name of the backing index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"index_uuid": {
"description": "Universally unique identifier (UUID) for the index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
},
"ilm_policy": {
"description": "Name of the current ILM lifecycle policy configured for this backing index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"managed_by": {
"description": "Name of the lifecycle system that's currently managing this backing index.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.ManagedBy"
}
]
},
"prefer_ilm": {
"description": "Indicates if ILM should take precedence over DSL in case both are configured to manage this index.",
"type": "boolean"
},
"index_mode": {
"description": "The index mode of this backing index of the data stream.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexMode"
}
]
}
},
"required": [
"index_name",
"index_uuid"
]
},
"indices._types.ManagedBy": {
"type": "string",
"enum": [
"Index Lifecycle Management",
"Data stream lifecycle",
"Unmanaged"
]
},
"indices._types.IndexMode": {
"type": "string",
"enum": [
"standard",
"time_series",
"logsdb",
"lookup"
]
},
"indices._types.DataStreamTimestampField": {
"type": "object",
"properties": {
"name": {
"description": "Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"name"
]
},
"indices.get_data_stream_mappings.DataStreamMappings": {
"type": "object",
"properties": {
"name": {
"description": "The name of the data stream.",
"type": "string"
},
"mappings": {
"description": "The settings specific to this data stream",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"effective_mappings": {
"description": "The settings specific to this data stream merged with the settings from its template. These `effective_settings`\nare the settings that will be used when a new index is created for this data stream.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
}
},
"required": [
"name",
"mappings",
"effective_mappings"
]
},
"indices.get_data_stream_options.DataStreamWithOptions": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
}
]
},
"options": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamOptions"
}
]
}
},
"required": [
"name"
]
},
"indices.get_data_stream_settings.DataStreamSettings": {
"type": "object",
"properties": {
"name": {
"description": "The name of the data stream.",
"type": "string"
},
"settings": {
"description": "The settings specific to this data stream",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"effective_settings": {
"description": "The settings specific to this data stream merged with the settings from its template. These `effective_settings`\nare the settings that will be used when a new index is created for this data stream.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
}
},
"required": [
"name",
"settings",
"effective_settings"
]
},
"indices.get_field_mapping.TypeFieldMappings": {
"type": "object",
"properties": {
"mappings": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.FieldMapping"
}
}
},
"required": [
"mappings"
]
},
"_types.mapping.FieldMapping": {
"type": "object",
"properties": {
"full_name": {
"type": "string"
},
"mapping": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.Property"
},
"minProperties": 1,
"maxProperties": 1
}
},
"required": [
"full_name",
"mapping"
]
},
"indices.get_index_template.IndexTemplateItem": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"index_template": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexTemplateWithRollover"
}
]
}
},
"required": [
"name",
"index_template"
]
},
"indices._types.IndexTemplateWithRollover": {
"type": "object",
"properties": {
"template": {
"description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexTemplateSummaryWithRollover"
}
]
},
"index_patterns": {
"description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Names"
}
]
},
"composed_of": {
"description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Name"
}
},
"version": {
"description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"priority": {
"description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.",
"type": "number"
},
"_meta": {
"description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"allow_auto_create": {
"type": "boolean"
},
"data_stream": {
"description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration"
}
]
},
"deprecated": {
"description": "Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning.",
"x-state": "Generally available; Added in 8.12.0",
"type": "boolean"
},
"ignore_missing_component_templates": {
"description": "A list of component template names that are allowed to be absent.",
"x-state": "Generally available; Added in 8.7.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Names"
}
]
},
"created_date": {
"description": "Date and time when the index template was created. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"created_date_millis": {
"description": "Date and time when the index template was created, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"modified_date": {
"description": "Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"modified_date_millis": {
"description": "Date and time when the index template was last modified, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"index_patterns",
"composed_of"
]
},
"indices._types.IndexTemplateSummaryWithRollover": {
"type": "object",
"properties": {
"lifecycle": {
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
}
]
},
"aliases": {
"description": "Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"mappings": {
"description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"settings": {
"description": "Configuration options for the index.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"data_stream_options": {
"x-state": "Generally available; Added in 8.19.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamOptions"
}
]
}
}
},
"indices._types.IndexTemplateDataStreamConfiguration": {
"type": "object",
"properties": {
"hidden": {
"description": "If true, the data stream is hidden.",
"default": false,
"type": "boolean"
},
"allow_custom_routing": {
"description": "If true, the data stream supports custom routing.",
"default": false,
"type": "boolean"
}
}
},
"indices.get_mapping.IndexMappingRecord": {
"type": "object",
"properties": {
"item": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
}
},
"required": [
"mappings"
]
},
"indices.get_migrate_reindex_status.StatusInProgress": {
"type": "object",
"properties": {
"index": {
"type": "string"
},
"total_doc_count": {
"type": "number"
},
"reindexed_doc_count": {
"type": "number"
}
},
"required": [
"index",
"total_doc_count",
"reindexed_doc_count"
]
},
"indices.get_migrate_reindex_status.StatusError": {
"type": "object",
"properties": {
"index": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"index",
"message"
]
},
"indices._types.TemplateMapping": {
"type": "object",
"properties": {
"aliases": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"index_patterns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Name"
}
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"order": {
"type": "number"
},
"settings": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"aliases",
"index_patterns",
"mappings",
"order",
"settings"
]
},
"indices.migrate_reindex.MigrateReindex": {
"type": "object",
"properties": {
"mode": {
"description": "Reindex mode. Currently only 'upgrade' is supported.",
"allOf": [
{
"$ref": "#/components/schemas/indices.migrate_reindex.ModeEnum"
}
]
},
"source": {
"description": "The source index or data stream (only data streams are currently supported).",
"allOf": [
{
"$ref": "#/components/schemas/indices.migrate_reindex.SourceIndex"
}
]
}
},
"required": [
"mode",
"source"
]
},
"indices.migrate_reindex.ModeEnum": {
"type": "string",
"enum": [
"upgrade"
]
},
"indices.migrate_reindex.SourceIndex": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"index"
]
},
"indices.modify_data_stream.Action": {
"type": "object",
"properties": {
"add_backing_index": {
"description": "Adds an existing index as a backing index for a data stream.\nThe index is hidden as part of this operation.\nWARNING: Adding indices with the `add_backing_index` action can potentially result in improper data stream behavior.\nThis should be considered an expert level API.",
"allOf": [
{
"$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction"
}
]
},
"remove_backing_index": {
"description": "Removes a backing index from a data stream.\nThe index is unhidden as part of this operation.\nA data stream’s write index cannot be removed.",
"allOf": [
{
"$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"indices.modify_data_stream.IndexAndDataStreamAction": {
"type": "object",
"properties": {
"data_stream": {
"description": "Data stream targeted by the action.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
}
]
},
"index": {
"description": "Index for the action.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"data_stream",
"index"
]
},
"indices.put_data_stream_mappings.UpdatedDataStreamMappings": {
"type": "object",
"properties": {
"name": {
"description": "The data stream name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"applied_to_data_stream": {
"description": "If the mappings were successfully applied to the data stream (or would have been, if running in `dry_run`\nmode), it is `true`. If an error occurred, it is `false`.",
"type": "boolean"
},
"error": {
"description": "A message explaining why the mappings could not be applied to the data stream.",
"type": "string"
},
"mappings": {
"description": "The mappings that are specfic to this data stream that will override any mappings from the matching index template.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"effective_mappings": {
"description": "The mappings that are effective on this data stream, taking into account the mappings from the matching index\ntemplate and the mappings specific to this data stream.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
}
},
"required": [
"name",
"applied_to_data_stream"
]
},
"indices.put_data_stream_settings.UpdatedDataStreamSettings": {
"type": "object",
"properties": {
"name": {
"description": "The data stream name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"applied_to_data_stream": {
"description": "If the settings were successfully applied to the data stream (or would have been, if running in `dry_run`\nmode), it is `true`. If an error occurred, it is `false`.",
"type": "boolean"
},
"error": {
"description": "A message explaining why the settings could not be applied to the data stream.",
"type": "string"
},
"settings": {
"description": "The settings that are specfic to this data stream that will override any settings from the matching index template.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"effective_settings": {
"description": "The settings that are effective on this data stream, taking into account the settings from the matching index\ntemplate and the settings specific to this data stream.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"index_settings_results": {
"description": "Information about whether and where each setting was applied.",
"allOf": [
{
"$ref": "#/components/schemas/indices.put_data_stream_settings.IndexSettingResults"
}
]
}
},
"required": [
"name",
"applied_to_data_stream",
"settings",
"effective_settings",
"index_settings_results"
]
},
"indices.put_data_stream_settings.IndexSettingResults": {
"type": "object",
"properties": {
"applied_to_data_stream_only": {
"description": "The list of settings that were applied to the data stream but not to backing indices. These will be applied to\nthe write index the next time the data stream is rolled over.",
"type": "array",
"items": {
"type": "string"
}
},
"applied_to_data_stream_and_backing_indices": {
"description": "The list of settings that were applied to the data stream and to all of its backing indices. These settings will\nalso be applied to the write index the next time the data stream is rolled over.",
"type": "array",
"items": {
"type": "string"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.put_data_stream_settings.DataStreamSettingsError"
}
}
},
"required": [
"applied_to_data_stream_only",
"applied_to_data_stream_and_backing_indices"
]
},
"indices.put_data_stream_settings.DataStreamSettingsError": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"error": {
"description": "A message explaining why the settings could not be applied to specific indices.",
"type": "string"
}
},
"required": [
"index",
"error"
]
},
"indices._types.DataStreamVisibility": {
"type": "object",
"properties": {
"hidden": {
"type": "boolean"
},
"allow_custom_routing": {
"type": "boolean"
},
"failure_store": {
"type": "boolean"
}
}
},
"indices.recovery.RecoveryStatus": {
"type": "object",
"properties": {
"shards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.recovery.ShardRecovery"
}
}
},
"required": [
"shards"
]
},
"indices.recovery.ShardRecovery": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryIndexStatus"
}
]
},
"primary": {
"type": "boolean"
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryOrigin"
}
]
},
"stage": {
"description": "The recovery stage.\n\nSupported values include:\n - `INIT`: Recovery has not started.\n - `INDEX`: Reading index metadata and copying bytes from source to destination.\n - `VERIFY_INDEX`: Verifying the integrity of the index.\n - `TRANSLOG`: Replaying the transaction log.\n - `FINALIZE`: Cleanup.\n - `DONE`: Complete.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryStage"
}
]
},
"start": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryStartStatus"
}
]
},
"start_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"start_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"stop_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"stop_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"target": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryOrigin"
}
]
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"translog": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.TranslogStatus"
}
]
},
"type": {
"description": "The recovery source type.\n\nSupported values include:\n - `EMPTY_STORE`: An empty store. Indicates a new primary shard or the forced allocation of an empty primary shard using the cluster reroute API.\n - `EXISTING_STORE`: The store of an existing primary shard. Indicates recovery is related to node startup or the allocation of an existing primary shard.\n - `LOCAL_SHARDS`: Shards of another index on the same node. Indicates recovery is related to a clone, shrink, or split operation.\n - `PEER`: A primary shard on another node. Indicates recovery is related to shard replication.\n - `SNAPSHOT`: A snapshot. Indicates recovery is related to a snapshot restore operation.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryType"
}
]
},
"verify_index": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.VerifyIndex"
}
]
}
},
"required": [
"id",
"index",
"primary",
"source",
"stage",
"start_time_in_millis",
"target",
"total_time_in_millis",
"translog",
"type",
"verify_index"
]
},
"indices.recovery.RecoveryIndexStatus": {
"type": "object",
"properties": {
"bytes": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryBytes"
}
]
},
"files": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryFiles"
}
]
},
"size": {
"allOf": [
{
"$ref": "#/components/schemas/indices.recovery.RecoveryBytes"
}
]
},
"source_throttle_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"source_throttle_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"target_throttle_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"target_throttle_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"files",
"size",
"source_throttle_time_in_millis",
"target_throttle_time_in_millis",
"total_time_in_millis"
]
},
"indices.recovery.RecoveryBytes": {
"type": "object",
"properties": {
"percent": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Percentage"
}
]
},
"recovered": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"recovered_in_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"recovered_from_snapshot": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"recovered_from_snapshot_in_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"reused": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"reused_in_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_in_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
},
"required": [
"percent",
"recovered_in_bytes",
"reused_in_bytes",
"total_in_bytes"
]
},
"indices.recovery.RecoveryFiles": {
"type": "object",
"properties": {
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.recovery.FileDetails"
}
},
"percent": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Percentage"
}
]
},
"recovered": {
"type": "number"
},
"reused": {
"type": "number"
},
"total": {
"type": "number"
}
},
"required": [
"percent",
"recovered",
"reused",
"total"
]
},
"indices.recovery.FileDetails": {
"type": "object",
"properties": {
"length": {
"type": "number"
},
"name": {
"type": "string"
},
"recovered": {
"type": "number"
}
},
"required": [
"length",
"name",
"recovered"
]
},
"indices.recovery.RecoveryOrigin": {
"type": "object",
"properties": {
"hostname": {
"type": "string"
},
"host": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"transport_address": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"ip": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Ip"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"bootstrap_new_history_uuid": {
"type": "boolean"
},
"repository": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"snapshot": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"restoreUUID": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
}
},
"indices.recovery.RecoveryStage": {
"type": "string",
"enum": [
"INIT",
"INDEX",
"VERIFY_INDEX",
"TRANSLOG",
"FINALIZE",
"DONE"
]
},
"indices.recovery.RecoveryStartStatus": {
"type": "object",
"properties": {
"check_index_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"check_index_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"check_index_time_in_millis",
"total_time_in_millis"
]
},
"indices.recovery.TranslogStatus": {
"type": "object",
"properties": {
"percent": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Percentage"
}
]
},
"recovered": {
"type": "number"
},
"total": {
"type": "number"
},
"total_on_start": {
"type": "number"
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"percent",
"recovered",
"total",
"total_on_start",
"total_time_in_millis"
]
},
"indices.recovery.RecoveryType": {
"type": "string",
"enum": [
"EMPTY_STORE",
"EXISTING_STORE",
"LOCAL_SHARDS",
"PEER",
"SNAPSHOT"
]
},
"indices.recovery.VerifyIndex": {
"type": "object",
"properties": {
"check_index_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"check_index_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"check_index_time_in_millis",
"total_time_in_millis"
]
},
"indices.reload_search_analyzers.ReloadResult": {
"type": "object",
"properties": {
"reload_details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadDetails"
}
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
}
},
"required": [
"reload_details",
"_shards"
]
},
"indices.reload_search_analyzers.ReloadDetails": {
"type": "object",
"properties": {
"index": {
"type": "string"
},
"reloaded_analyzers": {
"type": "array",
"items": {
"type": "string"
}
},
"reloaded_node_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"index",
"reloaded_analyzers",
"reloaded_node_ids"
]
},
"indices.remove_block.RemoveIndicesBlockStatus": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"unblocked": {
"type": "boolean"
},
"exception": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"name"
]
},
"indices.resolve_cluster.ResolveClusterInfo": {
"description": "Provides information about each cluster request relevant to doing a cross-cluster search.",
"type": "object",
"properties": {
"connected": {
"description": "Whether the remote cluster is connected to the local (querying) cluster.",
"type": "boolean"
},
"skip_unavailable": {
"description": "The `skip_unavailable` setting for a remote cluster.",
"type": "boolean"
},
"matching_indices": {
"description": "Whether the index expression provided in the request matches any indices, aliases or data streams\non the cluster.",
"type": "boolean"
},
"error": {
"description": "Provides error messages that are likely to occur if you do a search with this index expression\non the specified cluster (for example, lack of security privileges to query an index).",
"type": "string"
},
"version": {
"description": "Provides version information about the cluster.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ElasticsearchVersionMinInfo"
}
]
}
},
"required": [
"connected",
"skip_unavailable"
]
},
"_types.ElasticsearchVersionMinInfo": {
"description": "Reduced (minimal) info ElasticsearchVersion",
"type": "object",
"properties": {
"build_flavor": {
"type": "string"
},
"minimum_index_compatibility_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"minimum_wire_compatibility_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"number": {
"type": "string"
}
},
"required": [
"build_flavor",
"minimum_index_compatibility_version",
"minimum_wire_compatibility_version",
"number"
]
},
"indices.resolve_index.ResolveIndexItem": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "array",
"items": {
"type": "string"
}
},
"data_stream": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
}
]
},
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexMode"
}
]
}
},
"required": [
"name",
"attributes"
]
},
"indices.resolve_index.ResolveIndexAliasItem": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"indices": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
}
},
"required": [
"name",
"indices"
]
},
"indices.resolve_index.ResolveIndexDataStreamsItem": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DataStreamName"
}
]
},
"timestamp_field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"backing_indices": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
}
},
"required": [
"name",
"timestamp_field",
"backing_indices"
]
},
"indices.rollover.RolloverConditions": {
"type": "object",
"properties": {
"min_age": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_age": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_age_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"min_docs": {
"type": "number"
},
"max_docs": {
"type": "number"
},
"max_size": {
"deprecated": true,
"description": "The `max_size` condition has been deprecated in 9.3.0 and `max_primary_shard_size` should be used instead",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_size_bytes": {
"type": "number"
},
"min_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"min_size_bytes": {
"type": "number"
},
"max_primary_shard_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_primary_shard_size_bytes": {
"type": "number"
},
"min_primary_shard_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"min_primary_shard_size_bytes": {
"type": "number"
},
"max_primary_shard_docs": {
"type": "number"
},
"min_primary_shard_docs": {
"type": "number"
}
}
},
"indices.segments.IndexSegment": {
"type": "object",
"properties": {
"shards": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/indices.segments.ShardsSegment"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.segments.ShardsSegment"
}
}
]
}
}
},
"required": [
"shards"
]
},
"indices.segments.ShardsSegment": {
"type": "object",
"properties": {
"num_committed_segments": {
"type": "number"
},
"routing": {
"allOf": [
{
"$ref": "#/components/schemas/indices.segments.ShardSegmentRouting"
}
]
},
"num_search_segments": {
"type": "number"
},
"segments": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.segments.Segment"
}
}
},
"required": [
"num_committed_segments",
"routing",
"num_search_segments",
"segments"
]
},
"indices.segments.ShardSegmentRouting": {
"type": "object",
"properties": {
"node": {
"description": "The node ID of the node that holds the shard.",
"type": "string"
},
"primary": {
"description": "If `true`, the shard is a primary shard.",
"type": "boolean"
},
"state": {
"description": "The state of the shard, such as `STARTED` or `RELOCATING`.",
"type": "string"
}
},
"required": [
"node",
"primary",
"state"
]
},
"indices.segments.Segment": {
"type": "object",
"properties": {
"attributes": {
"description": "Contains information about whether high compression was enabled and per-field vector formats.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"committed": {
"description": "If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot.\nIf `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": "boolean"
},
"compound": {
"description": "If `true`, Lucene merged all files from the segment into a single file to save file descriptors.",
"type": "boolean"
},
"deleted_docs": {
"description": "The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed.\nThis number excludes deletes that were performed recently and do not yet belong to a segment.\nDeleted documents are cleaned up by the automatic merge process if it makes sense to do so.\nAlso, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.",
"type": "number"
},
"generation": {
"description": "Generation number, such as `0`. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name.",
"type": "number"
},
"search": {
"description": "If `true`, the segment is searchable.\nIf `false`, the segment has most likely been written to disk but needs a refresh to be searchable.",
"type": "boolean"
},
"size_in_bytes": {
"description": "Disk space used by the segment, in bytes.",
"type": "number"
},
"num_docs": {
"description": "The number of documents as reported by Lucene.\nThis excludes deleted documents and counts any nested documents separately from their parents.\nIt also excludes documents which were indexed recently and do not yet belong to a segment.",
"type": "number"
},
"version": {
"description": "Version of Lucene used to write the segment.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
},
"required": [
"attributes",
"committed",
"compound",
"deleted_docs",
"generation",
"search",
"size_in_bytes",
"num_docs",
"version"
]
},
"indices.shard_stores.ShardStoreStatus": {
"type": "string",
"enum": [
"green",
"yellow",
"red",
"all"
]
},
"indices.shard_stores.IndicesShardStores": {
"type": "object",
"properties": {
"shards": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.shard_stores.ShardStoreWrapper"
}
}
},
"required": [
"shards"
]
},
"indices.shard_stores.ShardStoreWrapper": {
"type": "object",
"properties": {
"stores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.shard_stores.ShardStore"
}
}
},
"required": [
"stores"
]
},
"indices.shard_stores.ShardStore": {
"type": "object",
"properties": {
"allocation": {
"description": "The status of the store copy, whether it is used as a primary, replica, or not used at all.\n\nSupported values include:\n - `primary`: The store copy is used as a primary shard.\n - `replica`: The store copy is used as a replica shard.\n - `unused`: The store copy is not used.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/indices.shard_stores.ShardStoreAllocation"
}
]
},
"allocation_id": {
"description": "The allocation ID of the store copy.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"store_exception": {
"description": "Any exception encountered while opening the shard index or from an earlier engine failure.",
"allOf": [
{
"$ref": "#/components/schemas/indices.shard_stores.ShardStoreException"
}
]
}
},
"required": [
"allocation"
]
},
"indices.shard_stores.ShardStoreAllocation": {
"type": "string",
"enum": [
"primary",
"replica",
"unused"
]
},
"indices.shard_stores.ShardStoreException": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"reason",
"type"
]
},
"indices._types.IndexTemplate": {
"type": "object",
"properties": {
"index_patterns": {
"description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Names"
}
]
},
"composed_of": {
"description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Name"
}
},
"template": {
"description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexTemplateSummary"
}
]
},
"version": {
"description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"priority": {
"description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.",
"type": "number"
},
"_meta": {
"description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"allow_auto_create": {
"type": "boolean"
},
"data_stream": {
"description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration"
}
]
},
"deprecated": {
"description": "Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning.",
"x-state": "Generally available; Added in 8.12.0",
"type": "boolean"
},
"ignore_missing_component_templates": {
"description": "A list of component template names that are allowed to be absent.",
"x-state": "Generally available; Added in 8.7.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Names"
}
]
},
"created_date": {
"description": "Date and time when the index template was created. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"created_date_millis": {
"description": "Date and time when the index template was created, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"modified_date": {
"description": "Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"modified_date_millis": {
"description": "Date and time when the index template was last modified, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"index_patterns",
"composed_of"
]
},
"indices._types.IndexTemplateSummary": {
"type": "object",
"properties": {
"aliases": {
"description": "Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"mappings": {
"description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"settings": {
"description": "Configuration options for the index.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"lifecycle": {
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycle"
}
]
},
"data_stream_options": {
"x-state": "Generally available; Added in 8.19.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamOptions"
}
]
}
}
},
"indices.simulate_template.Overlapping": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"index_patterns": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"index_patterns"
]
},
"indices.simulate_template.Template": {
"type": "object",
"properties": {
"aliases": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
}
},
"required": [
"aliases",
"mappings",
"settings"
]
},
"_types.CommonStatsFlags": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.CommonStatsFlag"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.CommonStatsFlag"
}
}
]
},
"_types.CommonStatsFlag": {
"type": "string",
"enum": [
"_all",
"store",
"indexing",
"get",
"search",
"merge",
"flush",
"refresh",
"query_cache",
"fielddata",
"docs",
"warmer",
"completion",
"segments",
"translog",
"request_cache",
"recovery",
"bulk",
"shard_stats",
"mappings",
"dense_vector",
"sparse_vector"
]
},
"indices.stats.IndicesStats": {
"type": "object",
"properties": {
"primaries": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.IndexStats"
}
]
},
"shards": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.stats.ShardStats"
}
}
},
"total": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.IndexStats"
}
]
},
"uuid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
},
"health": {
"description": "\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",
"x-state": "Generally available; Added in 8.1.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.HealthStatus"
}
]
},
"status": {
"x-state": "Generally available; Added in 8.1.0",
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.IndexMetadataState"
}
]
}
}
},
"indices.stats.IndexStats": {
"type": "object",
"properties": {
"completion": {
"description": "Contains statistics about completions across all shards assigned to the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.CompletionStats"
}
]
},
"docs": {
"description": "Contains statistics about documents across all primary shards assigned to the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DocStats"
}
]
},
"fielddata": {
"description": "Contains statistics about the field data cache across all shards assigned to the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.FielddataStats"
}
]
},
"flush": {
"description": "Contains statistics about flush operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.FlushStats"
}
]
},
"get": {
"description": "Contains statistics about get operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.GetStats"
}
]
},
"indexing": {
"description": "Contains statistics about indexing operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexingStats"
}
]
},
"indices": {
"description": "Contains statistics about indices operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.IndicesStats"
}
]
},
"merges": {
"description": "Contains statistics about merge operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.MergesStats"
}
]
},
"query_cache": {
"description": "Contains statistics about the query cache across all shards assigned to the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.QueryCacheStats"
}
]
},
"recovery": {
"description": "Contains statistics about recovery operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RecoveryStats"
}
]
},
"refresh": {
"description": "Contains statistics about refresh operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RefreshStats"
}
]
},
"request_cache": {
"description": "Contains statistics about the request cache across all shards assigned to the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.RequestCacheStats"
}
]
},
"search": {
"description": "Contains statistics about search operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SearchStats"
}
]
},
"segments": {
"description": "Contains statistics about segments across all shards assigned to the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SegmentsStats"
}
]
},
"store": {
"description": "Contains statistics about the size of shards assigned to the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.StoreStats"
}
]
},
"translog": {
"description": "Contains statistics about transaction log operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TranslogStats"
}
]
},
"warmer": {
"description": "Contains statistics about index warming operations for the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.WarmerStats"
}
]
},
"bulk": {
"allOf": [
{
"$ref": "#/components/schemas/_types.BulkStats"
}
]
},
"shard_stats": {
"x-state": "Generally available; Added in 7.15.0",
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardsTotalStats"
}
]
}
}
},
"_types.FlushStats": {
"type": "object",
"properties": {
"periodic": {
"type": "number"
},
"total": {
"type": "number"
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"periodic",
"total",
"total_time_in_millis"
]
},
"_types.GetStats": {
"type": "object",
"properties": {
"current": {
"type": "number"
},
"exists_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"exists_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"exists_total": {
"type": "number"
},
"missing_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"missing_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"missing_total": {
"type": "number"
},
"time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total": {
"type": "number"
}
},
"required": [
"current",
"exists_time_in_millis",
"exists_total",
"missing_time_in_millis",
"missing_total",
"time_in_millis",
"total"
]
},
"_types.IndexingStats": {
"type": "object",
"properties": {
"index_current": {
"type": "number"
},
"delete_current": {
"type": "number"
},
"delete_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"delete_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"delete_total": {
"type": "number"
},
"is_throttled": {
"type": "boolean"
},
"noop_update_total": {
"type": "number"
},
"throttle_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttle_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"index_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"index_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"index_total": {
"type": "number"
},
"index_failed": {
"type": "number"
},
"types": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.IndexingStats"
}
},
"write_load": {
"type": "number"
},
"recent_write_load": {
"type": "number"
},
"peak_write_load": {
"type": "number"
}
},
"required": [
"index_current",
"delete_current",
"delete_time_in_millis",
"delete_total",
"is_throttled",
"noop_update_total",
"throttle_time_in_millis",
"index_time_in_millis",
"index_total",
"index_failed"
]
},
"_types.MergesStats": {
"type": "object",
"properties": {
"current": {
"type": "number"
},
"current_docs": {
"type": "number"
},
"current_size": {
"type": "string"
},
"current_size_in_bytes": {
"type": "number"
},
"total": {
"type": "number"
},
"total_auto_throttle": {
"type": "string"
},
"total_auto_throttle_in_bytes": {
"type": "number"
},
"total_docs": {
"type": "number"
},
"total_size": {
"type": "string"
},
"total_size_in_bytes": {
"type": "number"
},
"total_stopped_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_stopped_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_throttled_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_throttled_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"current",
"current_docs",
"current_size_in_bytes",
"total",
"total_auto_throttle_in_bytes",
"total_docs",
"total_size_in_bytes",
"total_stopped_time_in_millis",
"total_throttled_time_in_millis",
"total_time_in_millis"
]
},
"_types.RecoveryStats": {
"type": "object",
"properties": {
"current_as_source": {
"type": "number"
},
"current_as_target": {
"type": "number"
},
"throttle_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttle_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"current_as_source",
"current_as_target",
"throttle_time_in_millis"
]
},
"_types.RefreshStats": {
"type": "object",
"properties": {
"external_total": {
"type": "number"
},
"external_total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"listeners": {
"type": "number"
},
"total": {
"type": "number"
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"external_total",
"external_total_time_in_millis",
"listeners",
"total",
"total_time_in_millis"
]
},
"_types.RequestCacheStats": {
"type": "object",
"properties": {
"evictions": {
"type": "number"
},
"hit_count": {
"type": "number"
},
"memory_size": {
"type": "string"
},
"memory_size_in_bytes": {
"type": "number"
},
"miss_count": {
"type": "number"
}
},
"required": [
"evictions",
"hit_count",
"memory_size_in_bytes",
"miss_count"
]
},
"_types.SearchStats": {
"type": "object",
"properties": {
"fetch_current": {
"type": "number"
},
"fetch_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"fetch_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"fetch_total": {
"type": "number"
},
"open_contexts": {
"type": "number"
},
"query_current": {
"type": "number"
},
"query_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"query_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"query_total": {
"type": "number"
},
"scroll_current": {
"type": "number"
},
"scroll_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"scroll_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"scroll_total": {
"type": "number"
},
"suggest_current": {
"type": "number"
},
"suggest_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"suggest_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"suggest_total": {
"type": "number"
},
"recent_search_load": {
"type": "number"
},
"groups": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.SearchStats"
}
}
},
"required": [
"fetch_current",
"fetch_time_in_millis",
"fetch_total",
"query_current",
"query_time_in_millis",
"query_total",
"scroll_current",
"scroll_time_in_millis",
"scroll_total",
"suggest_current",
"suggest_time_in_millis",
"suggest_total"
]
},
"_types.TranslogStats": {
"type": "object",
"properties": {
"earliest_last_modified_age": {
"type": "number"
},
"operations": {
"type": "number"
},
"size": {
"type": "string"
},
"size_in_bytes": {
"type": "number"
},
"uncommitted_operations": {
"type": "number"
},
"uncommitted_size": {
"type": "string"
},
"uncommitted_size_in_bytes": {
"type": "number"
}
},
"required": [
"earliest_last_modified_age",
"operations",
"size_in_bytes",
"uncommitted_operations",
"uncommitted_size_in_bytes"
]
},
"_types.WarmerStats": {
"type": "object",
"properties": {
"current": {
"type": "number"
},
"total": {
"type": "number"
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"current",
"total",
"total_time_in_millis"
]
},
"_types.BulkStats": {
"type": "object",
"properties": {
"total_operations": {
"type": "number"
},
"total_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_size_in_bytes": {
"type": "number"
},
"avg_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"avg_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"avg_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"avg_size_in_bytes": {
"type": "number"
}
},
"required": [
"total_operations",
"total_time_in_millis",
"total_size_in_bytes",
"avg_time_in_millis",
"avg_size_in_bytes"
]
},
"indices.stats.ShardsTotalStats": {
"type": "object",
"properties": {
"total_count": {
"type": "number"
}
},
"required": [
"total_count"
]
},
"indices.stats.ShardStats": {
"type": "object",
"properties": {
"commit": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardCommit"
}
]
},
"completion": {
"allOf": [
{
"$ref": "#/components/schemas/_types.CompletionStats"
}
]
},
"docs": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DocStats"
}
]
},
"fielddata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.FielddataStats"
}
]
},
"flush": {
"allOf": [
{
"$ref": "#/components/schemas/_types.FlushStats"
}
]
},
"get": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GetStats"
}
]
},
"indexing": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexingStats"
}
]
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.MappingStats"
}
]
},
"merges": {
"allOf": [
{
"$ref": "#/components/schemas/_types.MergesStats"
}
]
},
"shard_path": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardPath"
}
]
},
"query_cache": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardQueryCache"
}
]
},
"recovery": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RecoveryStats"
}
]
},
"refresh": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RefreshStats"
}
]
},
"request_cache": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RequestCacheStats"
}
]
},
"retention_leases": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardRetentionLeases"
}
]
},
"routing": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardRouting"
}
]
},
"search": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SearchStats"
}
]
},
"segments": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SegmentsStats"
}
]
},
"seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardSequenceNumber"
}
]
},
"store": {
"allOf": [
{
"$ref": "#/components/schemas/_types.StoreStats"
}
]
},
"translog": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TranslogStats"
}
]
},
"warmer": {
"allOf": [
{
"$ref": "#/components/schemas/_types.WarmerStats"
}
]
},
"bulk": {
"allOf": [
{
"$ref": "#/components/schemas/_types.BulkStats"
}
]
},
"shards": {
"x-state": "Generally available; Added in 7.15.0",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"shard_stats": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardsTotalStats"
}
]
},
"indices": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.IndicesStats"
}
]
}
}
},
"indices.stats.ShardCommit": {
"type": "object",
"properties": {
"generation": {
"type": "number"
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"num_docs": {
"type": "number"
},
"user_data": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"generation",
"id",
"num_docs",
"user_data"
]
},
"indices.stats.MappingStats": {
"type": "object",
"properties": {
"total_count": {
"type": "number"
},
"total_estimated_overhead": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_estimated_overhead_in_bytes": {
"type": "number"
}
},
"required": [
"total_count",
"total_estimated_overhead_in_bytes"
]
},
"indices.stats.ShardPath": {
"type": "object",
"properties": {
"data_path": {
"type": "string"
},
"is_custom_data_path": {
"type": "boolean"
},
"state_path": {
"type": "string"
}
},
"required": [
"data_path",
"is_custom_data_path",
"state_path"
]
},
"indices.stats.ShardQueryCache": {
"type": "object",
"properties": {
"cache_count": {
"type": "number"
},
"cache_size": {
"type": "number"
},
"evictions": {
"type": "number"
},
"hit_count": {
"type": "number"
},
"memory_size_in_bytes": {
"type": "number"
},
"miss_count": {
"type": "number"
},
"total_count": {
"type": "number"
}
},
"required": [
"cache_count",
"cache_size",
"evictions",
"hit_count",
"memory_size_in_bytes",
"miss_count",
"total_count"
]
},
"indices.stats.ShardRetentionLeases": {
"type": "object",
"properties": {
"primary_term": {
"type": "number"
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"leases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.stats.ShardLease"
}
}
},
"required": [
"primary_term",
"version",
"leases"
]
},
"indices.stats.ShardLease": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"retaining_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"timestamp": {
"type": "number"
},
"source": {
"type": "string"
}
},
"required": [
"id",
"retaining_seq_no",
"timestamp",
"source"
]
},
"indices.stats.ShardRouting": {
"type": "object",
"properties": {
"node": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"relocating_node": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardRoutingState"
}
]
}
},
"required": [
"node",
"primary",
"state"
]
},
"indices.stats.ShardRoutingState": {
"type": "string",
"enum": [
"UNASSIGNED",
"INITIALIZING",
"STARTED",
"RELOCATING"
]
},
"indices.stats.ShardSequenceNumber": {
"type": "object",
"properties": {
"global_checkpoint": {
"type": "number"
},
"local_checkpoint": {
"type": "number"
},
"max_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
}
},
"required": [
"global_checkpoint",
"local_checkpoint",
"max_seq_no"
]
},
"indices.stats.IndexMetadataState": {
"type": "string",
"enum": [
"open",
"close"
]
},
"indices.update_aliases.Action": {
"type": "object",
"properties": {
"add": {
"description": "Adds a data stream or index to an alias.\nIf the alias doesn’t exist, the `add` action creates it.",
"allOf": [
{
"$ref": "#/components/schemas/indices.update_aliases.AddAction"
}
]
},
"remove": {
"description": "Removes a data stream or index from an alias.",
"allOf": [
{
"$ref": "#/components/schemas/indices.update_aliases.RemoveAction"
}
]
},
"remove_index": {
"description": "Deletes an index.\nYou cannot use this action on aliases or data streams.",
"allOf": [
{
"$ref": "#/components/schemas/indices.update_aliases.RemoveIndexAction"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"indices.update_aliases.AddAction": {
"type": "object",
"properties": {
"alias": {
"description": "Alias for the action.\nIndex alias names support date math.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexAlias"
}
]
},
"aliases": {
"description": "Aliases for the action.\nIndex alias names support date math.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexAlias"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexAlias"
}
}
]
},
"filter": {
"description": "Query used to limit documents the alias can access.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"index": {
"description": "Data stream or index for the action.\nSupports wildcards (`*`).",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"indices": {
"description": "Data streams or indices for the action.\nSupports wildcards (`*`).",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"index_routing": {
"description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.",
"type": "string"
},
"is_hidden": {
"description": "If `true`, the alias is hidden.",
"default": false,
"type": "boolean"
},
"is_write_index": {
"description": "If `true`, sets the write index or data stream for the alias.",
"type": "boolean"
},
"routing": {
"description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.",
"type": "string"
},
"search_routing": {
"description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.",
"type": "string"
},
"must_exist": {
"description": "If `true`, the alias must exist to perform the action.",
"default": false,
"type": "boolean"
}
}
},
"indices.update_aliases.RemoveAction": {
"type": "object",
"properties": {
"alias": {
"description": "Alias for the action.\nIndex alias names support date math.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexAlias"
}
]
},
"aliases": {
"description": "Aliases for the action.\nIndex alias names support date math.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexAlias"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexAlias"
}
}
]
},
"index": {
"description": "Data stream or index for the action.\nSupports wildcards (`*`).",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"indices": {
"description": "Data streams or indices for the action.\nSupports wildcards (`*`).",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"must_exist": {
"description": "If `true`, the alias must exist to perform the action.",
"default": false,
"type": "boolean"
}
}
},
"indices.update_aliases.RemoveIndexAction": {
"type": "object",
"properties": {
"index": {
"description": "Data stream or index for the action.\nSupports wildcards (`*`).",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"indices": {
"description": "Data streams or indices for the action.\nSupports wildcards (`*`).",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"must_exist": {
"description": "If `true`, the alias must exist to perform the action.",
"default": false,
"type": "boolean"
}
}
},
"indices.validate_query.IndicesValidationExplanation": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"explanation": {
"type": "string"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shard": {
"type": "number"
},
"valid": {
"type": "boolean"
}
},
"required": [
"valid"
]
},
"inference._types.RequestChatCompletion": {
"type": "object",
"properties": {
"messages": {
"description": "A list of objects representing the conversation.\nRequests should generally only add new messages from the user (role `user`).\nThe other message roles (`assistant`, `system`, or `tool`) should generally only be copied from the response to a previous completion request, such that the messages array is built up throughout a conversation.",
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.Message"
}
},
"model": {
"description": "The ID of the model to use. By default, the model ID is set to the value included when creating the inference endpoint.",
"type": "string"
},
"max_completion_tokens": {
"description": "The upper bound limit for the number of tokens that can be generated for a completion request.",
"type": "number"
},
"reasoning": {
"description": "The reasoning configuration for the completion request.\nThis controls the model's reasoning process in one of two ways:\n\n* By specifying the model’s reasoning effort level with the `effort` field.\n* By enabling reasoning with default settings by setting `enabled` field to `true`.\n\nIt also includes optional settings to control:\n\n* The level of detail in the summary returned in the response with the `summary` field.\n* Whether reasoning details are included in the response at all with the `exclude` field.\n\nExample (effort):\n```\n{\n \"reasoning\": {\n \"effort\": \"high\",\n \"summary\": \"concise\",\n \"exclude\": false\n }\n}\n```\nExample (enabled):\n```\n{\n \"reasoning\": {\n \"enabled\": true,\n \"summary\": \"concise\",\n \"exclude\": false\n }\n}\n```\nCurrently supported only for `elastic` provider.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.Reasoning"
}
]
},
"stop": {
"description": "A sequence of strings to control when the model should stop generating additional tokens.",
"type": "array",
"items": {
"type": "string"
}
},
"temperature": {
"description": "The sampling temperature to use.",
"type": "number"
},
"tool_choice": {
"description": "Controls which tool is called by the model.\nString representation: One of `auto`, `none`, or `requrired`. `auto` allows the model to choose between calling tools and generating a message. `none` causes the model to not call any tools. `required` forces the model to call one or more tools.\nExample (object representation):\n```\n{\n \"tool_choice\": {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\"\n }\n }\n}\n```",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CompletionToolType"
}
]
},
"tools": {
"description": "A list of tools that the model can call.\nExample:\n```\n{\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_price_of_item\",\n \"description\": \"Get the current price of an item\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"id\": \"12345\"\n },\n \"unit\": {\n \"type\": \"currency\"\n }\n }\n }\n }\n }\n ]\n}\n```",
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.CompletionTool"
}
},
"top_p": {
"description": "Nucleus sampling, an alternative to sampling with temperature.",
"type": "number"
}
},
"required": [
"messages"
]
},
"inference._types.Message": {
"description": "An object representing part of the conversation.",
"type": "object",
"properties": {
"content": {
"description": "The content of the message.\n\nString example:\n```\n{\n \"content\": \"Some string\"\n}\n```\n\nText example:\n```\n{\n \"content\": [\n {\n \"text\": \"Some text\",\n \"type\": \"text\"\n }\n ]\n}\n```\n\nImage example:\n```\n{\n \"content\": [\n {\n \"image_url\": {\n \"url\": \"data:image/jpeg;base64,...\"\n },\n \"type\": \"image_url\"\n }\n ]\n}\n```\n\nFile example:\n```\n{\n \"content\": [\n {\n \"file\": {\n \"file_data\": \"data:application/pdf;base64,...\",\n \"filename\": \"somePDF\"\n },\n \"type\": \"file\"\n }\n ]\n}\n```",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.MessageContent"
}
]
},
"role": {
"description": "The role of the message author. Valid values are `user`, `assistant`, `system`, and `tool`.",
"type": "string"
},
"tool_call_id": {
"description": "Only for `tool` role messages. The tool call that this message is responding to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"tool_calls": {
"description": "Only for `assistant` role messages. The tool calls generated by the model. If it's specified, the `content` field is optional.\nExample:\n```\n{\n \"tool_calls\": [\n {\n \"id\": \"call_KcAjWtAww20AihPHphUh46Gd\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"arguments\": \"{\\\"location\\\":\\\"Boston, MA\\\"}\"\n }\n }\n ]\n}\n```",
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.ToolCall"
}
},
"reasoning": {
"description": "Only for `assistant` role messages. The reasoning details generated by the model as plaintext.\nCurrently supported only for `elastic` provider.",
"type": "string"
},
"reasoning_details": {
"description": "Only for `assistant` role messages. The reasoning details generated by the model as structured data.\nCurrently supported only for `elastic` provider.",
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.ReasoningDetail"
}
}
},
"required": [
"role"
]
},
"inference._types.MessageContent": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.ContentObject"
}
}
]
},
"inference._types.ContentObject": {
"description": "An object style representation of a single portion of a conversation.",
"type": "object",
"properties": {
"type": {
"description": "The type of content. Must be one of `text`, `image_url` or `file`. Not all services/models support content\ntypes other than \"text\"",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.ContentType"
}
]
},
"text": {
"description": "The text content. Only applicable for the `text` type",
"type": "string"
},
"image_url": {
"description": "The image content. Only applicable for the `image_url` type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.ImageUrl"
}
]
},
"file": {
"description": "The file content. Only applicable for the `file` type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.FileContent"
}
]
}
},
"required": [
"type",
"text",
"image_url",
"file"
]
},
"inference._types.ContentType": {
"type": "string",
"enum": [
"text",
"image_url",
"file"
]
},
"inference._types.ImageUrl": {
"type": "object",
"properties": {
"url": {
"description": "The base64 encoded image data as a data URI",
"type": "string"
},
"detail": {
"description": "Specifies the detail level of the image",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.ImageUrlDetail"
}
]
}
},
"required": [
"url"
]
},
"inference._types.ImageUrlDetail": {
"type": "string",
"enum": [
"auto",
"low",
"high"
]
},
"inference._types.FileContent": {
"type": "object",
"properties": {
"file_data": {
"description": "The base64 encoded file data",
"type": "string"
},
"filename": {
"description": "The name of the file",
"type": "string"
}
},
"required": [
"file_data",
"filename"
]
},
"inference._types.ToolCall": {
"description": "A tool call generated by the model.",
"type": "object",
"properties": {
"id": {
"description": "The identifier of the tool call.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"function": {
"description": "The function that the model called.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.ToolCallFunction"
}
]
},
"type": {
"description": "The type of the tool call.",
"type": "string"
}
},
"required": [
"id",
"function",
"type"
]
},
"inference._types.ToolCallFunction": {
"description": "The function that the model called.",
"type": "object",
"properties": {
"arguments": {
"description": "The arguments to call the function with in JSON format.",
"type": "string"
},
"name": {
"description": "The name of the function to call.",
"type": "string"
}
},
"required": [
"arguments",
"name"
]
},
"inference._types.ReasoningDetail": {
"description": "Type representing the different types of reasoning details that can be included in the response from the model.\nCurrently supported only for `elastic` provider.",
"discriminator": {
"propertyName": "type",
"mapping": {
"reasoning.encrypted": "#/components/schemas/inference._types.EncryptedReasoningDetail",
"reasoning.summary": "#/components/schemas/inference._types.SummaryReasoningDetail",
"reasoning.text": "#/components/schemas/inference._types.TextReasoningDetail"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/inference._types.EncryptedReasoningDetail"
},
{
"$ref": "#/components/schemas/inference._types.SummaryReasoningDetail"
},
{
"$ref": "#/components/schemas/inference._types.TextReasoningDetail"
}
]
},
"inference._types.EncryptedReasoningDetail": {
"description": "The reasoning detail with encrypted reasoning data that may be redacted or protected.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.BaseReasoningDetail"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"reasoning.encrypted"
]
},
"data": {
"description": "The encrypted reasoning data generated by the model,\nwhich may be redacted or protected based on the model's configuration and the nature of the reasoning information.",
"type": "string"
}
},
"required": [
"type",
"data"
]
}
]
},
"inference._types.BaseReasoningDetail": {
"description": "The base reasoning detail that includes common fields across different types of reasoning details.",
"type": "object",
"properties": {
"format": {
"description": "The format of the reasoning detail.",
"type": "string"
},
"id": {
"description": "The identifier of the reasoning detail.",
"type": "string"
},
"index": {
"description": "The index of the reasoning detail,\nwhich indicates its position in the sequence of reasoning details generated by the model.",
"type": "number"
}
}
},
"inference._types.SummaryReasoningDetail": {
"description": "The reasoning summary detail includes a high-level summary of the model's reasoning process.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.BaseReasoningDetail"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"reasoning.summary"
]
},
"summary": {
"description": "The summary of the reasoning process generated by the model,\nwhich provides an overview of the key points and conclusions reached during the reasoning process.",
"type": "string"
}
},
"required": [
"type",
"summary"
]
}
]
},
"inference._types.TextReasoningDetail": {
"description": "The reasoning text detail includes plaintext reasoning with optional signature verification.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.BaseReasoningDetail"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"reasoning.text"
]
},
"signature": {
"description": "The signature of the reasoning text,\nwhich can be used to verify the authenticity and integrity of the reasoning information provided by the model.",
"type": "string"
},
"text": {
"description": "The plaintext reasoning generated by the model,\nwhich provides a detailed explanation of the model's reasoning process in human-readable form.",
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"inference._types.Reasoning": {
"description": "The reasoning configuration to use for the completion request.\nCurrently supported only for `elastic` provider.",
"type": "object",
"properties": {
"effort": {
"description": "The level of effort the model should put into reasoning.\nThis is a hint that guides the model in how much effort to put into reasoning,\nwith `xhigh` being the most effort and `none` being no effort.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.ReasoningEffort"
}
]
},
"enabled": {
"description": "Whether to enable reasoning with default settings.\nThis is a shortcut for enabling reasoning without having to specify the other parameters.\nIf `enabled` is set to `true`, then reasoning at the `medium` effort level is enabled.\nIgnored if `effort` is specified,\nin which case that parameter will control the reasoning process instead.",
"type": "boolean"
},
"exclude": {
"description": "Whether to exclude reasoning information from the response.\nIf `true`, the response will not include any reasoning details.",
"type": "boolean"
},
"summary": {
"description": "The level of detail included in the reasoning summary returned in the response.\nThis is a hint on how much detail to include in the summary of the reasoning that is returned in the response,\nwith `auto` being the default level of detail, `concise` being less detail, and `detailed` being more detail.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.ReasoningSummary"
}
]
}
}
},
"inference._types.ReasoningEffort": {
"type": "string",
"enum": [
"xhigh",
"high",
"medium",
"low",
"minimal",
"none"
]
},
"inference._types.ReasoningSummary": {
"type": "string",
"enum": [
"auto",
"concise",
"detailed"
]
},
"inference._types.CompletionToolType": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/inference._types.CompletionToolChoice"
}
]
},
"inference._types.CompletionToolChoice": {
"description": "Controls which tool is called by the model.",
"type": "object",
"properties": {
"type": {
"description": "The type of the tool.",
"type": "string"
},
"function": {
"description": "The tool choice function.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CompletionToolChoiceFunction"
}
]
}
},
"required": [
"type",
"function"
]
},
"inference._types.CompletionToolChoiceFunction": {
"description": "The tool choice function.",
"type": "object",
"properties": {
"name": {
"description": "The name of the function to call.",
"type": "string"
}
},
"required": [
"name"
]
},
"inference._types.CompletionTool": {
"description": "A list of tools that the model can call.",
"type": "object",
"properties": {
"type": {
"description": "The type of tool.",
"type": "string"
},
"function": {
"description": "The function definition.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CompletionToolFunction"
}
]
}
},
"required": [
"type",
"function"
]
},
"inference._types.CompletionToolFunction": {
"description": "The completion tool function definition.",
"type": "object",
"properties": {
"description": {
"description": "A description of what the function does.\nThis is used by the model to choose when and how to call the function.",
"type": "string"
},
"name": {
"description": "The name of the function.",
"type": "string"
},
"parameters": {
"description": "The parameters the functional accepts. This should be formatted as a JSON object.",
"type": "object"
},
"strict": {
"description": "Whether to enable schema adherence when generating the function call.",
"type": "boolean"
}
},
"required": [
"name"
]
},
"_types.StreamResult": {
"type": "object"
},
"inference._types.TaskSettings": {
"type": "object"
},
"inference._types.CompletionInferenceResult": {
"description": "Defines the completion result.",
"type": "object",
"properties": {
"completion": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.CompletionResult"
}
}
},
"required": [
"completion"
]
},
"inference._types.CompletionResult": {
"description": "The completion result object",
"type": "object",
"properties": {
"result": {
"type": "string"
}
},
"required": [
"result"
]
},
"inference._types.TaskType": {
"type": "string",
"enum": [
"sparse_embedding",
"text_embedding",
"rerank",
"completion",
"chat_completion",
"embedding"
]
},
"inference._types.DeleteInferenceEndpointResult": {
"description": "Acknowledged response. For dry_run, contains the list of pipelines which reference the inference endpoint",
"allOf": [
{
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
{
"type": "object",
"properties": {
"pipelines": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"pipelines"
]
}
]
},
"inference._types.RequestEmbedding": {
"type": "object",
"properties": {
"input": {
"description": "Inference input.\nEither a string, an array of strings, a `content` object, or an array of `content` objects.\n`content` objects may contain a single item or an array of items. Models that support multiple items per `content`\nobject will return a single embedding for each `content` object, regardless of how many items it contains.\n\nstring example:\n```\n\"input\": \"Some text\"\n```\nstring array example:\n```\n\"input\": [\"Some text\", \"Some more text\"]\n```\n`content` object example:\n```\n\"input\": {\n \"content\": {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n }\n }\n```\n`content` object array example:\n```\n\"input\": [\n {\n \"content\": {\n \"type\": \"text\",\n \"format\": \"text\",\n \"value\": \"Some text to generate an embedding\"\n }\n },\n {\n \"content\": {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n }\n }\n]\n```\nMultiple items in one `content` object example:\n```\n\"input\": [\n {\n \"content\": [\n {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n },\n {\n \"type\": \"text\",\n \"value\": \"Some text to create an embedding\"\n }\n ]\n }\n]\n```",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingInput"
}
]
},
"input_type": {
"description": "The input data type for the embedding model. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\n\nNot all models support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.",
"type": "string"
},
"task_settings": {
"description": "Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskSettings"
}
]
}
},
"required": [
"input"
]
},
"inference._types.EmbeddingInput": {
"description": "Inference input.\nEither a string, an array of strings, a `content` object, or an array of `content` objects.",
"oneOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingStringInput"
},
{
"$ref": "#/components/schemas/inference._types.EmbeddingContentInput"
}
]
},
"inference._types.EmbeddingStringInput": {
"description": "Allows specifying text-only inputs for the `embedding` task.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"inference._types.EmbeddingContentInput": {
"description": "Allows specifying multimodal inputs for the `embedding` task.",
"oneOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingContentObject"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.EmbeddingContentObject"
}
}
]
},
"inference._types.EmbeddingContentObject": {
"description": "A wrapper object which contains the fields required to specify multimodal inputs",
"type": "object",
"properties": {
"content": {
"description": "An object or an array of objects containing the input data for the model to embed",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingContentObjectGroup"
}
]
}
},
"required": [
"content"
]
},
"inference._types.EmbeddingContentObjectGroup": {
"description": "Allows specifying one or multiple items for the `embedding` task, which should result in a single embedding vector.",
"oneOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingContentObjectItem"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.EmbeddingContentObjectItem"
}
}
]
},
"inference._types.EmbeddingContentObjectItem": {
"description": "An object containing the input data for a single item for the model to embed.",
"type": "object",
"properties": {
"type": {
"description": "The type of input to embed. Not all models support all input types.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingContentType"
}
]
},
"format": {
"description": "The format of the input. For the `text` type this must be `text`. For all other types, this must be `base64`.\nIf not specified, this will default to `text` for the `text` type and `base64` for all other types.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.EmbeddingContentFormat"
}
]
},
"value": {
"description": "The value of the input to embed. For images, this must be a base64-encoded data URI, i.e. \"data:content/type;base64,...\"",
"type": "string"
}
},
"required": [
"type",
"value"
]
},
"inference._types.EmbeddingInferenceResult": {
"description": "EmbeddingInferenceResult is an aggregation of mutually exclusive embeddings variants",
"type": "object",
"properties": {
"embeddings_bytes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingByteResult"
}
},
"embeddings_bits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingByteResult"
}
},
"embeddings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingResult"
}
}
},
"minProperties": 1,
"maxProperties": 1
},
"inference._types.DenseEmbeddingByteResult": {
"description": "The dense embedding result object for byte representation",
"type": "object",
"properties": {
"embedding": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.DenseByteVector"
}
]
}
},
"required": [
"embedding"
]
},
"inference._types.DenseByteVector": {
"description": "Dense Embedding results containing bytes are represented as Dense\nVectors of bytes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.byte"
}
},
"inference._types.DenseEmbeddingResult": {
"description": "The dense embedding result object for float representation",
"type": "object",
"properties": {
"embedding": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.DenseVector"
}
]
}
},
"required": [
"embedding"
]
},
"inference._types.DenseVector": {
"description": "Dense Embedding results are represented as Dense Vectors\nof floats.",
"type": "array",
"items": {
"type": "number"
}
},
"inference._types.InferenceEndpointInfo": {
"description": "Represents an inference endpoint as returned by the GET API",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskType"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.InferenceEndpoint": {
"description": "Configuration options when storing the inference endpoint",
"type": "object",
"properties": {
"chunking_settings": {
"description": "The chunking configuration object.\nApplies only to the `embedding`, `sparse_embedding` and `text_embedding` task types.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceChunkingSettings"
}
]
},
"service": {
"description": "The service type",
"type": "string"
},
"service_settings": {
"description": "Settings specific to the service",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.ServiceSettings"
}
]
},
"task_settings": {
"description": "Task settings specific to the service and task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskSettings"
}
]
}
},
"required": [
"service",
"service_settings"
]
},
"inference._types.InferenceChunkingSettings": {
"description": "Chunking configuration object",
"type": "object",
"properties": {
"max_chunk_size": {
"description": "The maximum size of a chunk in words.\nThis value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).\nThis value should not exceed the window size for the associated model.",
"default": 250,
"type": "number"
},
"overlap": {
"description": "The number of overlapping words for chunks.\nIt is applicable only to a `word` chunking strategy.\nThis value cannot be higher than half the `max_chunk_size` value.",
"default": 100,
"type": "number"
},
"sentence_overlap": {
"description": "The number of overlapping sentences for chunks.\nIt is applicable only for a `sentence` chunking strategy.\nIt can be either `1` or `0`.",
"default": 1,
"type": "number"
},
"separator_group": {
"description": "Only applicable to the `recursive` strategy and required when using it.\n\nSets a predefined list of separators in the saved chunking settings based on the selected text type.\nValues can be `markdown` or `plaintext`.\n\nUsing this parameter is an alternative to manually specifying a custom `separators` list.",
"type": "string"
},
"separators": {
"description": "Only applicable to the `recursive` strategy and required when using it.\n\nA list of strings used as possible split points when chunking text.\n\nEach string can be a plain string or a regular expression (regex) pattern.\nThe system tries each separator in order to split the text, starting from the first item in the list.\n\nAfter splitting, it attempts to recombine smaller pieces into larger chunks that stay within\nthe `max_chunk_size` limit, to reduce the total number of chunks generated.",
"type": "array",
"items": {
"type": "string"
}
},
"strategy": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies"
},
"description": "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation.",
"default": "sentence",
"type": "string"
}
}
},
"inference._types.ServiceSettings": {
"type": "object"
},
"inference._types.InferenceResult": {
"description": "InferenceResult is an aggregation of mutually exclusive variants",
"type": "object",
"properties": {
"embeddings_bytes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingByteResult"
}
},
"embeddings_bits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingByteResult"
}
},
"embeddings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingResult"
}
},
"text_embedding_bytes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingByteResult"
}
},
"text_embedding_bits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingByteResult"
}
},
"text_embedding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingResult"
}
},
"sparse_embedding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.SparseEmbeddingResult"
}
},
"completion": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.CompletionResult"
}
},
"rerank": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.RankedDocument"
}
}
},
"minProperties": 1,
"maxProperties": 1
},
"inference._types.SparseEmbeddingResult": {
"type": "object",
"properties": {
"is_truncated": {
"description": "Indicates if the text input was truncated in the request sent to the service",
"type": "boolean"
},
"embedding": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.SparseVector"
}
]
}
},
"required": [
"is_truncated",
"embedding"
]
},
"inference._types.SparseVector": {
"description": "Sparse Embedding tokens are represented as a dictionary\nof string to double.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"inference._types.RankedDocument": {
"description": "The rerank result object representing a single ranked document\nid: the original index of the document in the request\nrelevance_score: the relevance_score of the document relative to the query\ntext: Optional, the text of the document, if requested",
"type": "object",
"properties": {
"index": {
"type": "number"
},
"relevance_score": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": [
"index",
"relevance_score"
]
},
"inference._types.Ai21TaskType": {
"type": "string",
"enum": [
"completion",
"chat_completion"
]
},
"inference._types.Ai21ServiceType": {
"type": "string",
"enum": [
"ai21"
]
},
"inference._types.Ai21ServiceSettings": {
"type": "object",
"properties": {
"model_id": {
"externalDocs": {
"url": "https://docs.ai21.com/docs/jamba-foundation-models"
},
"description": "The name of the model to use for the inference task.\nRefer to the AI21 models documentation for the list of supported models and versions.\nService has been tested and confirmed to be working for `completion` and `chat_completion` tasks with the following models:\n* `jamba-mini`\n* `jamba-large`",
"type": "string"
},
"api_key": {
"description": "A valid API key for accessing AI21 API.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"rate_limit": {
"externalDocs": {
"url": "https://docs.ai21.com/reference/api-rate-limits"
},
"description": "This setting helps to minimize the number of rate limit errors returned from the AI21 API.\nBy default, the `ai21` service sets the number of requests allowed per minute to 200. Please refer to AI21 documentation for more details.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"model_id"
]
},
"inference._types.RateLimitSetting": {
"description": "This setting helps to minimize the number of rate limit errors returned from the service.",
"type": "object",
"properties": {
"requests_per_minute": {
"description": "The number of requests allowed per minute.\nBy default, the number of requests allowed per minute is set by each service as follows:\n\n* `alibabacloud-ai-search` service: `1000`\n* `amazonbedrock` service: `240`\n* `anthropic` service: `50`\n* `azureaistudio` service: `240`\n* `azureopenai` service and task type `text_embedding`: `1440`\n* `azureopenai` service and task types `completion` or `chat_completion`: `120`\n* `cohere` service: `10000`\n* `contextualai` service: `1000`\n* `elastic` service and task type `chat_completion`: `240`\n* `fireworksai` service: `6000`\n* `googleaistudio` service: `360`\n* `googlevertexai` service: `30000`\n* `hugging_face` service: `3000`\n* `jinaai` service: `2000`\n* `llama` service: `3000`\n* `mistral` service: `240`\n* `openai` service and task type `text_embedding`: `3000`\n* `openai` service and task type `completion`: `500`\n* `openshift_ai` service: `3000`\n* `voyageai` service: `2000`\n* `watsonxai` service: `120`",
"type": "number"
}
}
},
"inference._types.InferenceEndpointInfoAi21": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeAi21"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeAi21": {
"type": "string",
"enum": [
"completion",
"chat_completion"
]
},
"inference._types.AlibabaCloudTaskType": {
"type": "string",
"enum": [
"completion",
"rerank",
"sparse_embedding",
"text_embedding"
]
},
"inference._types.AlibabaCloudServiceType": {
"type": "string",
"enum": [
"alibabacloud-ai-search"
]
},
"inference._types.AlibabaCloudServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"description": "A valid API key for the AlibabaCloud AI Search API.",
"type": "string"
},
"host": {
"externalDocs": {
"url": "https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key"
},
"description": "The name of the host address used for the inference task.\nYou can find the host address in the API keys section of the documentation.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search.\nBy default, the `alibabacloud-ai-search` service sets the number of requests allowed per minute to `1000`.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"service_id": {
"description": "The name of the model service to use for the inference task.\nThe following service IDs are available for the `completion` task:\n\n* `ops-qwen-turbo`\n* `qwen-turbo`\n* `qwen-plus`\n* `qwen-max ÷ qwen-max-longcontext`\n\nThe following service ID is available for the `rerank` task:\n\n* `ops-bge-reranker-larger`\n\nThe following service ID is available for the `sparse_embedding` task:\n\n* `ops-text-sparse-embedding-001`\n\nThe following service IDs are available for the `text_embedding` task:\n\n`ops-text-embedding-001`\n`ops-text-embedding-zh-001`\n`ops-text-embedding-en-001`\n`ops-text-embedding-002`",
"type": "string"
},
"workspace": {
"description": "The name of the workspace used for the inference task.",
"type": "string"
}
},
"required": [
"api_key",
"host",
"service_id",
"workspace"
]
},
"inference._types.AlibabaCloudTaskSettings": {
"type": "object",
"properties": {
"input_type": {
"description": "For a `sparse_embedding` or `text_embedding` task, specify the type of input passed to the model.\nValid values are:\n\n* `ingest` for storing document embeddings in a vector database.\n* `search` for storing embeddings of search queries run against a vector database to find relevant documents.",
"type": "string"
},
"return_token": {
"description": "For a `sparse_embedding` task, it affects whether the token name will be returned in the response.\nIt defaults to `false`, which means only the token ID will be returned in the response.",
"type": "boolean"
}
}
},
"inference._types.InferenceEndpointInfoAlibabaCloudAI": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeAlibabaCloudAI"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeAlibabaCloudAI": {
"type": "string",
"enum": [
"text_embedding",
"rerank",
"completion",
"sparse_embedding"
]
},
"inference._types.AmazonBedrockTaskType": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"text_embedding"
]
},
"inference._types.AmazonBedrockServiceType": {
"type": "string",
"enum": [
"amazonbedrock"
]
},
"inference._types.AmazonBedrockServiceSettings": {
"type": "object",
"properties": {
"access_key": {
"description": "A valid AWS access key that has permissions to use Amazon Bedrock and access to models for inference requests.",
"type": "string"
},
"model": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html"
},
"description": "The base model ID or an ARN to a custom model based on a foundational model.\nThe base model IDs can be found in the Amazon Bedrock documentation.\nNote that the model ID must be available for the provider chosen and your IAM user must have access to the model.",
"type": "string"
},
"provider": {
"description": "The model provider for your deployment.\nNote that some providers may support only certain task types.\nSupported providers include:\n\n* `amazontitan` - available for `text_embedding` and `completion` task types\n* `anthropic` - available for `chat_completion` and `completion` task types\n* `ai21labs` - available for `chat_completion` and `completion` task types\n* `cohere` - available for `chat_completion`, `completion` and `text_embedding` task types\n* `meta` - available for `chat_completion` and `completion` task types\n* `mistral` - available for `chat_completion` and `completion` task types",
"type": "string"
},
"region": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html"
},
"description": "The region that your model or ARN is deployed in.\nThe list of available regions per model can be found in the Amazon Bedrock documentation.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Amazon Bedrock.\nBy default, the `amazonbedrock` service sets the number of requests allowed per minute to 240.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"secret_key": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html"
},
"description": "A valid AWS secret key that is paired with the `access_key`.\nFor informationg about creating and managing access and secret keys, refer to the AWS documentation.",
"type": "string"
}
},
"required": [
"access_key",
"model",
"region",
"secret_key"
]
},
"inference._types.AmazonBedrockTaskSettings": {
"type": "object",
"properties": {
"max_new_tokens": {
"description": "For `chat_completion` and `completion` tasks, it sets the maximum number for the output tokens to be generated.",
"default": 64,
"type": "number"
},
"temperature": {
"description": "For `chat_completion` and `completion` tasks, it is a number between 0.0 and 1.0 that controls the apparent creativity of the results.\nAt temperature 0.0 the model is most deterministic, at temperature 1.0 most random.\nIt should not be used if `top_p` or `top_k` is specified.",
"type": "number"
},
"top_k": {
"description": "For `chat_completion` and `completion` tasks, it limits samples to the top-K most likely words, balancing coherence and variability.\nIt is only available for anthropic, cohere, and mistral providers.\nIt is an alternative to `temperature`; it should not be used if `temperature` is specified.",
"type": "number"
},
"top_p": {
"description": "For `chat_completion` and `completion` tasks, it is a number in the range of 0.0 to 1.0, to eliminate low-probability tokens.\nTop-p uses nucleus sampling to select top tokens whose sum of likelihoods does not exceed a certain value, ensuring both variety and coherence.\nIt is an alternative to `temperature`; it should not be used if `temperature` is specified.",
"type": "number"
}
}
},
"inference._types.InferenceEndpointInfoAmazonBedrock": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeAmazonBedrock"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeAmazonBedrock": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"text_embedding"
]
},
"inference._types.TaskTypeAmazonSageMaker": {
"type": "string",
"enum": [
"text_embedding",
"completion",
"chat_completion",
"sparse_embedding",
"rerank"
]
},
"inference._types.AmazonSageMakerServiceType": {
"type": "string",
"enum": [
"amazon_sagemaker"
]
},
"inference._types.AmazonSageMakerServiceSettings": {
"type": "object",
"properties": {
"access_key": {
"description": "A valid AWS access key that has permissions to use Amazon SageMaker and access to models for invoking requests.",
"type": "string"
},
"endpoint_name": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The name of the SageMaker endpoint.",
"type": "string"
},
"api": {
"description": "The API format to use when calling SageMaker.\nElasticsearch will convert the POST _inference request to this data format when invoking the SageMaker endpoint.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.AmazonSageMakerApi"
}
]
},
"region": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The region that your endpoint or Amazon Resource Name (ARN) is deployed in.\nThe list of available regions per model can be found in the Amazon SageMaker documentation.",
"type": "string"
},
"secret_key": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html"
},
"description": "A valid AWS secret key that is paired with the `access_key`.\nFor information about creating and managing access and secret keys, refer to the AWS documentation.",
"type": "string"
},
"similarity": {
"description": "Required when `api` is `elastic` and task type is `text_embedding`. The similarity measure used when invoking the\n`text_embedding` task type.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.AmazonSageMakerSimilarity"
}
]
},
"element_type": {
"description": "Required when `api` is `elastic` and task type is `text_embedding`. The data type returned by the text embedding\nmodel.\nThis value is used when parsing the response back to Elasticsearch data structures.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.AmazonSageMakerElementType"
}
]
},
"target_model": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The model ID when calling a multi-model endpoint.",
"type": "string"
},
"target_container_hostname": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The container to directly invoke when calling a multi-container endpoint.",
"type": "string"
},
"inference_component_name": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The inference component to directly invoke when calling a multi-component endpoint.",
"type": "string"
},
"batch_size": {
"description": "The maximum number of inputs in each batch. This value is used by inference ingestion pipelines\nwhen processing semantic values. It correlates to the number of times the SageMaker endpoint is\ninvoked (one per batch of input).",
"default": 256,
"type": "number"
},
"dimensions": {
"description": "The number of dimensions returned by the text embedding models. If this value is not provided, then\nit is guessed by making invoking the endpoint for the `text_embedding` task.",
"type": "number"
}
},
"required": [
"access_key",
"endpoint_name",
"api",
"region",
"secret_key"
]
},
"inference._types.AmazonSageMakerApi": {
"type": "string",
"enum": [
"openai",
"elastic"
]
},
"inference._types.AmazonSageMakerSimilarity": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm"
]
},
"inference._types.AmazonSageMakerElementType": {
"type": "string",
"enum": [
"byte",
"float",
"bit"
]
},
"inference._types.AmazonSageMakerTaskSettings": {
"type": "object",
"properties": {
"custom_attributes": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The AWS custom attributes passed verbatim through to the model running in the SageMaker Endpoint.\nValues will be returned in the `X-elastic-sagemaker-custom-attributes` header.",
"type": "string"
},
"enable_explanations": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The optional JMESPath expression used to override the EnableExplanations provided during endpoint creation.",
"type": "string"
},
"inference_id": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The capture data ID when enabled in the endpoint.",
"type": "string"
},
"session_id": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "The stateful session identifier for a new or existing session.\nNew sessions will be returned in the `X-elastic-sagemaker-new-session-id` header.\nClosed sessions will be returned in the `X-elastic-sagemaker-closed-session-id` header.",
"type": "string"
},
"target_variant": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
},
"description": "Specifies the variant when running with multi-variant Endpoints.",
"type": "string"
}
}
},
"inference._types.InferenceEndpointInfoAmazonSageMaker": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeAmazonSageMaker"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.AnthropicTaskType": {
"type": "string",
"enum": [
"completion",
"chat_completion"
]
},
"inference._types.AnthropicServiceType": {
"type": "string",
"enum": [
"anthropic"
]
},
"inference._types.AnthropicServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"description": "A valid API key for the Anthropic API.",
"type": "string"
},
"model_id": {
"description": "The name of the model to use for the inference task.\nRefer to the Anthropic documentation for the list of supported models.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Anthropic.\nBy default, the `anthropic` service sets the number of requests allowed per minute to 50.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.AnthropicTaskSettings": {
"type": "object",
"properties": {
"max_tokens": {
"description": "For a `completion` or `chat_completion` task, it is the maximum number of tokens to generate before stopping.",
"type": "number"
},
"temperature": {
"externalDocs": {
"url": "https://docs.anthropic.com/en/api/messages"
},
"description": "For a `completion` or `chat_completion` task, it is the amount of randomness injected into the response.\nFor more details about the supported range, refer to Anthropic documentation.",
"type": "number"
},
"top_k": {
"description": "For a `completion` or `chat_completion` task, it specifies to only sample from the top K options for each subsequent token.\nIt is recommended for advanced use cases only.\nYou usually only need to use `temperature`.",
"type": "number"
},
"top_p": {
"description": "For a `completion` or `chat_completion` task, it specifies to use Anthropic's nucleus sampling.\nIn nucleus sampling, Anthropic computes the cumulative distribution over all the options for each subsequent token in decreasing probability order and cuts it off once it reaches the specified probability.\nYou should either alter `temperature` or `top_p`, but not both.\nIt is recommended for advanced use cases only.\nYou usually only need to use `temperature`.",
"type": "number"
}
},
"required": [
"max_tokens"
]
},
"inference._types.InferenceEndpointInfoAnthropic": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeAnthropic"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeAnthropic": {
"type": "string",
"enum": [
"completion",
"chat_completion"
]
},
"inference._types.AzureAiStudioTaskType": {
"type": "string",
"enum": [
"completion",
"rerank",
"text_embedding"
]
},
"inference._types.AzureAiStudioServiceType": {
"type": "string",
"enum": [
"azureaistudio"
]
},
"inference._types.AzureAiStudioServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://ai.azure.com/"
},
"description": "A valid API key of your Azure AI Studio model deployment.\nThis key can be found on the overview page for your deployment in the management section of your Azure AI Studio account.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"endpoint_type": {
"externalDocs": {
"url": "https://learn.microsoft.com/en-us/azure/ai-foundry/concepts/deployments-overview#billing-for-deploying-and-inferencing-llms-in-azure-ai-studio"
},
"description": "The type of endpoint that is available for deployment through Azure AI Studio: `token` or `realtime`.\nThe `token` endpoint type is for \"pay as you go\" endpoints that are billed per token.\nThe `realtime` endpoint type is for \"real-time\" endpoints that are billed per hour of usage.",
"type": "string"
},
"target": {
"description": "The target URL of your Azure AI Studio model deployment.\nThis can be found on the overview page for your deployment in the management section of your Azure AI Studio account.",
"type": "string"
},
"provider": {
"description": "The model provider for your deployment.\nNote that some providers may support only certain task types.\nSupported providers include:\n\n* `cohere` - available for `text_embedding`, `rerank` and `completion` task types\n* `databricks` - available for `completion` task type only\n* `meta` - available for `completion` task type only\n* `microsoft_phi` - available for `completion` task type only\n* `mistral` - available for `completion` task type only\n* `openai` - available for `text_embedding` and `completion` task types",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Azure AI Studio.\nBy default, the `azureaistudio` service sets the number of requests allowed per minute to 240.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"api_key",
"endpoint_type",
"target",
"provider"
]
},
"inference._types.AzureAiStudioTaskSettings": {
"type": "object",
"properties": {
"do_sample": {
"description": "For a `completion` task, instruct the inference process to perform sampling.\nIt has no effect unless `temperature` or `top_p` is specified.",
"type": "number"
},
"max_new_tokens": {
"description": "For a `completion` task, provide a hint for the maximum number of output tokens to be generated.",
"type": "number"
},
"temperature": {
"description": "For a `completion` task, control the apparent creativity of generated completions with a sampling temperature.\nIt must be a number in the range of 0.0 to 2.0.\nIt should not be used if `top_p` is specified.",
"type": "number"
},
"top_p": {
"description": "For a `completion` task, make the model consider the results of the tokens with nucleus sampling probability.\nIt is an alternative value to `temperature` and must be a number in the range of 0.0 to 2.0.\nIt should not be used if `temperature` is specified.",
"type": "number"
},
"user": {
"description": "For a `text_embedding` task, specify the user issuing the request.\nThis information can be used for abuse detection.",
"type": "string"
},
"return_documents": {
"description": "For a `rerank` task, return doc text within the results.",
"type": "boolean"
},
"top_n": {
"description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.",
"type": "number"
}
}
},
"inference._types.InferenceEndpointInfoAzureAIStudio": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeAzureAIStudio"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeAzureAIStudio": {
"type": "string",
"enum": [
"text_embedding",
"completion",
"rerank"
]
},
"inference._types.AzureOpenAITaskType": {
"type": "string",
"enum": [
"completion",
"chat_completion",
"text_embedding"
]
},
"inference._types.AzureOpenAIServiceType": {
"type": "string",
"enum": [
"azureopenai"
]
},
"inference._types.AzureOpenAIServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#authentication"
},
"description": "A valid API key for your Azure OpenAI account.\n\nIMPORTANT: You must specify either `api_key`, `entra_id`, or `client_secret`.\nIf you do not provide one or you provide more than one of them, you will receive an error when you try to create your endpoint.",
"type": "string"
},
"api_version": {
"description": "The Azure API version ID to use.\nIt is recommended to use the latest supported non-preview version.",
"type": "string"
},
"client_id": {
"externalDocs": {
"url": "https://learn.microsoft.com/en-us/azure/api-management/api-management-authenticate-authorize-ai-apis#oauth-20-authorization-by-using-identity-provider"
},
"description": "For OAuth 2.0 authentication using the client credentials grant flow.\nThe application ID that's assigned to your app.\n\nIMPORTANT: To configure OAuth 2.0, you must specify client_id, scopes, tenant_id, and client_secret together.\nIf one of the fields is missing, you will receive an error when you try to create your endpoint.",
"type": "string"
},
"client_secret": {
"externalDocs": {
"url": "https://learn.microsoft.com/en-us/azure/api-management/api-management-authenticate-authorize-ai-apis#oauth-20-authorization-by-using-identity-provider"
},
"description": "For OAuth 2.0 authentication using the client credentials grant flow.\nThe application secret that you created in the Microsoft app registration portal for your app.\n\nIMPORTANT: You must specify either `api_key`, `entra_id`, or `client_secret`.\nIf you do not provide one or you provide more than one of them, you will receive an error when you try to create your endpoint.\n\nIMPORTANT: To configure OAuth 2.0, you must specify client_id, scopes, tenant_id, and client_secret together.\nIf one of the fields is missing, you will receive an error when you try to create your endpoint.",
"type": "string"
},
"deployment_id": {
"externalDocs": {
"url": "https://oai.azure.com/"
},
"description": "The deployment name of your deployed models.\nYour Azure OpenAI deployments can be found though the Azure OpenAI Studio portal that is linked to your subscription.",
"type": "string"
},
"entra_id": {
"externalDocs": {
"url": "https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#authentication"
},
"description": "A valid Microsoft Entra token.\n\nIMPORTANT: You must specify either `api_key`, `entra_id`, or `client_secret`.\nIf you do not provide one or you provide more than one of them, you will receive an error when you try to create your endpoint.",
"type": "string"
},
"rate_limit": {
"externalDocs": {
"url": "https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits"
},
"description": "This setting helps to minimize the number of rate limit errors returned from Azure.\nThe `azureopenai` service sets a default number of requests allowed per minute depending on the task type.\nFor `text_embedding`, it is set to `1440`.\nFor `completion` and `chat_completion`, it is set to `120`.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"resource_name": {
"externalDocs": {
"url": "https://portal.azure.com/#view/HubsExtension/BrowseAll"
},
"description": "The name of your Azure OpenAI resource.\nYou can find this from the list of resources in the Azure Portal for your subscription.",
"type": "string"
},
"scopes": {
"externalDocs": {
"url": "https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc"
},
"description": "For OAuth 2.0 authentication using the client credentials grant flow.\nThe resource identifier (application ID URI) of the resource you want, suffixed with .default\nFor example:\n```\n\"scopes\": [\n \"https://cognitiveservices.azure.com/.default\"\n]\n```\n\nIMPORTANT: To configure OAuth 2.0, you must specify client_id, scopes, tenant_id, and client_secret together.\nIf one of the fields is missing, you will receive an error when you try to create your endpoint.",
"type": "array",
"items": {
"type": "string"
}
},
"tenant_id": {
"externalDocs": {
"url": "https://learn.microsoft.com/en-us/azure/api-management/api-management-authenticate-authorize-ai-apis#oauth-20-authorization-by-using-identity-provider"
},
"description": "For OAuth 2.0 authentication using the client credentials grant flow.\nThe directory tenant the application plans to operate against.\n\nIMPORTANT: To configure OAuth 2.0, you must specify client_id, scopes, tenant_id, and client_secret together.\nIf one of the fields is missing, you will receive an error when you try to create your endpoint.",
"type": "string"
}
},
"required": [
"api_version",
"deployment_id",
"resource_name"
]
},
"inference._types.AzureOpenAITaskSettings": {
"type": "object",
"properties": {
"user": {
"description": "Specifies the user issuing the request.\nThis information can be used for abuse detection.",
"type": "string"
},
"headers": {
"description": "Specifies custom HTTP header parameters.\nFor example:\n```\n\"headers\": {\n \"Custom-Header\": \"Some-Value\",\n \"Another-Custom-Header\": \"Another-Value\"\n}\n```",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"inference._types.InferenceEndpointInfoAzureOpenAI": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeAzureOpenAI"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeAzureOpenAI": {
"type": "string",
"enum": [
"text_embedding",
"completion",
"chat_completion"
]
},
"inference._types.CohereTaskType": {
"type": "string",
"enum": [
"completion",
"rerank",
"text_embedding"
]
},
"inference._types.CohereServiceType": {
"type": "string",
"enum": [
"cohere"
]
},
"inference._types.CohereServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://dashboard.cohere.com/api-keys"
},
"description": "A valid API key for your Cohere account.\nYou can find or create your Cohere API keys on the Cohere API key settings page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"embedding_type": {
"description": "For a `text_embedding` task, the types of embeddings you want to get back.\nUse `binary` for binary embeddings, which are encoded as bytes with signed int8 precision.\nUse `bit` for binary embeddings, which are encoded as bytes with signed int8 precision (this is a synonym of `binary`).\nUse `byte` for signed int8 embeddings (this is a synonym of `int8`).\nUse `float` for the default float embeddings.\nUse `int8` for signed int8 embeddings.",
"default": "float",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CohereEmbeddingType"
}
]
},
"model_id": {
"description": "For a `completion`, `rerank`, or `text_embedding` task, the name of the model to use for the inference task.\n\n* For the available `completion` models, refer to the [Cohere command docs](https://docs.cohere.com/docs/models#command).\n* For the available `rerank` models, refer to the [Cohere rerank docs](https://docs.cohere.com/reference/rerank-1).\n* For the available `text_embedding` models, refer to [Cohere embed docs](https://docs.cohere.com/reference/embed).",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Cohere.\nBy default, the `cohere` service sets the number of requests allowed per minute to 10000.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"similarity": {
"description": "The similarity measure.\nIf the `embedding_type` is `float`, the default value is `dot_product`.\nIf the `embedding_type` is `int8` or `byte`, the default value is `cosine`.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CohereSimilarityType"
}
]
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.CohereEmbeddingType": {
"type": "string",
"enum": [
"binary",
"bit",
"byte",
"float",
"int8"
]
},
"inference._types.CohereSimilarityType": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm"
]
},
"inference._types.CohereTaskSettings": {
"type": "object",
"properties": {
"input_type": {
"description": "For a `text_embedding` task, the type of input passed to the model.\nValid values are:\n\n* `classification`: Use it for embeddings passed through a text classifier.\n* `clustering`: Use it for the embeddings run through a clustering algorithm.\n* `ingest`: Use it for storing document embeddings in a vector database.\n* `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents.\n\nIMPORTANT: The `input_type` field is required when using embedding models `v3` and higher.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CohereInputType"
}
]
},
"return_documents": {
"description": "For a `rerank` task, return doc text within the results.",
"type": "boolean"
},
"top_n": {
"description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.\nIf this inference endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query.",
"type": "number"
},
"truncate": {
"description": "For a `text_embedding` task, the method to handle inputs longer than the maximum token length.\nValid values are:\n\n* `END`: When the input exceeds the maximum input token length, the end of the input is discarded.\n* `NONE`: When the input exceeds the maximum input token length, an error is returned.\n* `START`: When the input exceeds the maximum input token length, the start of the input is discarded.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CohereTruncateType"
}
]
}
},
"required": [
"input_type"
]
},
"inference._types.CohereInputType": {
"type": "string",
"enum": [
"classification",
"clustering",
"ingest",
"search"
]
},
"inference._types.CohereTruncateType": {
"type": "string",
"enum": [
"END",
"NONE",
"START"
]
},
"inference._types.InferenceEndpointInfoCohere": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeCohere"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeCohere": {
"type": "string",
"enum": [
"text_embedding",
"rerank",
"completion"
]
},
"inference._types.TaskTypeContextualAI": {
"type": "string",
"enum": [
"rerank"
]
},
"inference._types.ContextualAIServiceType": {
"type": "string",
"enum": [
"contextualai"
]
},
"inference._types.ContextualAIServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"description": "A valid API key for your Contexutual AI account.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"model_id": {
"description": "The name of the model to use for the inference task.\nRefer to the Contextual AI documentation for the list of available rerank models.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Contextual AI.\nThe `contextualai` service sets a default number of requests allowed per minute depending on the task type.\nFor `rerank`, it is set to `1000`.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.ContextualAITaskSettings": {
"type": "object",
"properties": {
"instruction": {
"description": "Instructions for the reranking model. Refer to \nOnly for the `rerank` task type.",
"type": "string"
},
"top_k": {
"description": "The number of most relevant documents to return.\nIf not specified, the reranking results of all documents will be returned.\nOnly for the `rerank` task type.",
"type": "number"
}
}
},
"inference._types.InferenceEndpointInfoContextualAi": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeContextualAI"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.CustomTaskType": {
"type": "string",
"enum": [
"text_embedding",
"sparse_embedding",
"rerank",
"completion"
]
},
"inference._types.CustomServiceType": {
"type": "string",
"enum": [
"custom"
]
},
"inference._types.CustomServiceSettings": {
"type": "object",
"properties": {
"batch_size": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text#auto-text-chunking"
},
"description": "Specifies the batch size used for the semantic_text field. If the field is not provided, the default is 10.\nThe batch size is the maximum number of inputs in a single request to the upstream service.\nThe chunk within the batch are controlled by the selected chunking strategy for the semantic_text field.",
"type": "number"
},
"headers": {
"description": "Specifies the HTTP header parameters – such as `Authentication` or `Content-Type` – that are required to access the custom service.\nFor example:\n```\n\"headers\": {\n \"Authorization\": \"Bearer ${api_key}\",\n \"Content-Type\": \"application/json;charset=utf-8\"\n}\n```",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"input_type": {
"description": "Specifies the input type translation values that are used to replace the `${input_type}` template in the request body.\nFor example:\n```\n\"input_type\": {\n \"translation\": {\n \"ingest\": \"do_ingest\",\n \"search\": \"do_search\"\n },\n \"default\": \"a_default\"\n},\n```\nIf the subsequent inference requests come from a search context, the `search` key will be used and the template will be replaced with `do_search`.\nIf it comes from the ingest context `do_ingest` is used. If it's a different context that is not specified, the default value will be used. If no default is specified an empty string is used.\n`translation` can be:\n* `classification`\n* `clustering`\n* `ingest`\n* `search`",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"query_parameters": {
"description": "Specifies the query parameters as a list of tuples. The arrays inside the `query_parameters` must have two items, a key and a value.\nFor example:\n```\n\"query_parameters\":[\n [\"param_key\", \"some_value\"],\n [\"param_key\", \"another_value\"],\n [\"other_key\", \"other_value\"]\n]\n```\nIf the base url is `https://www.elastic.co` it results in: `https://www.elastic.co?param_key=some_value¶m_key=another_value&other_key=other_value`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.CustomServiceQueryParameter"
}
},
"request": {
"description": "The request configuration object.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CustomRequestParams"
}
]
},
"response": {
"description": "The response configuration object.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CustomResponseParams"
}
]
},
"secret_parameters": {
"description": "Specifies secret parameters, like `api_key` or `api_token`, that are required to access the custom service.\nFor example:\n```\n\"secret_parameters\":{\n \"api_key\":\"\"\n}\n```",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"url": {
"description": "The URL endpoint to use for the requests.",
"type": "string"
}
},
"required": [
"request",
"response",
"secret_parameters"
]
},
"inference._types.CustomServiceQueryParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"inference._types.CustomRequestParams": {
"type": "object",
"properties": {
"content": {
"description": "The body structure of the request. It requires passing in the string-escaped result of the JSON format HTTP request body.\nFor example:\n```\n\"request\": \"{\\\"input\\\":${input}}\"\n```\n> info\n> The content string needs to be a single line except when using the Kibana console.",
"type": "string"
}
},
"required": [
"content"
]
},
"inference._types.CustomResponseParams": {
"type": "object",
"properties": {
"json_parser": {
"description": "Specifies the JSON parser that is used to parse the response from the custom service.\nDifferent task types require different json_parser parameters.\nFor example:\n```\n# text_embedding\n# For a response like this:\n\n{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"embedding\",\n \"index\": 0,\n \"embedding\": [\n 0.014539449,\n -0.015288644\n ]\n }\n ],\n \"model\": \"text-embedding-ada-002-v2\",\n \"usage\": {\n \"prompt_tokens\": 8,\n \"total_tokens\": 8\n }\n}\n\n# the json_parser definition should look like this:\n\n\"response\":{\n \"json_parser\":{\n \"text_embeddings\":\"$.data[*].embedding[*]\"\n }\n}\n\n# Elasticsearch supports the following embedding types:\n* float\n* byte\n* bit (or binary)\n\nTo specify the embedding type for the response, the `embedding_type`\nfield should be added in the `json_parser` object. Here's an example:\n\"response\":{\n \"json_parser\":{\n \"text_embeddings\":\"$.data[*].embedding[*]\",\n \"embedding_type\":\"bit\"\n }\n}\n\nIf `embedding_type` is not specified, it defaults to `float`.\n\n# sparse_embedding\n# For a response like this:\n\n{\n \"request_id\": \"75C50B5B-E79E-4930-****-F48DBB392231\",\n \"latency\": 22,\n \"usage\": {\n \"token_count\": 11\n },\n \"result\": {\n \"sparse_embeddings\": [\n {\n \"index\": 0,\n \"embedding\": [\n {\n \"token_id\": 6,\n \"weight\": 0.101\n },\n {\n \"token_id\": 163040,\n \"weight\": 0.28417\n }\n ]\n }\n ]\n }\n}\n\n# the json_parser definition should look like this:\n\n\"response\":{\n \"json_parser\":{\n \"token_path\":\"$.result.sparse_embeddings[*].embedding[*].token_id\",\n \"weight_path\":\"$.result.sparse_embeddings[*].embedding[*].weight\"\n }\n}\n\n# rerank\n# For a response like this:\n\n{\n \"results\": [\n {\n \"index\": 3,\n \"relevance_score\": 0.999071,\n \"document\": \"abc\"\n },\n {\n \"index\": 4,\n \"relevance_score\": 0.7867867,\n \"document\": \"123\"\n },\n {\n \"index\": 0,\n \"relevance_score\": 0.32713068,\n \"document\": \"super\"\n }\n ],\n}\n\n# the json_parser definition should look like this:\n\n\"response\":{\n \"json_parser\":{\n \"reranked_index\":\"$.result.scores[*].index\", // optional\n \"relevance_score\":\"$.result.scores[*].score\",\n \"document_text\":\"xxx\" // optional\n }\n}\n\n# completion\n# For a response like this:\n\n{\n \"id\": \"chatcmpl-B9MBs8CjcvOU2jLn4n570S5qMJKcT\",\n \"object\": \"chat.completion\",\n \"created\": 1741569952,\n \"model\": \"gpt-4.1-2025-04-14\",\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"Hello! How can I assist you today?\",\n \"refusal\": null,\n \"annotations\": []\n },\n \"logprobs\": null,\n \"finish_reason\": \"stop\"\n }\n ]\n}\n\n# the json_parser definition should look like this:\n\n\"response\":{\n \"json_parser\":{\n \"completion_result\":\"$.choices[*].message.content\"\n }\n}",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"json_parser"
]
},
"inference._types.CustomTaskSettings": {
"type": "object",
"properties": {
"parameters": {
"description": "Specifies parameters that are required to run the custom service. The parameters depend on the model your custom service uses.\nFor example:\n```\n\"task_settings\":{\n \"parameters\":{\n \"input_type\":\"query\",\n \"return_token\":true\n }\n}\n```",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/inference._types.CustomTaskParameter"
}
}
}
},
"inference._types.CustomTaskParameter": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"inference._types.InferenceEndpointInfoCustom": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeCustom"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeCustom": {
"type": "string",
"enum": [
"text_embedding",
"sparse_embedding",
"rerank",
"completion"
]
},
"inference._types.TaskTypeDeepSeek": {
"type": "string",
"enum": [
"completion",
"chat_completion"
]
},
"inference._types.DeepSeekServiceType": {
"type": "string",
"enum": [
"deepseek"
]
},
"inference._types.DeepSeekServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://api-docs.deepseek.com/"
},
"description": "A valid API key for your DeepSeek account.\nYou can find or create your DeepSeek API keys on the DeepSeek API key page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"model_id": {
"description": "For a `completion` or `chat_completion` task, the name of the model to use for the inference task.\n\nFor the available `completion` and `chat_completion` models, refer to the [DeepSeek Models & Pricing docs](https://api-docs.deepseek.com/quick_start/pricing).",
"type": "string"
},
"url": {
"description": "The URL endpoint to use for the requests. Defaults to `https://api.deepseek.com/chat/completions`.",
"type": "string"
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.InferenceEndpointInfoDeepSeek": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeDeepSeek"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.ElasticsearchTaskType": {
"type": "string",
"enum": [
"rerank",
"sparse_embedding",
"text_embedding"
]
},
"inference._types.ElasticsearchServiceType": {
"type": "string",
"enum": [
"elasticsearch"
]
},
"inference._types.ElasticsearchServiceSettings": {
"type": "object",
"properties": {
"adaptive_allocations": {
"description": "Adaptive allocations configuration details.\nIf `enabled` is true, the number of allocations of the model is set based on the current load the process gets.\nWhen the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set.\nWhen the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set.\nIf `enabled` is true, do not set the number of allocations manually.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.AdaptiveAllocations"
}
]
},
"deployment_id": {
"description": "The deployment identifier for a trained model deployment.\nWhen `deployment_id` is used the `model_id` is optional.",
"type": "string"
},
"model_id": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-import-model#ml-nlp-import-script"
},
"description": "The name of the model to use for the inference task.\nIt can be the ID of a built-in model (for example, `.multilingual-e5-small` for E5) or a text embedding model that was uploaded by using the Eland client.",
"type": "string"
},
"num_allocations": {
"description": "The total number of allocations that are assigned to the model across machine learning nodes.\nIncreasing this value generally increases the throughput.\nIf adaptive allocations are enabled, do not set this value because it's automatically set.",
"type": "number"
},
"num_threads": {
"description": "The number of threads used by each model allocation during inference.\nThis setting generally increases the speed per inference request.\nThe inference process is a compute-bound process; `threads_per_allocations` must not exceed the number of available allocated processors per node.\nThe value must be a power of 2.\nThe maximum value is 32.",
"type": "number"
},
"long_document_strategy": {
"description": "Available only for the `rerank` task type using the Elastic reranker model.\nControls the strategy used for processing long documents during inference.\n\nPossible values:\n- `truncate` (default): Processes only the beginning of each document.\n- `chunk`: Splits long documents into smaller parts (chunks) before inference.\n\nWhen `long_document_strategy` is set to `chunk`, Elasticsearch splits each document into smaller parts but still returns a single score per document.\nThat score reflects the highest relevance score among all chunks.",
"x-state": "Experimental",
"type": "string"
},
"max_chunks_per_doc": {
"description": "Only for the `rerank` task type.\nLimits the number of chunks per document that are sent for inference when chunking is enabled.\nIf not set, all chunks generated for the document are processed.",
"x-state": "Experimental",
"type": "number"
}
},
"required": [
"model_id",
"num_threads"
]
},
"inference._types.AdaptiveAllocations": {
"type": "object",
"properties": {
"enabled": {
"description": "Turn on `adaptive_allocations`.",
"default": false,
"type": "boolean"
},
"max_number_of_allocations": {
"description": "The maximum number of allocations to scale to.\nIf set, it must be greater than or equal to `min_number_of_allocations`.",
"type": "number"
},
"min_number_of_allocations": {
"description": "The minimum number of allocations to scale to.\nIf set, it must be greater than or equal to 0.\nIf not defined, the deployment scales to 0.",
"type": "number"
}
}
},
"inference._types.ElasticsearchTaskSettings": {
"type": "object",
"properties": {
"return_documents": {
"description": "For a `rerank` task, return the document instead of only the index.",
"default": true,
"type": "boolean"
}
}
},
"inference._types.InferenceEndpointInfoElasticsearch": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeElasticsearch"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeElasticsearch": {
"type": "string",
"enum": [
"sparse_embedding",
"text_embedding",
"rerank"
]
},
"inference._types.ElserTaskType": {
"type": "string",
"enum": [
"sparse_embedding"
]
},
"inference._types.ElserServiceType": {
"type": "string",
"enum": [
"elser"
]
},
"inference._types.ElserServiceSettings": {
"type": "object",
"properties": {
"adaptive_allocations": {
"description": "Adaptive allocations configuration details.\nIf `enabled` is true, the number of allocations of the model is set based on the current load the process gets.\nWhen the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set.\nWhen the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set.\nIf `enabled` is true, do not set the number of allocations manually.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.AdaptiveAllocations"
}
]
},
"num_allocations": {
"description": "The total number of allocations this model is assigned across machine learning nodes.\nIncreasing this value generally increases the throughput.\nIf adaptive allocations is enabled, do not set this value because it's automatically set.",
"type": "number"
},
"num_threads": {
"description": "The number of threads used by each model allocation during inference.\nIncreasing this value generally increases the speed per inference request.\nThe inference process is a compute-bound process; `threads_per_allocations` must not exceed the number of available allocated processors per node.\nThe value must be a power of 2.\nThe maximum value is 32.\n\n> info\n> If you want to optimize your ELSER endpoint for ingest, set the number of threads to 1. If you want to optimize your ELSER endpoint for search, set the number of threads to greater than 1.",
"type": "number"
}
},
"required": [
"num_allocations",
"num_threads"
]
},
"inference._types.InferenceEndpointInfoELSER": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeELSER"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeELSER": {
"type": "string",
"enum": [
"sparse_embedding"
]
},
"inference._types.FireworksAITaskType": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"text_embedding"
]
},
"inference._types.FireworksAIServiceType": {
"type": "string",
"enum": [
"fireworksai"
]
},
"inference._types.FireworksAIServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://docs.fireworks.ai/"
},
"description": "A valid API key for your Fireworks AI account.\nYou can find or create your API keys in the Fireworks AI dashboard.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"model_id": {
"externalDocs": {
"url": "https://docs.fireworks.ai/guides/recommended-models"
},
"description": "The name of the model to use for the inference task.\nRefer to the Fireworks AI documentation for the list of available models for chat completion, completion, and text embedding.\nFor text embedding, supported models include the Qwen3 embedding family (e.g. `fireworks/qwen3-embedding-8b`) and other models in the Fireworks model library.",
"type": "string"
},
"url": {
"description": "The URL endpoint to use for the requests.\nIf not provided, the default Fireworks AI API endpoint is used.",
"type": "string"
},
"dimensions": {
"description": "For a `text_embedding` task, the number of dimensions the resulting output embeddings should have.\nVariable-length embeddings are supported via this parameter.",
"type": "number"
},
"similarity": {
"externalDocs": {
"url": "https://docs.fireworks.ai/guides/querying-embeddings-models"
},
"description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.",
"default": "cosine",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.FireworksAISimilarityType"
}
]
},
"rate_limit": {
"externalDocs": {
"url": "https://docs.fireworks.ai/guides/quotas_usage/rate-limits"
},
"description": "This setting helps to minimize the number of rate limit errors returned from the Fireworks AI API.\nRate limit grouping is per API key only.\nBy default, the `fireworksai` service sets the number of requests allowed per minute to 6000.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.FireworksAISimilarityType": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm"
]
},
"inference._types.FireworksAITaskSettings": {
"type": "object",
"properties": {
"user": {
"description": "For a `completion` or`chat_completion` task, specify the user issuing the request.\nThis information can be used for abuse detection.",
"type": "string"
},
"headers": {
"description": "For a `completion` or`chat_completion` task. Specifies custom HTTP header parameters.\nFor example:\n```\n\"headers\": {\n \"Custom-Header\": \"Some-Value\",\n \"Another-Custom-Header\": \"Another-Value\"\n}\n```",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"inference._types.InferenceEndpointInfoFireworksAI": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeFireworksAI"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeFireworksAI": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"text_embedding"
]
},
"inference._types.GoogleAiStudioTaskType": {
"type": "string",
"enum": [
"completion",
"text_embedding"
]
},
"inference._types.GoogleAiServiceType": {
"type": "string",
"enum": [
"googleaistudio"
]
},
"inference._types.GoogleAiStudioServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"description": "A valid API key of your Google Gemini account.",
"type": "string"
},
"model_id": {
"externalDocs": {
"url": "https://ai.google.dev/gemini-api/docs/models"
},
"description": "The name of the model to use for the inference task.\nRefer to the Google documentation for the list of supported models.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Google AI Studio.\nBy default, the `googleaistudio` service sets the number of requests allowed per minute to 360.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.InferenceEndpointInfoGoogleAIStudio": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeGoogleAIStudio"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeGoogleAIStudio": {
"type": "string",
"enum": [
"text_embedding",
"completion"
]
},
"inference._types.GoogleVertexAITaskType": {
"type": "string",
"enum": [
"rerank",
"text_embedding",
"completion",
"chat_completion"
]
},
"inference._types.GoogleVertexAIServiceType": {
"type": "string",
"enum": [
"googlevertexai"
]
},
"inference._types.GoogleVertexAIServiceSettings": {
"type": "object",
"properties": {
"provider": {
"description": "The name of the Google Model Garden Provider for `completion` and `chat_completion` tasks.\nIn order for a Google Model Garden endpoint to be used `provider` must be defined and be other than `google`.\nModes:\n- Google Model Garden (third-party models): set `provider` to a supported non-`google` value and provide `url` and/or `streaming_url`.\n- Google Vertex AI: omit `provider` or set it to `google`. In this mode, do not set `url` or `streaming_url` and Elastic will construct the endpoint url from `location`, `model_id`, and `project_id` parameters.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.GoogleModelGardenProvider"
}
]
},
"url": {
"description": "The URL for non-streaming `completion` requests to a Google Model Garden provider endpoint.\nIf both `url` and `streaming_url` are provided, each is used for its respective mode.\nIf `streaming_url` is not provided, `url` is also used for streaming `completion` and `chat_completion`.\nIf `provider` is not provided or set to `google` (Google Vertex AI), do not set `url` (or `streaming_url`).\nAt least one of `url` or `streaming_url` must be provided for Google Model Garden endpoint usage.\nCertain providers require separate URLs for streaming and non-streaming operations (e.g., Anthropic, Mistral, AI21). Others support both operation types through a single URL (e.g., Meta, Hugging Face).\nInformation on constructing the URL for various providers can be found in the Google Model Garden documentation for the model, or on the endpoint’s `Sample request` page. The request examples also illustrate the proper formatting for the `url`.",
"type": "string"
},
"streaming_url": {
"description": "The URL for streaming `completion` and `chat_completion` requests to a Google Model Garden provider endpoint.\nIf both `streaming_url` and `url` are provided, each is used for its respective mode.\nIf `url` is not provided, `streaming_url` is also used for non-streaming `completion` requests.\nIf `provider` is not provided or set to `google` (Google Vertex AI), do not set `streaming_url` (or `url`).\nAt least one of `streaming_url` or `url` must be provided for Google Model Garden endpoint usage.\nCertain providers require separate URLs for streaming and non-streaming operations (e.g., Anthropic, Mistral, AI21). Others support both operation types through a single URL (e.g., Meta, Hugging Face).\nInformation on constructing the URL for various providers can be found in the Google Model Garden documentation for the model, or on the endpoint’s `Sample request` page. The request examples also illustrate the proper formatting for the `streaming_url`.",
"type": "string"
},
"location": {
"externalDocs": {
"url": "https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations"
},
"description": "The name of the location to use for the inference task for the Google Vertex AI inference task.\nFor Google Vertex AI, when `provider` is omitted or `google` `location` is mandatory.\nFor Google Model Garden's `completion` and `chat_completion` tasks, when `provider` is a supported non-`google` value - `location` is ignored.\nRefer to the Google documentation for the list of supported locations.",
"type": "string"
},
"model_id": {
"externalDocs": {
"url": "https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/text-embeddings-api"
},
"description": "The name of the model to use for the inference task.\nFor Google Vertex AI `model_id` is mandatory.\nFor Google Model Garden's `completion` and `chat_completion` tasks, when `provider` is a supported non-`google` value - `model_id` will be used for some providers that require it, otherwise - ignored.\nRefer to the Google documentation for the list of supported models for Google Vertex AI.",
"type": "string"
},
"project_id": {
"description": "The name of the project to use for the Google Vertex AI inference task.\nFor Google Vertex AI `project_id` is mandatory.\nFor Google Model Garden's `completion` and `chat_completion` tasks, when `provider` is a supported non-`google` value - `project_id` is ignored.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Google Vertex AI.\nBy default, the `googlevertexai` service sets the number of requests allowed per minute to 30.000.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"service_account_json": {
"description": "A valid service account in JSON format for the Google Vertex AI API.",
"type": "string"
},
"dimensions": {
"externalDocs": {
"url": "https://cloud.google.com/vertex-ai/generative-ai/docs/embeddings/get-text-embeddings"
},
"description": "For a `text_embedding` task, the number of dimensions the resulting output embeddings should have.\nBy default, the model's standard output dimension is used.\nRefer to the Google documentation for more information.",
"type": "number"
},
"max_batch_size": {
"description": "Only applicable for the `text_embedding` task type.\nControls the batch size of chunked inference requests sent to Google Vertex AI.\n\nSetting this parameter lower reduces the risk of exceeding token limits but may result in more API calls. Setting it higher increases throughput but may risk hitting token limits.\n\nTo estimate a safe `max_batch_size` value, you can use it together with the `max_chunk_size` parameter using the following formula:\n`max_batch_size ≈ max_chunk_size × 1.3 × 512 ÷ 20000`\n\nWhere:\n- `1.3` is an approximate tokens-per-word ratio\n- `512` is the maximum number of chunks that can be generated per document\n- `20000` is the Google Vertex AI token limit per request\n\nThis estimate assumes the worst-case scenario with a document generating the maximum 512 chunks.",
"default": 250,
"type": "number"
}
},
"required": [
"service_account_json"
]
},
"inference._types.GoogleModelGardenProvider": {
"type": "string",
"enum": [
"google",
"anthropic",
"meta",
"hugging_face",
"mistral",
"ai21"
]
},
"inference._types.GoogleVertexAITaskSettings": {
"type": "object",
"properties": {
"auto_truncate": {
"description": "For a `text_embedding` task, truncate inputs longer than the maximum token length automatically.",
"type": "boolean"
},
"top_n": {
"description": "For a `rerank` task, the number of the top N documents that should be returned.",
"type": "number"
},
"thinking_config": {
"externalDocs": {
"url": "https://ai.google.dev/gemini-api/docs/thinking#set-budget"
},
"description": "For a `completion` or `chat_completion` task, allows configuration of the thinking features for the model.\nRefer to the Google documentation for the allowable configurations for each model type.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.ThinkingConfig"
}
]
},
"max_tokens": {
"externalDocs": {
"url": "https://docs.claude.com/en/api/messages#body-max-tokens"
},
"description": "For `completion` and `chat_completion` tasks, specifies the `max_tokens` value for requests sent to the Google Model Garden `anthropic` provider.\nIf `provider` is not set to `anthropic`, this field is ignored.\nIf `max_tokens` is specified - it must be a positive integer. If not specified, the default value of 1024 is used.\nAnthropic models require `max_tokens` to be set for each request. Please refer to the Anthropic documentation for more information.",
"type": "number"
}
}
},
"inference._types.ThinkingConfig": {
"type": "object",
"properties": {
"thinking_budget": {
"description": "Indicates the desired thinking budget in tokens.",
"type": "number"
}
}
},
"inference._types.InferenceEndpointInfoGoogleVertexAI": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeGoogleVertexAI"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeGoogleVertexAI": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"text_embedding",
"rerank"
]
},
"inference._types.GroqTaskType": {
"type": "string",
"enum": [
"chat_completion"
]
},
"inference._types.GroqServiceType": {
"type": "string",
"enum": [
"groq"
]
},
"inference._types.GroqServiceSettings": {
"type": "object",
"properties": {
"model_id": {
"externalDocs": {
"url": "https://console.groq.com/docs/models"
},
"description": "The name of the model to use for the inference task.\nRefer to the Groq model documentation for the list of supported models and versions.\nService has been tested and confirmed to be working for `completion` and `chat_completion` tasks with the following models:\n* `llama-3.3-70b-versatile`",
"type": "string"
},
"api_key": {
"description": "A valid API key for accessing Groq API.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"rate_limit": {
"externalDocs": {
"url": "https://console.groq.com/docs/rate-limits"
},
"description": "This setting helps to minimize the number of rate limit errors returned from the Groq API.\nBy default, the `groq` service sets the number of requests allowed per minute to 1000. Refer to Groq documentation for more details.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"model_id"
]
},
"inference._types.InferenceEndpointInfoGroq": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeGroq"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeGroq": {
"type": "string",
"enum": [
"chat_completion"
]
},
"inference._types.HuggingFaceTaskType": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"rerank",
"text_embedding"
]
},
"inference._types.HuggingFaceServiceType": {
"type": "string",
"enum": [
"hugging_face"
]
},
"inference._types.HuggingFaceServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://huggingface.co/settings/tokens"
},
"description": "A valid access token for your HuggingFace account.\nYou can create or find your access tokens on the HuggingFace settings page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Hugging Face.\nBy default, the `hugging_face` service sets the number of requests allowed per minute to 3000 for all supported tasks.\nHugging Face does not publish a universal rate limit — actual limits may vary.\nIt is recommended to adjust this value based on the capacity and limits of your specific deployment environment.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"url": {
"externalDocs": {
"url": "https://huggingface.co/docs/inference-providers/en/tasks/chat-completion#conversational-large-language-models-llms"
},
"description": "The URL endpoint to use for the requests.\nFor `completion` and `chat_completion` tasks, the deployed model must be compatible with the Hugging Face Chat Completion interface (see the linked external documentation for details). The endpoint URL for the request must include `/v1/chat/completions`.\nIf the model supports the OpenAI Chat Completion schema, a toggle should appear in the interface. Enabling this toggle doesn't change any model behavior, it reveals the full endpoint URL needed (which should include `/v1/chat/completions`) when configuring the inference endpoint in Elasticsearch. If the model doesn't support this schema, the toggle may not be shown.",
"type": "string"
},
"model_id": {
"description": "The name of the HuggingFace model to use for the inference task.\nFor `completion` and `chat_completion` tasks, this field is optional but may be required for certain models — particularly when using serverless inference endpoints.\nFor the `text_embedding` task, this field should not be included. Otherwise, the request will fail.",
"type": "string"
}
},
"required": [
"api_key",
"url"
]
},
"inference._types.HuggingFaceTaskSettings": {
"type": "object",
"properties": {
"return_documents": {
"description": "For a `rerank` task, return doc text within the results.",
"type": "boolean"
},
"top_n": {
"description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.",
"type": "number"
}
}
},
"inference._types.InferenceEndpointInfoHuggingFace": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeHuggingFace"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeHuggingFace": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"rerank",
"text_embedding"
]
},
"inference._types.JinaAITaskType": {
"type": "string",
"enum": [
"embedding",
"rerank",
"text_embedding"
]
},
"inference._types.JinaAIServiceType": {
"type": "string",
"enum": [
"jinaai"
]
},
"inference._types.JinaAIServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://jina.ai/embeddings/"
},
"description": "A valid API key of your JinaAI account.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"model_id": {
"description": "The name of the model to use for the inference task.",
"type": "string"
},
"rate_limit": {
"externalDocs": {
"url": "https://jina.ai/contact-sales/#rate-limit"
},
"description": "This setting helps to minimize the number of rate limit errors returned from JinaAI.\nBy default, the `jinaai` service sets the number of requests allowed per minute to 2000 for all task types.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"similarity": {
"description": "For an `embedding` or `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.\nThe default values varies with the embedding type.\nFor example, a float embedding type uses a `dot_product` similarity measure by default.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.JinaAISimilarityType"
}
]
},
"dimensions": {
"externalDocs": {
"url": "https://jina.ai/embeddings/"
},
"description": "For an `embedding` or `text_embedding` task, the number of dimensions the resulting output embeddings should have.\nBy default, the model's standard output dimension is used.\nRefer to the Jina documentation for more information.",
"type": "number"
},
"embedding_type": {
"description": "For an `embedding` or `text_embedding` task, the data type returned by the model.\nUse `bit` for binary embeddings, which are encoded as bytes with signed int8 precision.\nUse `binary` for binary embeddings, which are encoded as bytes with signed int8 precision (this is a synonym of `bit`).\nUse `float` for the default float embeddings.",
"default": "float",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.JinaAIElementType"
}
]
},
"multimodal_model": {
"description": "For the `embedding` task, whether the model supports multimodal inputs. If true, requests sent to the Jina model\nwill use the multimodal request format (a list of objects). If false, requests sent to the model will use the same\nformat as the `text_embedding` task (a list of strings). Setting this to `false` allows the `embedding` task to be\nused with models that do not support multimodal requests.",
"default": true,
"type": "boolean"
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.JinaAISimilarityType": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm"
]
},
"inference._types.JinaAIElementType": {
"type": "string",
"enum": [
"binary",
"bit",
"float"
]
},
"inference._types.JinaAITaskSettings": {
"type": "object",
"properties": {
"return_documents": {
"description": "For a `rerank` task, return the doc text within the results.",
"type": "boolean"
},
"input_type": {
"description": "For an `embedding` or `text_embedding` task, the task passed to the model.\nValid values are:\n\n* `classification`: Use it for embeddings passed through a classifier.\n* `clustering`: Use it for the embeddings run through a clustering algorithm.\n* `ingest`: Use it for storing document embeddings in a vector database.\n* `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.JinaAITextEmbeddingTask"
}
]
},
"late_chunking": {
"description": "For an `embedding` or `text_embedding` task, controls when text is split into chunks.\nWhen set to `true`, a request from Elasticsearch contains only chunks related to a single document. Instead of batching chunks across documents, Elasticsearch sends them in separate requests. This ensures that chunk embeddings retain context from the entire document, improving semantic quality.\n\nIf a document exceeds the model's context limits, or if the document contains non-text inputs (relevant when using the multimodal `embedding` task), late chunking is automatically disabled for that document only and standard chunking is used instead.\n\nIf not specified, defaults to `false`.",
"type": "boolean"
},
"top_n": {
"description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.\nIf this inference endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query.",
"type": "number"
}
}
},
"inference._types.JinaAITextEmbeddingTask": {
"type": "string",
"enum": [
"classification",
"clustering",
"ingest",
"search"
]
},
"inference._types.InferenceEndpointInfoJinaAi": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeJinaAi"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeJinaAi": {
"type": "string",
"enum": [
"embedding",
"text_embedding",
"rerank"
]
},
"inference._types.LlamaTaskType": {
"type": "string",
"enum": [
"text_embedding",
"completion",
"chat_completion"
]
},
"inference._types.LlamaServiceType": {
"type": "string",
"enum": [
"llama"
]
},
"inference._types.LlamaServiceSettings": {
"type": "object",
"properties": {
"url": {
"description": "The URL endpoint of the Llama stack endpoint.\nURL must contain:\n* For `text_embedding` task - `/v1/inference/embeddings`.\n* For `completion` and `chat_completion` tasks - `/v1/openai/v1/chat/completions`.",
"type": "string"
},
"model_id": {
"externalDocs": {
"url": "https://llama-stack.readthedocs.io/en/latest/references/llama_cli_reference/download_models.html/"
},
"description": "The name of the model to use for the inference task.\nRefer to the Llama downloading models documentation for different ways of getting a list of available models and downloading them.\nService has been tested and confirmed to be working with the following models:\n* For `text_embedding` task - `all-MiniLM-L6-v2`.\n* For `completion` and `chat_completion` tasks - `llama3.2:3b`.",
"type": "string"
},
"max_input_tokens": {
"description": "For a `text_embedding` task, the maximum number of tokens per input before chunking occurs.",
"type": "number"
},
"similarity": {
"description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.LlamaSimilarityType"
}
]
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from the Llama API.\nBy default, the `llama` service sets the number of requests allowed per minute to 3000.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"url",
"model_id"
]
},
"inference._types.LlamaSimilarityType": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm"
]
},
"inference._types.InferenceEndpointInfoLlama": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeLlama"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeLlama": {
"type": "string",
"enum": [
"text_embedding",
"chat_completion",
"completion"
]
},
"inference._types.MistralTaskType": {
"type": "string",
"enum": [
"text_embedding",
"completion",
"chat_completion"
]
},
"inference._types.MistralServiceType": {
"type": "string",
"enum": [
"mistral"
]
},
"inference._types.MistralServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://console.mistral.ai/api-keys/"
},
"description": "A valid API key of your Mistral account.\nYou can find your Mistral API keys or you can create a new one on the API Keys page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"max_input_tokens": {
"description": "The maximum number of tokens per input before chunking occurs.",
"type": "number"
},
"model": {
"externalDocs": {
"url": "https://docs.mistral.ai/getting-started/models/"
},
"description": "The name of the model to use for the inference task.\nRefer to the Mistral models documentation for the list of available models.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from the Mistral API.\nBy default, the `mistral` service sets the number of requests allowed per minute to 240.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"api_key",
"model"
]
},
"inference._types.InferenceEndpointInfoMistral": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeMistral"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeMistral": {
"type": "string",
"enum": [
"text_embedding",
"chat_completion",
"completion"
]
},
"inference._types.NvidiaTaskType": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"rerank",
"text_embedding"
]
},
"inference._types.NvidiaServiceType": {
"type": "string",
"enum": [
"nvidia"
]
},
"inference._types.NvidiaServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"description": "A valid API key for your Nvidia endpoint.\nCan be found in `API Keys` section of Nvidia account settings.",
"type": "string"
},
"url": {
"description": "The URL of the Nvidia model endpoint. If not provided, the default endpoint URL is used depending on the task type:\n\n* For `text_embedding` task - `https://integrate.api.nvidia.com/v1/embeddings`.\n* For `completion` and `chat_completion` tasks - `https://integrate.api.nvidia.com/v1/chat/completions`.\n* For `rerank` task - `https://ai.api.nvidia.com/v1/retrieval/nvidia/reranking`.",
"type": "string"
},
"model_id": {
"description": "The name of the model to use for the inference task.\nRefer to the model's documentation for the name if needed.\nService has been tested and confirmed to be working with the following models:\n\n* For `text_embedding` task - `nvidia/llama-3.2-nv-embedqa-1b-v2`.\n* For `completion` and `chat_completion` tasks - `microsoft/phi-3-mini-128k-instruct`.\n* For `rerank` task - `nv-rerank-qa-mistral-4b:1`.\nService doesn't support `text_embedding` task `baai/bge-m3` and `nvidia/nvclip` models due to them not recognizing the `input_type` parameter.",
"type": "string"
},
"max_input_tokens": {
"description": "For a `text_embedding` task, the maximum number of tokens per input. Inputs exceeding this value are truncated prior to sending to the Nvidia API.",
"type": "number"
},
"similarity": {
"description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.NvidiaSimilarityType"
}
]
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from the Nvidia API.\nBy default, the `nvidia` service sets the number of requests allowed per minute to 3000.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.NvidiaSimilarityType": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm"
]
},
"inference._types.NvidiaTaskSettings": {
"type": "object",
"properties": {
"input_type": {
"description": "For a `text_embedding` task, type of input sent to the Nvidia endpoint.\nValid values are:\n\n* `ingest`: Mapped to Nvidia's `passage` value in request. Used when generating embeddings during indexing.\n* `search`: Mapped to Nvidia's `query` value in request. Used when generating embeddings during querying.\n\nIMPORTANT: For Nvidia endpoints, if the `input_type` field is not specified, it defaults to `query`.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.NvidiaInputType"
}
]
},
"truncate": {
"description": "For a `text_embedding` task, the method used by the Nvidia model to handle inputs longer than the maximum token length.\nValid values are:\n\n* `END`: When the input exceeds the maximum input token length, the end of the input is discarded.\n* `NONE`: When the input exceeds the maximum input token length, an error is returned.\n* `START`: When the input exceeds the maximum input token length, the start of the input is discarded.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.CohereTruncateType"
}
]
}
}
},
"inference._types.NvidiaInputType": {
"type": "string",
"enum": [
"ingest",
"search"
]
},
"inference._types.InferenceEndpointInfoNvidia": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference ID",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeNvidia"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeNvidia": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"rerank",
"text_embedding"
]
},
"inference._types.OpenAITaskType": {
"type": "string",
"enum": [
"chat_completion",
"completion",
"text_embedding",
"embedding"
]
},
"inference._types.OpenAIServiceType": {
"type": "string",
"enum": [
"openai"
]
},
"inference._types.OpenAIServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://platform.openai.com/api-keys"
},
"description": "A valid API key of your OpenAI account.\nYou can find your OpenAI API keys in your OpenAI account under the API keys section.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"dimensions": {
"description": "For a `text_embedding` or `embedding` task, the number of dimensions the resulting output embeddings should have.\nIt is supported only in `text-embedding-3` and later models.\nIf it is not set, the OpenAI defined default for the model is used.",
"type": "number"
},
"model_id": {
"externalDocs": {
"url": "https://platform.openai.com/docs/guides/embeddings/what-are-embeddings"
},
"description": "The name of the model to use for the inference task.\nRefer to the OpenAI documentation for the list of available text embedding models.",
"type": "string"
},
"organization_id": {
"description": "The unique identifier for your organization.\nYou can find the Organization ID in your OpenAI account under *Settings > Organizations*.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from OpenAI.\nThe `openai` service sets a default number of requests allowed per minute depending on the task type.\nFor `text_embedding` and `embedding`, it is set to `3000`.\nFor `completion` and `chat_completion`, it is set to `500`.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"similarity": {
"description": "For a `text_embedding` or `embedding` task, the similarity measure. One of `cosine`, `dot_product`, `l2_norm`. Defaults to `dot_product`.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.OpenAISimilarityType"
}
]
},
"url": {
"description": "The URL endpoint to use for the requests.\nIt can be changed for testing purposes.\nDefault value is `https://api.openai.com/v1/embeddings` for a `text_embedding` or `embedding` task,\n`https://api.openai.com/v1/chat/completions` for a `completion` or `chat_completion` task.",
"type": "string"
}
},
"required": [
"api_key",
"model_id"
]
},
"inference._types.OpenAISimilarityType": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm"
]
},
"inference._types.OpenAITaskSettings": {
"type": "object",
"properties": {
"user": {
"description": "Specifies the user issuing the request.\nThis information can be used for abuse detection.",
"type": "string"
},
"headers": {
"description": "Specifies custom HTTP header parameters.\nFor example:\n```\n\"headers\": {\n \"Custom-Header\": \"Some-Value\",\n \"Another-Custom-Header\": \"Another-Value\"\n}\n```",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"inference._types.InferenceEndpointInfoOpenAI": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeOpenAI"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeOpenAI": {
"type": "string",
"enum": [
"text_embedding",
"chat_completion",
"completion",
"embedding"
]
},
"inference._types.OpenShiftAiTaskType": {
"type": "string",
"enum": [
"text_embedding",
"completion",
"chat_completion",
"rerank"
]
},
"inference._types.OpenShiftAiServiceType": {
"type": "string",
"enum": [
"openshift_ai"
]
},
"inference._types.OpenShiftAiServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"description": "A valid API key for your OpenShift AI endpoint.\nCan be found in `Token authentication` section of model related information.",
"type": "string"
},
"url": {
"description": "The URL of the OpenShift AI hosted model endpoint.",
"type": "string"
},
"model_id": {
"description": "The name of the model to use for the inference task.\nRefer to the hosted model's documentation for the name if needed.\nService has been tested and confirmed to be working with the following models:\n* For `text_embedding` task - `gritlm-7b`.\n* For `completion` and `chat_completion` tasks - `llama-31-8b-instruct`.\n* For `rerank` task - `bge-reranker-v2-m3`.",
"type": "string"
},
"max_input_tokens": {
"description": "For a `text_embedding` task, the maximum number of tokens per input before chunking occurs.",
"type": "number"
},
"similarity": {
"description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.\nIf not specified, the default dot_product value is used.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.OpenShiftAiSimilarityType"
}
]
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from the OpenShift AI API.\nBy default, the `openshift_ai` service sets the number of requests allowed per minute to 3000.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
}
},
"required": [
"api_key",
"url"
]
},
"inference._types.OpenShiftAiSimilarityType": {
"type": "string",
"enum": [
"cosine",
"dot_product",
"l2_norm"
]
},
"inference._types.OpenShiftAiTaskSettings": {
"type": "object",
"properties": {
"return_documents": {
"description": "For a `rerank` task, whether to return the source documents in the response.",
"type": "boolean"
},
"top_n": {
"description": "For a `rerank` task, the number of most relevant documents to return.",
"type": "number"
}
}
},
"inference._types.InferenceEndpointInfoOpenShiftAi": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeOpenShiftAi"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeOpenShiftAi": {
"type": "string",
"enum": [
"text_embedding",
"chat_completion",
"completion",
"rerank"
]
},
"inference._types.VoyageAITaskType": {
"type": "string",
"enum": [
"text_embedding",
"rerank"
]
},
"inference._types.VoyageAIServiceType": {
"type": "string",
"enum": [
"voyageai"
]
},
"inference._types.VoyageAIServiceSettings": {
"type": "object",
"properties": {
"dimensions": {
"externalDocs": {
"url": "https://docs.voyageai.com/docs/embeddings"
},
"description": "The number of dimensions for resulting output embeddings.\nThis setting maps to `output_dimension` in the VoyageAI documentation.\nOnly for the `text_embedding` task type.",
"type": "number"
},
"model_id": {
"externalDocs": {
"url": "https://docs.voyageai.com/docs/reranker"
},
"description": "The name of the model to use for the inference task.\nRefer to the VoyageAI documentation for the list of available text embedding and rerank models.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from VoyageAI.\nThe `voyageai` service sets a default number of requests allowed per minute depending on the task type.\nFor both `text_embedding` and `rerank`, it is set to `2000`.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"embedding_type": {
"externalDocs": {
"url": "https://docs.voyageai.com/docs/embeddings"
},
"description": "The data type for the embeddings to be returned.\nThis setting maps to `output_dtype` in the VoyageAI documentation.\nPermitted values: float, int8, bit.\n`int8` is a synonym of `byte` in the VoyageAI documentation.\n`bit` is a synonym of `binary` in the VoyageAI documentation.\nOnly for the `text_embedding` task type.",
"type": "number"
}
},
"required": [
"model_id"
]
},
"inference._types.VoyageAITaskSettings": {
"type": "object",
"properties": {
"input_type": {
"description": "Type of the input text.\nPermitted values: `ingest` (maps to `document` in the VoyageAI documentation), `search` (maps to `query` in the VoyageAI documentation).\nOnly for the `text_embedding` task type.",
"type": "string"
},
"return_documents": {
"description": "Whether to return the source documents in the response.\nOnly for the `rerank` task type.",
"default": false,
"type": "boolean"
},
"top_k": {
"description": "The number of most relevant documents to return.\nIf not specified, the reranking results of all documents will be returned.\nOnly for the `rerank` task type.",
"type": "number"
},
"truncation": {
"description": "Whether to truncate the input texts to fit within the context length.",
"default": true,
"type": "boolean"
}
}
},
"inference._types.InferenceEndpointInfoVoyageAI": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeVoyageAI"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeVoyageAI": {
"type": "string",
"enum": [
"text_embedding",
"rerank"
]
},
"inference._types.WatsonxTaskType": {
"type": "string",
"enum": [
"text_embedding",
"rerank",
"chat_completion",
"completion"
]
},
"inference._types.WatsonxServiceType": {
"type": "string",
"enum": [
"watsonxai"
]
},
"inference._types.WatsonxServiceSettings": {
"type": "object",
"properties": {
"api_key": {
"externalDocs": {
"url": "https://cloud.ibm.com/iam/apikeys"
},
"description": "A valid API key of your Watsonx account.\nYou can find your Watsonx API keys or you can create a new one on the API keys page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.",
"type": "string"
},
"api_version": {
"externalDocs": {
"url": "https://cloud.ibm.com/apidocs/watsonx-ai#active-version-dates"
},
"description": "A version parameter that takes a version date in the format of `YYYY-MM-DD`.\nFor the active version data parameters, refer to the Wastonx documentation.",
"type": "string"
},
"model_id": {
"externalDocs": {
"url": "https://www.ibm.com/products/watsonx-ai/foundation-models"
},
"description": "The name of the model to use for the inference task.\nRefer to the IBM Embedding Models section in the Watsonx documentation for the list of available text embedding models.\nRefer to the IBM library - Foundation models in Watsonx.ai.",
"type": "string"
},
"project_id": {
"description": "The identifier of the IBM Cloud project to use for the inference task.",
"type": "string"
},
"rate_limit": {
"description": "This setting helps to minimize the number of rate limit errors returned from Watsonx.\nBy default, the `watsonxai` service sets the number of requests allowed per minute to 120.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.RateLimitSetting"
}
]
},
"url": {
"description": "The URL of the inference endpoint that you created on Watsonx.",
"type": "string"
}
},
"required": [
"api_key",
"api_version",
"model_id",
"project_id",
"url"
]
},
"inference._types.InferenceEndpointInfoWatsonx": {
"allOf": [
{
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
{
"type": "object",
"properties": {
"inference_id": {
"description": "The inference Id",
"type": "string"
},
"task_type": {
"description": "The task type",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskTypeWatsonx"
}
]
}
},
"required": [
"inference_id",
"task_type"
]
}
]
},
"inference._types.TaskTypeWatsonx": {
"type": "string",
"enum": [
"text_embedding",
"chat_completion",
"completion"
]
},
"inference._types.RerankedInferenceResult": {
"description": "Defines the response for a rerank request.",
"type": "object",
"properties": {
"rerank": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.RankedDocument"
}
}
},
"required": [
"rerank"
]
},
"inference._types.SparseEmbeddingInferenceResult": {
"description": "The response format for the sparse embedding request.",
"type": "object",
"properties": {
"sparse_embedding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.SparseEmbeddingResult"
}
}
},
"required": [
"sparse_embedding"
]
},
"inference._types.TextEmbeddingInferenceResult": {
"description": "TextEmbeddingInferenceResult is an aggregation of mutually exclusive text_embedding variants",
"type": "object",
"properties": {
"text_embedding_bytes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingByteResult"
}
},
"text_embedding_bits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingByteResult"
}
},
"text_embedding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.DenseEmbeddingResult"
}
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.ElasticsearchVersionInfo": {
"type": "object",
"properties": {
"build_date": {
"description": "The Elasticsearch Git commit's date.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"build_flavor": {
"description": "The build flavor. For example, `default`.",
"type": "string"
},
"build_hash": {
"description": "The Elasticsearch Git commit's SHA hash.",
"type": "string"
},
"build_snapshot": {
"description": "Indicates whether the Elasticsearch build was a snapshot.",
"type": "boolean"
},
"build_type": {
"description": "The build type that corresponds to how Elasticsearch was installed.\nFor example, `docker`, `rpm`, or `tar`.",
"type": "string"
},
"lucene_version": {
"description": "The version number of Elasticsearch's underlying Lucene software.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"minimum_index_compatibility_version": {
"description": "The minimum index version with which the responding node can read from disk.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"minimum_wire_compatibility_version": {
"description": "The minimum node version with which the responding node can communicate.\nAlso the minimum version from which you can perform a rolling upgrade.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"number": {
"description": "The Elasticsearch version number.\n\n::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.\n Serverless environments are versionless and automatically upgraded, so this value can be safely ignored.",
"type": "string"
}
},
"required": [
"build_date",
"build_flavor",
"build_hash",
"build_snapshot",
"build_type",
"lucene_version",
"minimum_index_compatibility_version",
"minimum_wire_compatibility_version",
"number"
]
},
"ingest.geo_ip_stats.GeoIpDownloadStatistics": {
"type": "object",
"properties": {
"successful_downloads": {
"description": "Total number of successful database downloads.",
"type": "number"
},
"failed_downloads": {
"description": "Total number of failed database downloads.",
"type": "number"
},
"total_download_time": {
"description": "Total milliseconds spent downloading databases.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"databases_count": {
"description": "Current number of databases available for use.",
"type": "number"
},
"skipped_updates": {
"description": "Total number of database updates skipped.",
"type": "number"
},
"expired_databases": {
"description": "Total number of databases not updated after 30 days",
"type": "number"
}
},
"required": [
"successful_downloads",
"failed_downloads",
"total_download_time",
"databases_count",
"skipped_updates",
"expired_databases"
]
},
"ingest.geo_ip_stats.GeoIpNodeDatabases": {
"description": "Downloaded databases for the node. The field key is the node ID.",
"type": "object",
"properties": {
"databases": {
"description": "Downloaded databases for the node.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest.geo_ip_stats.GeoIpNodeDatabaseName"
}
},
"files_in_temp": {
"description": "Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"databases",
"files_in_temp"
]
},
"ingest.geo_ip_stats.GeoIpNodeDatabaseName": {
"type": "object",
"properties": {
"name": {
"description": "Name of the database.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"name"
]
},
"ingest.get_geoip_database.DatabaseConfigurationMetadata": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"version": {
"type": "number"
},
"modified_date_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"database": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DatabaseConfiguration"
}
]
}
},
"required": [
"id",
"version",
"modified_date_millis",
"database"
]
},
"ingest._types.DatabaseConfiguration": {
"description": "The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported providers are `maxmind` and `ipinfo`, and the `maxmind` provider requires that an `account_id` (string) is configured.\nA provider (either `maxmind` or `ipinfo`) must be specified. The web and local providers can be returned as read only configurations.",
"allOf": [
{
"type": "object",
"properties": {
"name": {
"description": "The provider-assigned name of the IP geolocation database to download.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"name"
]
},
{
"type": "object",
"properties": {
"maxmind": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Maxmind"
}
]
},
"ipinfo": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Ipinfo"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"ingest._types.Maxmind": {
"type": "object",
"properties": {
"account_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
},
"required": [
"account_id"
]
},
"ingest._types.Ipinfo": {
"type": "object"
},
"ingest.get_ip_location_database.DatabaseConfigurationMetadata": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"modified_date_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"modified_date": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"database": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DatabaseConfigurationFull"
}
]
}
},
"required": [
"id",
"version",
"database"
]
},
"ingest._types.DatabaseConfigurationFull": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"description": "The provider-assigned name of the IP geolocation database to download.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"name"
]
},
{
"type": "object",
"properties": {
"web": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Web"
}
]
},
"local": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Local"
}
]
},
"maxmind": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Maxmind"
}
]
},
"ipinfo": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Ipinfo"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"ingest._types.Web": {
"type": "object"
},
"ingest._types.Local": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"ingest._types.Pipeline": {
"type": "object",
"properties": {
"description": {
"description": "Description of the ingest pipeline.",
"type": "string"
},
"on_failure": {
"description": "Processors to run immediately after a processor failure.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.ProcessorContainer"
}
},
"processors": {
"description": "Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.ProcessorContainer"
}
},
"version": {
"description": "Version number used by external systems to track ingest pipelines.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"deprecated": {
"description": "Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.",
"default": false,
"type": "boolean"
},
"_meta": {
"description": "Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"created_date": {
"description": "Date and time when the pipeline was created. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"created_date_millis": {
"description": "Date and time when the pipeline was created, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"modified_date": {
"description": "Date and time when the pipeline was last modified. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"modified_date_millis": {
"description": "Date and time when the pipeline was last modified, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"field_access_pattern": {
"description": "Controls how processors in this pipeline should read and write data on a document's source.",
"default": "classic",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.FieldAccessPattern"
}
]
}
}
},
"ingest._types.ProcessorContainer": {
"type": "object",
"properties": {
"append": {
"description": "Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.AppendProcessor"
}
]
},
"attachment": {
"description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.AttachmentProcessor"
}
]
},
"bytes": {
"description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.BytesProcessor"
}
]
},
"cef": {
"description": "Converts a CEF message into a structured format.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.CefProcessor"
}
]
},
"circle": {
"description": "Converts circle definitions of shapes to regular polygons which approximate them.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.CircleProcessor"
}
]
},
"community_id": {
"description": "Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.CommunityIDProcessor"
}
]
},
"convert": {
"description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ConvertProcessor"
}
]
},
"csv": {
"description": "Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.CsvProcessor"
}
]
},
"date": {
"description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DateProcessor"
}
]
},
"date_index_name": {
"description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DateIndexNameProcessor"
}
]
},
"dissect": {
"description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DissectProcessor"
}
]
},
"dot_expander": {
"description": "Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DotExpanderProcessor"
}
]
},
"drop": {
"description": "Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DropProcessor"
}
]
},
"enrich": {
"description": "The `enrich` processor can enrich documents with data from another index.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.EnrichProcessor"
}
]
},
"fail": {
"description": "Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.FailProcessor"
}
]
},
"fingerprint": {
"description": "Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.FingerprintProcessor"
}
]
},
"foreach": {
"description": "Runs an ingest processor on each element of an array or object.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ForeachProcessor"
}
]
},
"ip_location": {
"description": "Currently an undocumented alias for GeoIP Processor.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.IpLocationProcessor"
}
]
},
"geo_grid": {
"description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.GeoGridProcessor"
}
]
},
"geoip": {
"description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.GeoIpProcessor"
}
]
},
"grok": {
"description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.GrokProcessor"
}
]
},
"gsub": {
"description": "Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.GsubProcessor"
}
]
},
"html_strip": {
"description": "Removes HTML tags from the field.\nIf the field is an array of strings, HTML tags will be removed from all members of the array.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.HtmlStripProcessor"
}
]
},
"inference": {
"description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.InferenceProcessor"
}
]
},
"join": {
"description": "Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.JoinProcessor"
}
]
},
"json": {
"description": "Parses a string containing JSON data into a structured object, string, or other value.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.JsonProcessor"
}
]
},
"kv": {
"description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.KeyValueProcessor"
}
]
},
"lowercase": {
"description": "Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.LowercaseProcessor"
}
]
},
"network_direction": {
"description": "Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.NetworkDirectionProcessor"
}
]
},
"pipeline": {
"description": "Executes another pipeline.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.PipelineProcessor"
}
]
},
"redact": {
"description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.RedactProcessor"
}
]
},
"registered_domain": {
"description": "Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.RegisteredDomainProcessor"
}
]
},
"remove": {
"description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.RemoveProcessor"
}
]
},
"rename": {
"description": "Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.RenameProcessor"
}
]
},
"reroute": {
"description": "Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.RerouteProcessor"
}
]
},
"script": {
"description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ScriptProcessor"
}
]
},
"set": {
"description": "Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.SetProcessor"
}
]
},
"set_security_user": {
"description": "Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.SetSecurityUserProcessor"
}
]
},
"sort": {
"description": "Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.SortProcessor"
}
]
},
"split": {
"description": "Splits a field into an array using a separator character.\nOnly works on string fields.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.SplitProcessor"
}
]
},
"terminate": {
"description": "Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.TerminateProcessor"
}
]
},
"trim": {
"description": "Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.TrimProcessor"
}
]
},
"uppercase": {
"description": "Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.UppercaseProcessor"
}
]
},
"urldecode": {
"description": "URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.UrlDecodeProcessor"
}
]
},
"uri_parts": {
"description": "Parses a Uniform Resource Identifier (URI) string and extracts its components as an object.\nThis URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.UriPartsProcessor"
}
]
},
"user_agent": {
"description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.UserAgentProcessor"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ingest._types.AppendProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to be appended to.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"value": {
"description": "The value to be appended. Supports template snippets. May specify only one of `value` or `copy_from`.",
"oneOf": [
{
"type": "object"
},
{
"type": "array",
"items": {
"type": "object"
}
}
]
},
"media_type": {
"description": "The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`.",
"default": "\"application/json\"",
"type": "string"
},
"copy_from": {
"description": "The origin field which will be appended to `field`, cannot set `value` simultaneously.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"allow_duplicates": {
"description": "If `false`, the processor does not append values already present in the field.",
"default": true,
"type": "boolean"
},
"ignore_empty_values": {
"description": "If `true`, the processor will skip empty values from the source (e.g. empty strings, and null values),\nrather than appending them to the field.",
"default": false,
"type": "boolean"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.ProcessorBase": {
"type": "object",
"properties": {
"description": {
"description": "Description of the processor.\nUseful for describing the purpose of the processor or its configuration.",
"type": "string"
},
"if": {
"description": "Conditionally execute the processor.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
},
"ignore_failure": {
"description": "Ignore failures for the processor.",
"type": "boolean"
},
"on_failure": {
"description": "Handle failures for the processor.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.ProcessorContainer"
}
},
"tag": {
"description": "Identifier for the processor.\nUseful for debugging and metrics.",
"type": "string"
}
}
},
"ingest._types.AttachmentProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to get the base64 encoded field from.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and field does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"indexed_chars": {
"description": "The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit.",
"default": 100000,
"type": "number"
},
"indexed_chars_field": {
"description": "Field name from which you can overwrite the number of chars being used for extraction.",
"default": "null",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"max_field_bytes": {
"description": "Maximum allowed size of the attachment `field` value in bytes: length of a string (if base64 in JSON,\nchecked before base64 decoding) or byte array length for binary (for example, CBOR).\nIf set to `-1`, there is no per-processor limit.\nThe node setting `ingest.attachment.max_field_size` also applies.",
"default": "-1",
"x-state": "Generally available; Added in 9.5.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"properties": {
"description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.",
"type": "array",
"items": {
"type": "string"
}
},
"target_field": {
"description": "The field that will hold the attachment information.",
"default": "attachment",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"remove_binary": {
"description": "If true, the binary field will be removed from the document",
"default": false,
"type": "boolean"
},
"resource_name": {
"description": "Field containing the name of the resource to decode.\nIf specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.",
"type": "string"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.BytesProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to convert.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to assign the converted value to.\nBy default, the field is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.CefProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field containing the CEF message.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to assign the converted value to.\nBy default, the `target_field` is 'cef'",
"default": "'cef'",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_empty_values": {
"description": "If `true` and value is anempty string in extensions, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"timezone": {
"description": "The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.",
"default": "UTC",
"type": "string"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.CircleProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"error_distance": {
"description": "The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`).",
"type": "number"
},
"field": {
"description": "The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"shape_type": {
"description": "Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ShapeType"
}
]
},
"target_field": {
"description": "The field to assign the polygon shape to\nBy default, the field is updated in-place.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"error_distance",
"field",
"shape_type"
]
}
]
},
"ingest._types.ShapeType": {
"type": "string",
"enum": [
"geo_shape",
"shape"
]
},
"ingest._types.CommunityIDProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"source_ip": {
"description": "Field containing the source IP address.",
"default": "source.ip",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"source_port": {
"description": "Field containing the source port.",
"default": "source.port",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"destination_ip": {
"description": "Field containing the destination IP address.",
"default": "destination.ip",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"destination_port": {
"description": "Field containing the destination port.",
"default": "destination.port",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"iana_number": {
"description": "Field containing the IANA number.",
"default": "network.iana_number",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"icmp_type": {
"description": "Field containing the ICMP type.",
"default": "icmp.type",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"icmp_code": {
"description": "Field containing the ICMP code.",
"default": "icmp.code",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"transport": {
"description": "Field containing the transport protocol name or number. Used only when the\niana_number field is not present. The following protocol names are currently\nsupported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp",
"default": "network.transport",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"target_field": {
"description": "Output field for the community ID.",
"default": "network.community_id",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"seed": {
"description": "Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme.",
"default": 0,
"type": "number"
},
"ignore_missing": {
"description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.",
"default": true,
"type": "boolean"
}
}
}
]
},
"ingest._types.ConvertProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field whose value is to be converted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to assign the converted value to.\nBy default, the `field` is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"type": {
"description": "The type to convert the existing value to.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ConvertType"
}
]
}
},
"required": [
"field",
"type"
]
}
]
},
"ingest._types.ConvertType": {
"type": "string",
"enum": [
"integer",
"long",
"double",
"float",
"boolean",
"ip",
"string",
"auto"
]
},
"ingest._types.CsvProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"empty_value": {
"description": "Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).",
"type": "object"
},
"field": {
"description": "The field to extract data from.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"type": "boolean"
},
"quote": {
"description": "Quote used in CSV, has to be single character string.",
"default": "\"",
"type": "string"
},
"separator": {
"description": "Separator used in CSV, has to be single character string.",
"default": ",",
"type": "string"
},
"target_fields": {
"description": "The array of fields to assign extracted values to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"trim": {
"description": "Trim whitespaces in unquoted fields.",
"type": "boolean"
}
},
"required": [
"field",
"target_fields"
]
}
]
},
"ingest._types.DateProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to get the date from.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"formats": {
"description": "An array of the expected date formats.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.",
"type": "array",
"items": {
"type": "string"
}
},
"locale": {
"description": "The locale to use when parsing the date, relevant when parsing month names or week days.\nSupports template snippets.",
"default": "ENGLISH",
"type": "string"
},
"target_field": {
"description": "The field that will hold the parsed date.",
"default": "@timestamp",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"timezone": {
"description": "The timezone to use when parsing the date.\nSupports template snippets.",
"default": "UTC",
"type": "string"
},
"output_format": {
"description": "The format to use when writing the date to target_field. Must be a valid\njava time pattern.",
"default": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"type": "string"
}
},
"required": [
"field",
"formats"
]
}
]
},
"ingest._types.DateIndexNameProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"date_formats": {
"description": "An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.",
"type": "array",
"items": {
"type": "string"
}
},
"date_rounding": {
"description": "How to round the date when formatting the date into the index name. Valid values are:\n`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).\nSupports template snippets.",
"type": "string"
},
"field": {
"description": "The field to get the date or timestamp from.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"index_name_format": {
"description": "The format to be used when printing the parsed date into the index name.\nA valid java time pattern is expected here.\nSupports template snippets.",
"default": "yyyy-MM-dd",
"type": "string"
},
"index_name_prefix": {
"description": "A prefix of the index name to be prepended before the printed date.\nSupports template snippets.",
"type": "string"
},
"locale": {
"description": "The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.",
"default": "ENGLISH",
"type": "string"
},
"timezone": {
"description": "The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.",
"default": "UTC",
"type": "string"
}
},
"required": [
"date_rounding",
"field"
]
}
]
},
"ingest._types.DissectProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"append_separator": {
"description": "The character(s) that separate the appended fields.",
"default": "\"\"",
"type": "string"
},
"field": {
"description": "The field to dissect.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"pattern": {
"description": "The pattern to apply to the field.",
"type": "string"
}
},
"required": [
"field",
"pattern"
]
}
]
},
"ingest._types.DotExpanderProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to expand into an object field.\nIf set to `*`, all top-level fields will be expanded.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"override": {
"description": "Controls the behavior when there is already an existing nested object that conflicts with the expanded field.\nWhen `false`, the processor will merge conflicts by combining the old and the new values into an array.\nWhen `true`, the value from the expanded field will overwrite the existing value.",
"default": false,
"type": "boolean"
},
"path": {
"description": "The field that contains the field to expand.\nOnly required if the field to expand is part another object field, because the `field` option can only understand leaf fields.",
"type": "string"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.DropProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object"
}
]
},
"ingest._types.EnrichProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field in the input document that matches the policies match_field used to retrieve the enrichment data.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"max_matches": {
"description": "The maximum number of matched documents to include under the configured target field.\nThe `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.\nIn order to avoid documents getting too large, the maximum allowed value is 128.",
"default": 1,
"type": "number"
},
"override": {
"description": "If processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched.",
"default": true,
"type": "boolean"
},
"policy_name": {
"description": "The name of the enrich policy to use.",
"type": "string"
},
"shape_relation": {
"description": "A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.\nThis option is only used for `geo_match` enrich policy types.\n\nSupported values include:\n - `intersects`: Return all documents whose `geo_shape` or `geo_point` field intersects the query geometry.\n - `disjoint`: Return all documents whose `geo_shape` or `geo_point` field has nothing in common with the query geometry.\n - `within`: Return all documents whose `geo_shape` or `geo_point` field is within the query geometry.\nLine geometries are not supported.\n - `contains`: Return all documents whose `geo_shape` or `geo_point` field contains the query geometry.\n\n",
"default": "INTERSECTS",
"allOf": [
{
"$ref": "#/components/schemas/_types.GeoShapeRelation"
}
]
},
"target_field": {
"description": "Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field",
"policy_name",
"target_field"
]
}
]
},
"_types.GeoShapeRelation": {
"type": "string",
"enum": [
"intersects",
"disjoint",
"within",
"contains"
]
},
"ingest._types.FailProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"message": {
"description": "The error message thrown by the processor.\nSupports template snippets.",
"type": "string"
}
},
"required": [
"message"
]
}
]
},
"ingest._types.FingerprintProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"fields": {
"description": "Array of fields to include in the fingerprint. For objects, the processor\nhashes both the field key and value. For other fields, the processor hashes\nonly the field value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"target_field": {
"description": "Output field for the fingerprint.",
"default": "fingerprint",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"salt": {
"description": "Salt value for the hash function.",
"type": "string"
},
"method": {
"description": "The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,\nSHA-256, SHA-512, or MurmurHash3.",
"default": "SHA-1",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.FingerprintDigest"
}
]
},
"ignore_missing": {
"description": "If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document.",
"default": false,
"type": "boolean"
}
},
"required": [
"fields"
]
}
]
},
"ingest._types.FingerprintDigest": {
"type": "string",
"enum": [
"MD5",
"SHA-1",
"SHA-256",
"SHA-512",
"MurmurHash3"
]
},
"ingest._types.ForeachProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "Field containing array or object values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true`, the processor silently exits without changing the document if the `field` is `null` or missing.",
"default": false,
"type": "boolean"
},
"processor": {
"description": "Ingest processor to run on each element.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorContainer"
}
]
}
},
"required": [
"field",
"processor"
]
}
]
},
"ingest._types.IpLocationProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"database_file": {
"description": "The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.",
"default": "GeoLite2-City.mmdb",
"type": "string"
},
"field": {
"description": "The field to get the ip address from for the geographical lookup.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"first_only": {
"description": "If `true`, only the first found IP location data will be returned, even if the field contains an array.",
"default": true,
"type": "boolean"
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"properties": {
"description": "Controls what properties are added to the `target_field` based on the IP location lookup.",
"type": "array",
"items": {
"type": "string"
}
},
"target_field": {
"description": "The field that will hold the geographical information looked up from the MaxMind database.",
"default": "geoip",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"download_database_on_pipeline_creation": {
"description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.",
"type": "boolean"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.GeoGridProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to interpret as a geo-tile.=\nThe field format is determined by the `tile_type`.",
"type": "string"
},
"tile_type": {
"description": "Three tile formats are understood: geohash, geotile and geohex.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.GeoGridTileType"
}
]
},
"target_field": {
"description": "The field to assign the polygon shape to, by default, the `field` is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"parent_field": {
"description": "If specified and a parent tile exists, save that tile address to this field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"children_field": {
"description": "If specified and children tiles exist, save those tile addresses to this field as an array of strings.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"non_children_field": {
"description": "If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"precision_field": {
"description": "If specified, save the tile precision (zoom) as an integer to this field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_format": {
"description": "Which format to save the generated polygon in.",
"default": "geojson",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.GeoGridTargetFormat"
}
]
}
},
"required": [
"field",
"tile_type"
]
}
]
},
"ingest._types.GeoGridTileType": {
"type": "string",
"enum": [
"geotile",
"geohex",
"geohash"
]
},
"ingest._types.GeoGridTargetFormat": {
"type": "string",
"enum": [
"geojson",
"wkt"
]
},
"ingest._types.GeoIpProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"database_file": {
"description": "The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.",
"default": "GeoLite2-City.mmdb",
"type": "string"
},
"field": {
"description": "The field to get the ip address from for the geographical lookup.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"first_only": {
"description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.",
"default": true,
"type": "boolean"
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"properties": {
"description": "Controls what properties are added to the `target_field` based on the geoip lookup.",
"type": "array",
"items": {
"type": "string"
}
},
"target_field": {
"description": "The field that will hold the geographical information looked up from the MaxMind database.",
"default": "geoip",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"download_database_on_pipeline_creation": {
"description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.",
"type": "boolean"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.GrokProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"ecs_compatibility": {
"description": "Must be disabled or v1. If v1, the processor uses patterns with Elastic\nCommon Schema (ECS) field names.",
"default": "disabled",
"type": "string"
},
"field": {
"description": "The field to use for grok expression parsing.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"pattern_definitions": {
"description": "A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.\nPatterns matching existing names will override the pre-existing definition.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"patterns": {
"description": "An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.GrokPattern"
}
},
"trace_match": {
"description": "When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched.",
"default": false,
"type": "boolean"
},
"validate_only": {
"description": "When `true`, the processor does matching but does not extract structured fields",
"default": false,
"x-state": "Generally available; Added in 9.4.0",
"type": "boolean"
}
},
"required": [
"field",
"patterns"
]
}
]
},
"_types.GrokPattern": {
"type": "string"
},
"ingest._types.GsubProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to apply the replacement to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"pattern": {
"description": "The pattern to be replaced.",
"type": "string"
},
"replacement": {
"description": "The string to replace the matching patterns with.",
"type": "string"
},
"target_field": {
"description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field",
"pattern",
"replacement"
]
}
]
},
"ingest._types.HtmlStripProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The string-valued field to remove HTML tags from.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document,",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.InferenceProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"model_id": {
"description": "The ID or alias for the trained model, or the ID of the deployment.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"target_field": {
"description": "Field added to incoming documents to contain results objects.",
"default": "ml.inference.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"field_map": {
"description": "Maps the document field names to the known field names of the model.\nThis mapping takes precedence over any default mappings provided in the model configuration.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"inference_config": {
"description": "Contains the inference type and its options.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.InferenceConfig"
}
]
},
"input_output": {
"description": "Input fields for inference and output (destination) fields for the inference results.\nThis option is incompatible with the target_field and field_map options.",
"oneOf": [
{
"$ref": "#/components/schemas/ingest._types.InputConfig"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.InputConfig"
}
}
]
},
"ignore_missing": {
"description": "If true and any of the input fields defined in input_ouput are missing\nthen those missing fields are quietly ignored, otherwise a missing field causes a failure.\nOnly applies when using input_output configurations to explicitly list the input fields.",
"type": "boolean"
}
},
"required": [
"model_id"
]
}
]
},
"ingest._types.InferenceConfig": {
"type": "object",
"properties": {
"regression": {
"description": "Regression configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.InferenceConfigRegression"
}
]
},
"classification": {
"description": "Classification configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.InferenceConfigClassification"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ingest._types.InferenceConfigRegression": {
"type": "object",
"properties": {
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction.",
"default": "_prediction",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"num_top_feature_importance_values": {
"description": "Specifies the maximum number of feature importance values per document.",
"default": 0,
"type": "number"
}
}
},
"ingest._types.InferenceConfigClassification": {
"type": "object",
"properties": {
"num_top_classes": {
"description": "Specifies the number of top class predictions to return.",
"default": 0,
"type": "number"
},
"num_top_feature_importance_values": {
"description": "Specifies the maximum number of feature importance values per document.",
"default": 0,
"type": "number"
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction.",
"default": "_prediction",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"top_classes_results_field": {
"description": "Specifies the field to which the top classes are written.",
"default": "top_classes",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"prediction_field_type": {
"description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.",
"type": "string"
}
}
},
"ingest._types.InputConfig": {
"type": "object",
"properties": {
"input_field": {
"type": "string"
},
"output_field": {
"type": "string"
}
},
"required": [
"input_field",
"output_field"
]
},
"ingest._types.JoinProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "Field containing array values to join.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"separator": {
"description": "The separator character.",
"type": "string"
},
"target_field": {
"description": "The field to assign the joined value to.\nBy default, the field is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field",
"separator"
]
}
]
},
"ingest._types.JsonProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"add_to_root": {
"description": "Flag that forces the parsed JSON to be added at the top level of the document.\n`target_field` must not be set when this option is chosen.",
"default": false,
"type": "boolean"
},
"add_to_root_conflict_strategy": {
"description": "When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.\nWhen set to `merge`, conflicting fields will be merged.\nOnly applicable `if add_to_root` is set to true.\n\nSupported values include:\n - `replace`: Root fields that conflict with fields from the parsed JSON will be overridden.\n - `merge`: Conflicting fields will be merged.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.JsonProcessorConflictStrategy"
}
]
},
"allow_duplicate_keys": {
"description": "When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.\nInstead, the last encountered value for any duplicate key wins.",
"default": false,
"type": "boolean"
},
"field": {
"description": "The field to be parsed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"target_field": {
"description": "The field that the converted structured object will be written into.\nAny existing content in this field will be overwritten.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.JsonProcessorConflictStrategy": {
"type": "string",
"enum": [
"replace",
"merge"
]
},
"ingest._types.KeyValueProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"exclude_keys": {
"description": "List of keys to exclude from document.",
"type": "array",
"items": {
"type": "string"
}
},
"field": {
"description": "The field to be parsed.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"field_split": {
"description": "Regex pattern to use for splitting key-value pairs.",
"type": "string"
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"include_keys": {
"description": "List of keys to filter and insert into document.\nDefaults to including all keys.",
"type": "array",
"items": {
"type": "string"
}
},
"prefix": {
"description": "Prefix to be added to extracted keys.",
"default": "null",
"type": "string"
},
"strip_brackets": {
"description": "If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to insert the extracted keys into.\nDefaults to the root of the document.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"trim_key": {
"description": "String of characters to trim from extracted keys.",
"type": "string"
},
"trim_value": {
"description": "String of characters to trim from extracted values.",
"type": "string"
},
"value_split": {
"description": "Regex pattern to use for splitting the key from the value within a key-value pair.",
"type": "string"
}
},
"required": [
"field",
"field_split",
"value_split"
]
}
]
},
"ingest._types.LowercaseProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to make lowercase.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to assign the converted value to.\nBy default, the field is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.NetworkDirectionProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"source_ip": {
"description": "Field containing the source IP address.",
"default": "source.ip",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"destination_ip": {
"description": "Field containing the destination IP address.",
"default": "destination.ip",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"target_field": {
"description": "Output field for the network direction.",
"default": "network.direction",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"internal_networks": {
"description": "List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field.",
"type": "array",
"items": {
"type": "string"
}
},
"internal_networks_field": {
"description": "A field on the given document to read the internal_networks configuration\nfrom.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.",
"default": true,
"type": "boolean"
}
}
}
]
},
"ingest._types.PipelineProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"name": {
"description": "The name of the pipeline to execute.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"ignore_missing_pipeline": {
"description": "Whether to ignore missing pipelines instead of failing.",
"default": false,
"type": "boolean"
}
},
"required": [
"name"
]
}
]
},
"ingest._types.RedactProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to be redacted",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"patterns": {
"description": "A list of grok expressions to match and redact named captures with",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.GrokPattern"
}
},
"pattern_definitions": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"prefix": {
"description": "Start a redacted section with this token",
"default": "<",
"type": "string"
},
"suffix": {
"description": "End a redacted section with this token",
"default": ">",
"type": "string"
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"skip_if_unlicensed": {
"description": "If `true` and the current license does not support running redact processors, then the processor quietly exits without modifying the document",
"default": false,
"type": "boolean"
},
"trace_redact": {
"description": "If `true` then ingest metadata `_ingest._redact._is_redacted` is set to `true` if the document has been redacted",
"default": false,
"x-state": "Generally available; Added in 8.16.0",
"type": "boolean"
}
},
"required": [
"field",
"patterns"
]
}
]
},
"ingest._types.RegisteredDomainProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "Field containing the source FQDN.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"target_field": {
"description": "Object field containing extracted domain components. If an empty string,\nthe processor adds components to the document’s root.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.",
"default": true,
"type": "boolean"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.RemoveProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "Fields to be removed. Supports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"keep": {
"description": "Fields to be kept. When set, all fields other than those specified are removed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.RenameProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to be renamed.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The new name of the field.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field",
"target_field"
]
}
]
},
"ingest._types.RerouteProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"destination": {
"description": "A static value for the target. Can’t be set when the dataset or namespace option is set.",
"type": "string"
},
"dataset": {
"description": "Field references or a static value for the dataset part of the data stream name.\nIn addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.\nExample values are nginx.access and nginx.error.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.dataset}}",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"namespace": {
"description": "Field references or a static value for the namespace part of the data stream name. See the criteria for\nindex names for allowed characters. Must be no longer than 100 characters.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.namespace}}",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
}
]
},
"ingest._types.ScriptProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"id": {
"description": "ID of a stored script.\nIf no `source` is specified, this parameter is required.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"lang": {
"description": "Script language.\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
"default": "painless",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptLanguage"
}
]
},
"params": {
"description": "Object containing parameters for the script.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"source": {
"description": "Inline script.\nIf no `id` is specified, this parameter is required.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSource"
}
]
}
}
}
]
},
"ingest._types.SetProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"copy_from": {
"description": "The origin field which will be copied to `field`, cannot set `value` simultaneously.\nSupported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"field": {
"description": "The field to insert, upsert, or update.\nSupports template snippets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_empty_value": {
"description": "If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"media_type": {
"description": "The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`.",
"default": "\"application/json\"",
"type": "string"
},
"override": {
"description": "If `true` processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched.",
"default": true,
"type": "boolean"
},
"value": {
"description": "The value to be set for the field.\nSupports template snippets.\nMay specify only one of `value` or `copy_from`.",
"type": "object"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.SetSecurityUserProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to store the user information into.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"properties": {
"description": "Controls what user related properties are added to the field.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"field"
]
}
]
},
"ingest._types.SortProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to be sorted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"order": {
"description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
"default": "asc",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortOrder"
}
]
},
"target_field": {
"description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.SplitProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to split.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"preserve_trailing": {
"description": "Preserves empty trailing fields, if any.",
"default": false,
"type": "boolean"
},
"separator": {
"description": "A regex which matches the separator, for example, `,` or `\\s+`.",
"type": "string"
},
"target_field": {
"description": "The field to assign the split value to.\nBy default, the field is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field",
"separator"
]
}
]
},
"ingest._types.TerminateProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object"
}
]
},
"ingest._types.TrimProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The string-valued field to trim whitespace from.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.UppercaseProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to make uppercase.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to assign the converted value to.\nBy default, the field is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.UrlDecodeProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field to decode.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "The field to assign the converted value to.\nBy default, the field is updated in-place.",
"default": "field",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.UriPartsProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "Field containing the URI string.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"keep_original": {
"description": "If `true`, the processor copies the unparsed URI to `.original`.",
"default": true,
"type": "boolean"
},
"remove_if_successful": {
"description": "If `true`, the processor removes the `field` after parsing the URI string.\nIf parsing fails, the processor does not remove the `field`.",
"default": false,
"type": "boolean"
},
"target_field": {
"description": "Output field for the URI object.",
"default": "url",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
}
]
},
"ingest._types.UserAgentProcessor": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.ProcessorBase"
},
{
"type": "object",
"properties": {
"field": {
"description": "The field containing the user agent string.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"ignore_missing": {
"description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
"default": false,
"type": "boolean"
},
"regex_file": {
"description": "The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with.",
"type": "string"
},
"target_field": {
"description": "The field that will be filled with the user agent details.",
"default": "user_agent",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"properties": {
"description": "Controls what properties are added to `target_field`.",
"default": [
"name",
"os",
"device",
"original",
"version"
],
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.UserAgentProperty"
}
},
"extract_device_type": {
"description": "Extracts device type from the user agent string on a best-effort basis.",
"default": false,
"x-state": "Beta; Added in 8.9.0",
"type": "boolean"
}
},
"required": [
"field"
]
}
]
},
"ingest._types.UserAgentProperty": {
"type": "string",
"enum": [
"name",
"os",
"device",
"original",
"version"
]
},
"ingest._types.FieldAccessPattern": {
"type": "string",
"enum": [
"classic",
"flexible"
]
},
"ingest._types.Document": {
"type": "object",
"properties": {
"_id": {
"description": "Unique identifier for the document.\nThis ID must be unique within the `_index`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "Name of the index containing the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_source": {
"description": "JSON body for the document.",
"type": "object"
}
},
"required": [
"_source"
]
},
"ingest._types.SimulateDocumentResult": {
"type": "object",
"properties": {
"doc": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DocumentSimulation"
}
]
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"processor_results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.PipelineProcessorResult"
}
}
}
},
"ingest._types.DocumentSimulation": {
"description": "The simulated document, with optional metadata.",
"type": "object",
"properties": {
"_id": {
"description": "Unique identifier for the document. This ID must be unique within the `_index`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "Name of the index containing the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_ingest": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Ingest"
}
]
},
"_routing": {
"description": "Value used to send the document to a specific primary shard.",
"type": "string"
},
"_source": {
"description": "JSON body for the document.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"_version": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber"
}
]
},
"_version_type": {
"description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionType"
}
]
}
},
"required": [
"_id",
"_index",
"_ingest",
"_source"
]
},
"ingest._types.Ingest": {
"type": "object",
"properties": {
"_redact": {
"x-state": "Generally available; Added in 8.16.0",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Redact"
}
]
},
"timestamp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"pipeline": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"timestamp"
]
},
"ingest._types.Redact": {
"type": "object",
"properties": {
"_is_redacted": {
"description": "indicates if document has been redacted",
"type": "boolean"
}
},
"required": [
"_is_redacted"
]
},
"_spec_utils.StringifiedVersionNumber": {
"description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
},
{
"type": "string"
}
]
},
"ingest._types.PipelineProcessorResult": {
"type": "object",
"properties": {
"doc": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.DocumentSimulation"
}
]
},
"tag": {
"type": "string"
},
"processor_type": {
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.PipelineSimulationStatusOptions"
}
]
},
"description": {
"type": "string"
},
"ignored_error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
}
},
"ingest._types.PipelineSimulationStatusOptions": {
"type": "string",
"enum": [
"success",
"error",
"error_ignored",
"skipped",
"dropped"
]
},
"license.get.LicenseInformation": {
"type": "object",
"properties": {
"expiry_date": {
"description": "The date and time the license expires in ISO 8601 format.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"expiry_date_in_millis": {
"description": "The date and time the license expires in milliseconds since the Unix epoch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"issue_date": {
"description": "The date and time the license was issued in ISO 8601 format.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"issue_date_in_millis": {
"description": "The date and time the license was issued in milliseconds since the Unix epoch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"issued_to": {
"description": "The name of the customer or organization that received the license.",
"type": "string"
},
"issuer": {
"description": "The name of the organization that issued the license.",
"type": "string"
},
"max_nodes": {
"description": "The maximum number of nodes the license allows.",
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"max_resource_units": {
"description": "The maximum number of resource units the license allows (for enterprise licenses only).",
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"status": {
"description": "The status of the license. For example,active, valid, invalid, or expired.",
"allOf": [
{
"$ref": "#/components/schemas/license._types.LicenseStatus"
}
]
},
"type": {
"description": "The type of the license. For example, trial, basic, gold, platinum, or enterprise.",
"allOf": [
{
"$ref": "#/components/schemas/license._types.LicenseType"
}
]
},
"uid": {
"description": "The unique identifier of the license.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
},
"start_date_in_millis": {
"description": "The date and time the license was started in milliseconds since the Unix epoch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"issue_date",
"issue_date_in_millis",
"issued_to",
"issuer",
"max_nodes",
"status",
"type",
"uid",
"start_date_in_millis"
]
},
"license._types.LicenseStatus": {
"type": "string",
"enum": [
"active",
"valid",
"invalid",
"expired"
]
},
"license._types.LicenseType": {
"type": "string",
"enum": [
"missing",
"trial",
"basic",
"standard",
"dev",
"silver",
"gold",
"platinum",
"enterprise"
]
},
"license._types.License": {
"type": "object",
"properties": {
"expiry_date_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"issue_date_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"start_date_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"issued_to": {
"type": "string"
},
"issuer": {
"type": "string"
},
"max_nodes": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
},
"max_resource_units": {
"type": "number"
},
"signature": {
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/license._types.LicenseType"
}
]
},
"uid": {
"type": "string"
}
},
"required": [
"expiry_date_in_millis",
"issue_date_in_millis",
"issued_to",
"issuer",
"signature",
"type",
"uid"
]
},
"license.post.Acknowledgement": {
"type": "object",
"properties": {
"license": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
}
},
"required": [
"license",
"message"
]
},
"_types.ReindexTaskInfo": {
"description": "Information about a single parent reindex task, as returned by the reindex management APIs.",
"type": "object",
"properties": {
"id": {
"description": "The ID of the reindex task. The ID is assigned when the task was first created and remains the same across graceful shutdown relocations.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TaskId"
}
]
},
"description": {
"description": "A sanitized description of the reindex operation (source and destination indices, and optionally remote host info).",
"type": "string"
},
"start_time_in_millis": {
"description": "The time at which the reindex task started, in milliseconds since the Unix epoch. Remains the same across graceful shutdown relocations.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"start_time": {
"description": "The time at which the reindex task started, as an ISO-8601 formatted string. Remains the same across graceful shutdown relocations.\nOnly present when the request includes the `?human=true` query parameter.",
"type": "string"
},
"running_time": {
"description": "The elapsed running time of the reindex task, including relocations, in a human-readable format.\nOnly present when the request includes the `?human=true` query parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"running_time_in_nanos": {
"description": "The elapsed running time of the reindex task, including relocations, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"cancelled": {
"description": "Whether the reindex task has been cancelled.",
"type": "boolean"
},
"status": {
"description": "The current progress of the reindex operation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ReindexStatus"
}
]
}
},
"required": [
"id",
"start_time_in_millis",
"running_time_in_nanos",
"cancelled"
]
},
"logstash._types.Pipeline": {
"type": "object",
"properties": {
"description": {
"description": "A description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.",
"type": "string"
},
"last_modified": {
"description": "The date the pipeline was last updated.\nIt must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"pipeline": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/logstash/configuration-file-structure"
},
"description": "The configuration for the pipeline.",
"type": "string"
},
"pipeline_metadata": {
"description": "Optional metadata about the pipeline, which can have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.",
"allOf": [
{
"$ref": "#/components/schemas/logstash._types.PipelineMetadata"
}
]
},
"pipeline_settings": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file"
},
"description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.",
"allOf": [
{
"$ref": "#/components/schemas/logstash._types.PipelineSettings"
}
]
},
"username": {
"description": "The user who last updated the pipeline.",
"type": "string"
}
},
"required": [
"description",
"last_modified",
"pipeline",
"pipeline_metadata",
"pipeline_settings",
"username"
]
},
"logstash._types.PipelineMetadata": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"type",
"version"
]
},
"logstash._types.PipelineSettings": {
"type": "object",
"properties": {
"pipeline.workers": {
"description": "The number of workers that will, in parallel, execute the filter and output stages of the pipeline.",
"type": "number"
},
"pipeline.batch.size": {
"description": "The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs.",
"type": "number"
},
"pipeline.batch.delay": {
"description": "When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers.",
"type": "number"
},
"queue.type": {
"description": "The internal queuing model to use for event buffering.",
"type": "string"
},
"queue.max_bytes": {
"description": "The total capacity of the queue (`queue.type: persisted`) in number of bytes.",
"type": "string"
},
"queue.checkpoint.writes": {
"description": "The maximum number of written events before forcing a checkpoint when persistent queues are enabled (`queue.type: persisted`).",
"type": "number"
}
},
"required": [
"pipeline.workers",
"pipeline.batch.size",
"pipeline.batch.delay",
"queue.type",
"queue.max_bytes",
"queue.checkpoint.writes"
]
},
"_global.mget.Operation": {
"type": "object",
"properties": {
"_id": {
"description": "The unique document ID.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "The index that contains the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"routing": {
"description": "The key for the primary shard the document resides on. Required if routing is used during indexing.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Routing"
}
]
},
"_source": {
"description": "If `false`, excludes all _source fields.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"stored_fields": {
"description": "The stored fields you want to retrieve.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"version_type": {
"description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionType"
}
]
}
},
"required": [
"_id"
]
},
"_global.mget.ResponseItem": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.get.GetResult"
},
{
"$ref": "#/components/schemas/_global.mget.MultiGetError"
}
]
},
"_global.mget.MultiGetError": {
"type": "object",
"properties": {
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"error",
"_id",
"_index"
]
},
"migration.deprecations.Deprecation": {
"type": "object",
"properties": {
"details": {
"description": "Optional details about the deprecation warning.",
"type": "string"
},
"level": {
"description": "The level property describes the significance of the issue.\n\nSupported values include:\n - `none`\n - `info`\n - `warning`: You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.\n - `critical`: You cannot upgrade without fixing this problem.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/migration.deprecations.DeprecationLevel"
}
]
},
"message": {
"description": "Descriptive information about the deprecation warning.",
"type": "string"
},
"url": {
"description": "A link to the breaking change documentation, where you can find more information about this change.",
"type": "string"
},
"resolve_during_rolling_upgrade": {
"type": "boolean"
},
"_meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"level",
"message",
"url",
"resolve_during_rolling_upgrade"
]
},
"migration.deprecations.DeprecationLevel": {
"type": "string",
"enum": [
"none",
"info",
"warning",
"critical"
]
},
"migration.get_feature_upgrade_status.MigrationFeature": {
"type": "object",
"properties": {
"feature_name": {
"type": "string"
},
"minimum_index_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"migration_status": {
"allOf": [
{
"$ref": "#/components/schemas/migration.get_feature_upgrade_status.MigrationStatus"
}
]
},
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/migration.get_feature_upgrade_status.MigrationFeatureIndexInfo"
}
}
},
"required": [
"feature_name",
"minimum_index_version",
"migration_status",
"indices"
]
},
"migration.get_feature_upgrade_status.MigrationStatus": {
"type": "string",
"enum": [
"NO_MIGRATION_NEEDED",
"MIGRATION_NEEDED",
"IN_PROGRESS",
"ERROR"
]
},
"migration.get_feature_upgrade_status.MigrationFeatureIndexInfo": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"failure_cause": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"index",
"version"
]
},
"migration.post_feature_upgrade.MigrationFeature": {
"type": "object",
"properties": {
"feature_name": {
"type": "string"
}
},
"required": [
"feature_name"
]
},
"ml._types.AnalysisConfig": {
"type": "object",
"properties": {
"bucket_span": {
"description": "The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation.",
"default": "5m",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"categorization_analyzer": {
"description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CategorizationAnalyzer"
}
]
},
"categorization_field_name": {
"description": "If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"categorization_filters": {
"description": "If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same.",
"type": "array",
"items": {
"type": "string"
}
},
"detectors": {
"description": "Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Detector"
}
},
"influencers": {
"description": "A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"latency": {
"description": "The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API.",
"default": "0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"model_prune_window": {
"description": "Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"multivariate_by_fields": {
"description": "This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector.",
"type": "boolean"
},
"per_partition_categorization": {
"description": "Settings related to how categorization interacts with partition fields.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.PerPartitionCategorization"
}
]
},
"summary_count_field_name": {
"description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"detectors"
]
},
"ml._types.CategorizationAnalyzer": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/ml._types.CategorizationAnalyzerDefinition"
}
]
},
"ml._types.CategorizationAnalyzerDefinition": {
"type": "object",
"properties": {
"char_filter": {
"description": "One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.analysis.CharFilter"
}
},
"filter": {
"description": "One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.analysis.TokenFilter"
}
},
"tokenizer": {
"x-model": true,
"oneOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"description": "The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify `\"tokenizer\": \"ml_standard\"` in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `\"tokenizer\": \"ml_classic\"` in your `categorization_analyzer`.\n",
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference",
"description": "Tokenizer reference"
}
}
}
},
"ml._types.Detector": {
"type": "object",
"properties": {
"by_field_name": {
"description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"custom_rules": {
"description": "Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DetectionRule"
}
},
"detector_description": {
"description": "A description of the detector.",
"type": "string"
},
"detector_index": {
"description": "A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored.",
"type": "number"
},
"exclude_frequent": {
"description": "If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ExcludeFrequent"
}
]
},
"field_name": {
"description": "The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"function": {
"description": "The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`.",
"type": "string"
},
"over_field_name": {
"description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"partition_field_name": {
"description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"use_null": {
"description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.",
"default": false,
"type": "boolean"
}
}
},
"ml._types.DetectionRule": {
"type": "object",
"properties": {
"actions": {
"description": "The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.\n\nSupported values include:\n - `skip_result`: The result will not be created. Unless you also specify `skip_model_update`, the model will be updated as usual with the corresponding series value.\n - `skip_model_update`: The value for that series will not be used to update the model. Unless you also specify `skip_result`, the results will be created as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results.\n\n",
"default": [
"skip_result"
],
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.RuleAction"
}
},
"conditions": {
"description": "An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.RuleCondition"
}
},
"scope": {
"description": "A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ml._types.FilterRef"
}
}
}
},
"ml._types.RuleAction": {
"type": "string",
"enum": [
"skip_result",
"skip_model_update"
]
},
"ml._types.RuleCondition": {
"type": "object",
"properties": {
"applies_to": {
"description": "Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.AppliesTo"
}
]
},
"operator": {
"description": "Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ConditionOperator"
}
]
},
"value": {
"description": "The value that is compared against the `applies_to` field using the operator.",
"type": "number"
}
},
"required": [
"applies_to",
"operator",
"value"
]
},
"ml._types.AppliesTo": {
"type": "string",
"enum": [
"actual",
"typical",
"diff_from_typical",
"time"
]
},
"ml._types.ConditionOperator": {
"type": "string",
"enum": [
"gt",
"gte",
"lt",
"lte"
]
},
"ml._types.FilterRef": {
"type": "object",
"properties": {
"filter_id": {
"description": "The identifier for the filter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"filter_type": {
"description": "If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter.",
"default": "include",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.FilterType"
}
]
}
},
"required": [
"filter_id"
]
},
"ml._types.FilterType": {
"type": "string",
"enum": [
"include",
"exclude"
]
},
"ml._types.ExcludeFrequent": {
"type": "string",
"enum": [
"all",
"none",
"by",
"over"
]
},
"ml._types.PerPartitionCategorization": {
"type": "object",
"properties": {
"enabled": {
"description": "To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails.",
"type": "boolean"
},
"stop_on_warn": {
"description": "This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly.",
"type": "boolean"
}
}
},
"ml._types.DataframeEvaluationContainer": {
"type": "object",
"properties": {
"classification": {
"description": "Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationClassification"
}
]
},
"outlier_detection": {
"description": "Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetection"
}
]
},
"regression": {
"description": "Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationRegression"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.DataframeEvaluationClassification": {
"type": "object",
"properties": {
"actual_field": {
"description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"predicted_field": {
"description": "The field in the index which contains the predicted value, in other words the results of the classification analysis.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"top_classes_field": {
"description": "The field of the index which is an array of documents of the form { \"class_name\": XXX, \"class_probability\": YYY }. This field must be defined as nested in the mappings.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"metrics": {
"description": "Specifies the metrics that are used for the evaluation.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetrics"
}
]
}
},
"required": [
"actual_field"
]
},
"ml._types.DataframeEvaluationClassificationMetrics": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationMetrics"
},
{
"type": "object",
"properties": {
"accuracy": {
"description": "Accuracy of predictions (per-class and overall).",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"multiclass_confusion_matrix": {
"description": "Multiclass confusion matrix.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
]
},
"ml._types.DataframeEvaluationMetrics": {
"type": "object",
"properties": {
"auc_roc": {
"description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetricsAucRoc"
}
]
},
"precision": {
"description": "Precision of predictions (per-class and average).",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"recall": {
"description": "Recall of predictions (per-class and average).",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"ml._types.DataframeEvaluationClassificationMetricsAucRoc": {
"type": "object",
"properties": {
"class_name": {
"description": "Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative (\"one-vs-all\" strategy). All the evaluated documents must have class_name in the list of their top classes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"include_curve": {
"description": "Whether or not the curve should be returned in addition to the score. Default value is false.",
"type": "boolean"
}
}
},
"ml._types.DataframeEvaluationOutlierDetection": {
"type": "object",
"properties": {
"actual_field": {
"description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"predicted_probability_field": {
"description": "The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"metrics": {
"description": "Specifies the metrics that are used for the evaluation.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetectionMetrics"
}
]
}
},
"required": [
"actual_field",
"predicted_probability_field"
]
},
"ml._types.DataframeEvaluationOutlierDetectionMetrics": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationMetrics"
},
{
"type": "object",
"properties": {
"confusion_matrix": {
"description": "Accuracy of predictions (per-class and overall).",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
]
},
"ml._types.DataframeEvaluationRegression": {
"type": "object",
"properties": {
"actual_field": {
"description": "The field of the index which contains the ground truth. The data type of this field must be numerical.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"predicted_field": {
"description": "The field in the index that contains the predicted value, in other words the results of the regression analysis.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"metrics": {
"description": "Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetrics"
}
]
}
},
"required": [
"actual_field",
"predicted_field"
]
},
"ml._types.DataframeEvaluationRegressionMetrics": {
"type": "object",
"properties": {
"mse": {
"description": "Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"msle": {
"description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsMsle"
}
]
},
"huber": {
"description": "Pseudo Huber loss function.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsHuber"
}
]
},
"r_squared": {
"description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"ml._types.DataframeEvaluationRegressionMetricsMsle": {
"type": "object",
"properties": {
"offset": {
"description": "Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1.",
"type": "number"
}
}
},
"ml._types.DataframeEvaluationRegressionMetricsHuber": {
"type": "object",
"properties": {
"delta": {
"description": "Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0.",
"type": "number"
}
}
},
"ml.evaluate_data_frame.DataframeClassificationSummary": {
"type": "object",
"properties": {
"auc_roc": {
"description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.\nIt is calculated for a specific class (provided as \"class_name\") treated as positive.",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc"
}
]
},
"accuracy": {
"description": "Accuracy of predictions (per-class and overall).",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy"
}
]
},
"multiclass_confusion_matrix": {
"description": "Multiclass confusion matrix.",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix"
}
]
},
"precision": {
"description": "Precision of predictions (per-class and average).",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryPrecision"
}
]
},
"recall": {
"description": "Recall of predictions (per-class and average).",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryRecall"
}
]
}
}
},
"ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc": {
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
},
{
"type": "object",
"properties": {
"curve": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRocCurveItem"
}
}
}
}
]
},
"ml.evaluate_data_frame.DataframeEvaluationSummaryAucRocCurveItem": {
"type": "object",
"properties": {
"tpr": {
"type": "number"
},
"fpr": {
"type": "number"
},
"threshold": {
"type": "number"
}
},
"required": [
"tpr",
"fpr",
"threshold"
]
},
"ml.evaluate_data_frame.DataframeEvaluationValue": {
"type": "object",
"properties": {
"value": {
"type": "number"
}
},
"required": [
"value"
]
},
"ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy": {
"type": "object",
"properties": {
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationClass"
}
},
"overall_accuracy": {
"type": "number"
}
},
"required": [
"classes",
"overall_accuracy"
]
},
"ml.evaluate_data_frame.DataframeEvaluationClass": {
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
},
{
"type": "object",
"properties": {
"class_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"class_name"
]
}
]
},
"ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix": {
"type": "object",
"properties": {
"confusion_matrix": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.evaluate_data_frame.ConfusionMatrixItem"
}
},
"other_actual_class_count": {
"type": "number"
}
},
"required": [
"confusion_matrix",
"other_actual_class_count"
]
},
"ml.evaluate_data_frame.ConfusionMatrixItem": {
"type": "object",
"properties": {
"actual_class": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"actual_class_doc_count": {
"type": "number"
},
"predicted_classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.evaluate_data_frame.ConfusionMatrixPrediction"
}
},
"other_predicted_class_doc_count": {
"type": "number"
}
},
"required": [
"actual_class",
"actual_class_doc_count",
"predicted_classes",
"other_predicted_class_doc_count"
]
},
"ml.evaluate_data_frame.ConfusionMatrixPrediction": {
"type": "object",
"properties": {
"predicted_class": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"count": {
"type": "number"
}
},
"required": [
"predicted_class",
"count"
]
},
"ml.evaluate_data_frame.DataframeClassificationSummaryPrecision": {
"type": "object",
"properties": {
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationClass"
}
},
"avg_precision": {
"type": "number"
}
},
"required": [
"classes",
"avg_precision"
]
},
"ml.evaluate_data_frame.DataframeClassificationSummaryRecall": {
"type": "object",
"properties": {
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationClass"
}
},
"avg_recall": {
"type": "number"
}
},
"required": [
"classes",
"avg_recall"
]
},
"ml.evaluate_data_frame.DataframeOutlierDetectionSummary": {
"type": "object",
"properties": {
"auc_roc": {
"description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.",
"default": "{\"include_curve\": false}",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc"
}
]
},
"precision": {
"description": "Set the different thresholds of the outlier score at where the metric is calculated.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"recall": {
"description": "Set the different thresholds of the outlier score at where the metric is calculated.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"confusion_matrix": {
"description": "Set the different thresholds of the outlier score at where the metrics (`tp` - true positive, `fp` - false positive, `tn` - true negative, `fn` - false negative) are calculated.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ml.evaluate_data_frame.ConfusionMatrixThreshold"
}
}
}
},
"ml.evaluate_data_frame.ConfusionMatrixThreshold": {
"type": "object",
"properties": {
"tp": {
"description": "True Positive",
"type": "number"
},
"fp": {
"description": "False Positive",
"type": "number"
},
"tn": {
"description": "True Negative",
"type": "number"
},
"fn": {
"description": "False Negative",
"type": "number"
}
},
"required": [
"tp",
"fp",
"tn",
"fn"
]
},
"ml.evaluate_data_frame.DataframeRegressionSummary": {
"type": "object",
"properties": {
"huber": {
"description": "Pseudo Huber loss function.",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
}
]
},
"mse": {
"description": "Average squared difference between the predicted values and the actual (`ground truth`) value.",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
}
]
},
"msle": {
"description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (`ground truth`) value.",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
}
]
},
"r_squared": {
"description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.",
"allOf": [
{
"$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
}
]
}
}
},
"ml._types.DataframeAnalyticsSource": {
"type": "object",
"properties": {
"index": {
"description": "Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"runtime_mappings": {
"description": "Definitions of runtime fields that will become part of the mapping of the destination index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"_source": {
"description": "Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields"
}
]
},
"query": {
"x-model": true,
"type": "object",
"description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: `{\"match_all\": {}}`.\n",
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl",
"description": "Query DSL"
}
}
},
"required": [
"index"
]
},
"ml._types.DataframeAnalysisAnalyzedFields": {
"type": "object",
"properties": {
"includes": {
"description": "An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.",
"type": "array",
"items": {
"type": "string"
}
},
"excludes": {
"description": "An array of strings that defines the fields that will be included in the analysis.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ml._types.DataframeAnalyticsDestination": {
"type": "object",
"properties": {
"index": {
"description": "Defines the destination index to store the results of the data frame analytics job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"results_field": {
"description": "Defines the name of the field in which to store the results of the analysis. Defaults to `ml`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"index"
]
},
"ml._types.DataframeAnalysisContainer": {
"type": "object",
"properties": {
"classification": {
"description": "The configuration information necessary to perform classification.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisClassification"
}
]
},
"outlier_detection": {
"description": "The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisOutlierDetection"
}
]
},
"regression": {
"description": "The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisRegression"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.DataframeAnalysisClassification": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysis"
},
{
"type": "object",
"properties": {
"class_assignment_objective": {
"type": "string"
},
"num_top_classes": {
"description": "Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories.",
"default": 2,
"type": "number"
}
}
}
]
},
"ml._types.DataframeAnalysis": {
"type": "object",
"properties": {
"alpha": {
"description": "Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.",
"type": "number"
},
"dependent_variable": {
"description": "Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.\nFor classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.\nFor regression analysis, the data type of the field must be numeric.",
"type": "string"
},
"downsample_factor": {
"description": "Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.",
"type": "number"
},
"early_stopping_enabled": {
"description": "Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable.",
"default": true,
"type": "boolean"
},
"eta": {
"description": "Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1.",
"type": "number"
},
"eta_growth_rate_per_tree": {
"description": "Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2.",
"type": "number"
},
"feature_bag_fraction": {
"description": "Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.",
"type": "number"
},
"feature_processors": {
"description": "Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessor"
}
},
"gamma": {
"description": "Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.",
"type": "number"
},
"lambda": {
"description": "Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.",
"type": "number"
},
"max_optimization_rounds_per_hyperparameter": {
"description": "Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.",
"type": "number"
},
"max_trees": {
"description": "Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.",
"type": "number"
},
"num_top_feature_importance_values": {
"description": "Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs.",
"default": 0,
"type": "number"
},
"prediction_field_name": {
"description": "Defines the name of the prediction field in the results. Defaults to `_prediction`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"randomize_seed": {
"description": "Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same).",
"type": "number"
},
"soft_tree_depth_limit": {
"description": "Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.",
"type": "number"
},
"soft_tree_depth_tolerance": {
"description": "Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01.",
"type": "number"
},
"training_percent": {
"description": "Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage.",
"default": 100,
"allOf": [
{
"$ref": "#/components/schemas/_types.Percentage"
}
]
}
},
"required": [
"dependent_variable"
]
},
"ml._types.DataframeAnalysisFeatureProcessor": {
"type": "object",
"properties": {
"frequency_encoding": {
"description": "The configuration information necessary to perform frequency encoding.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding"
}
]
},
"multi_encoding": {
"description": "The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorMultiEncoding"
}
]
},
"n_gram_encoding": {
"description": "The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: .. For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorNGramEncoding"
}
]
},
"one_hot_encoding": {
"description": "The configuration information necessary to perform one hot encoding.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding"
}
]
},
"target_mean_encoding": {
"description": "The configuration information necessary to perform target mean encoding.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding": {
"type": "object",
"properties": {
"feature_name": {
"description": "The resulting feature name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"frequency_map": {
"description": "The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0.",
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"feature_name",
"field",
"frequency_map"
]
},
"ml._types.DataframeAnalysisFeatureProcessorMultiEncoding": {
"type": "object",
"properties": {
"processors": {
"description": "The ordered array of custom processors to execute. Must be more than 1.",
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"processors"
]
},
"ml._types.DataframeAnalysisFeatureProcessorNGramEncoding": {
"type": "object",
"properties": {
"feature_prefix": {
"description": "The feature name prefix. Defaults to ngram__.",
"type": "string"
},
"field": {
"description": "The name of the text field to encode.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"length": {
"description": "Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.",
"type": "number"
},
"n_grams": {
"description": "Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5.",
"type": "array",
"items": {
"type": "number"
}
},
"start": {
"description": "Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0.",
"type": "number"
},
"custom": {
"type": "boolean"
}
},
"required": [
"field",
"n_grams"
]
},
"ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding": {
"type": "object",
"properties": {
"field": {
"description": "The name of the field to encode.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"hot_map": {
"description": "The one hot map mapping the field value with the column name.",
"type": "string"
}
},
"required": [
"field",
"hot_map"
]
},
"ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding": {
"type": "object",
"properties": {
"default_value": {
"description": "The default value if field value is not found in the target_map.",
"type": "number"
},
"feature_name": {
"description": "The resulting feature name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"field": {
"description": "The name of the field to encode.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"target_map": {
"description": "The field value to target mean transition map.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"default_value",
"feature_name",
"field",
"target_map"
]
},
"ml._types.DataframeAnalysisOutlierDetection": {
"type": "object",
"properties": {
"compute_feature_influence": {
"description": "Specifies whether the feature influence calculation is enabled.",
"default": true,
"type": "boolean"
},
"feature_influence_threshold": {
"description": "The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1.",
"default": 0.1,
"type": "number"
},
"method": {
"description": "The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score.",
"default": "ensemble",
"type": "string"
},
"n_neighbors": {
"description": "Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.",
"type": "number"
},
"outlier_fraction": {
"description": "The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.",
"type": "number"
},
"standardization_enabled": {
"description": "If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`.",
"default": true,
"type": "boolean"
}
}
},
"ml._types.DataframeAnalysisRegression": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysis"
},
{
"type": "object",
"properties": {
"loss_function": {
"description": "The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss).",
"default": "mse",
"type": "string"
},
"loss_function_parameter": {
"description": "A positive number that is used as a parameter to the `loss_function`.",
"type": "number"
}
}
}
]
},
"ml._types.DataframeAnalyticsFieldSelection": {
"type": "object",
"properties": {
"is_included": {
"description": "Whether the field is selected to be included in the analysis.",
"type": "boolean"
},
"is_required": {
"description": "Whether the field is required.",
"type": "boolean"
},
"feature_type": {
"description": "The feature type of this field for the analysis. May be categorical or numerical.",
"type": "string"
},
"mapping_types": {
"description": "The mapping types of the field.",
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"description": "The field name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"reason": {
"description": "The reason a field is not selected to be included in the analysis.",
"type": "string"
}
},
"required": [
"is_included",
"is_required",
"mapping_types",
"name"
]
},
"ml._types.DataframeAnalyticsMemoryEstimation": {
"type": "object",
"properties": {
"expected_memory_with_disk": {
"description": "Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics.",
"type": "string"
},
"expected_memory_without_disk": {
"description": "Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk).",
"type": "string"
}
},
"required": [
"expected_memory_with_disk",
"expected_memory_without_disk"
]
},
"ml._types.Page": {
"type": "object",
"properties": {
"from": {
"description": "Skips the specified number of items.",
"default": 0,
"type": "number"
},
"size": {
"description": "Specifies the maximum number of items to obtain.",
"default": 10000,
"type": "number"
}
}
},
"ml._types.BucketSummary": {
"type": "object",
"properties": {
"anomaly_score": {
"description": "The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited\nscore for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as\nnew data is analyzed.",
"type": "number"
},
"bucket_influencers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.BucketInfluencer"
}
},
"bucket_span": {
"description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitSeconds"
}
]
},
"event_count": {
"description": "The number of input data records processed in this bucket.",
"type": "number"
},
"initial_anomaly_score": {
"description": "The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the\ntime the bucket was processed.",
"type": "number"
},
"is_interim": {
"description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.",
"type": "boolean"
},
"job_id": {
"description": "Identifier for the anomaly detection job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"processing_time_ms": {
"description": "The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"result_type": {
"description": "Internal. This value is always set to bucket.",
"type": "string"
},
"timestamp": {
"description": "The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"timestamp_string": {
"description": "The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"anomaly_score",
"bucket_influencers",
"bucket_span",
"event_count",
"initial_anomaly_score",
"is_interim",
"job_id",
"processing_time_ms",
"result_type",
"timestamp"
]
},
"ml._types.BucketInfluencer": {
"type": "object",
"properties": {
"anomaly_score": {
"description": "A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as\nnewer data is analyzed.",
"type": "number"
},
"bucket_span": {
"description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitSeconds"
}
]
},
"influencer_field_name": {
"description": "The field name of the influencer.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"initial_anomaly_score": {
"description": "The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the\ntime the bucket was processed.",
"type": "number"
},
"is_interim": {
"description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.",
"type": "boolean"
},
"job_id": {
"description": "Identifier for the anomaly detection job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"probability": {
"description": "The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision\nof over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of\nthis.",
"type": "number"
},
"raw_anomaly_score": {
"description": "Internal.",
"type": "number"
},
"result_type": {
"description": "Internal. This value is always set to `bucket_influencer`.",
"type": "string"
},
"timestamp": {
"description": "The start time of the bucket for which these results were calculated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"timestamp_string": {
"description": "The start time of the bucket for which these results were calculated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"anomaly_score",
"bucket_span",
"influencer_field_name",
"initial_anomaly_score",
"is_interim",
"job_id",
"probability",
"raw_anomaly_score",
"result_type",
"timestamp"
]
},
"_types.DurationValueUnitSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitSeconds"
}
]
},
"ml._types.CalendarEvent": {
"type": "object",
"properties": {
"calendar_id": {
"description": "A string that uniquely identifies a calendar.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"event_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"description": {
"description": "A description of the scheduled event.",
"type": "string"
},
"end_time": {
"description": "The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"start_time": {
"description": "The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"skip_result": {
"description": "When true the model will not create results for this calendar period.",
"default": true,
"type": "boolean"
},
"skip_model_update": {
"description": "When true the model will not be updated for this calendar period.",
"default": true,
"type": "boolean"
},
"force_time_shift": {
"description": "Shift time by this many seconds. For example adjust time for daylight savings changes",
"type": "number"
}
},
"required": [
"description",
"end_time",
"start_time"
]
},
"ml.get_calendars.Calendar": {
"type": "object",
"properties": {
"calendar_id": {
"description": "A string that uniquely identifies a calendar.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"description": {
"description": "A description of the calendar.",
"type": "string"
},
"job_ids": {
"description": "An array of anomaly detection job identifiers.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
}
},
"required": [
"calendar_id",
"job_ids"
]
},
"_types.CategoryId": {
"type": "number"
},
"ml._types.Category": {
"type": "object",
"properties": {
"category_id": {
"description": "A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ulong"
}
]
},
"examples": {
"description": "A list of examples of actual values that matched the category.",
"type": "array",
"items": {
"type": "string"
}
},
"grok_pattern": {
"description": "[experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking.",
"allOf": [
{
"$ref": "#/components/schemas/_types.GrokPattern"
}
]
},
"job_id": {
"description": "Identifier for the anomaly detection job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"max_matching_length": {
"description": "The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ulong"
}
]
},
"partition_field_name": {
"description": "If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled.",
"type": "string"
},
"partition_field_value": {
"description": "If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled.",
"type": "string"
},
"regex": {
"description": "A regular expression that is used to search for values that match the category.",
"type": "string"
},
"terms": {
"description": "A space separated list of the common tokens that are matched in values of the category.",
"type": "string"
},
"num_matches": {
"description": "The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close",
"type": "number"
},
"preferred_to_categories": {
"description": "A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
},
"p": {
"type": "string"
},
"result_type": {
"type": "string"
},
"mlcategory": {
"type": "string"
}
},
"required": [
"category_id",
"examples",
"job_id",
"max_matching_length",
"regex",
"terms",
"result_type",
"mlcategory"
]
},
"ml._types.DataframeAnalyticsSummary": {
"type": "object",
"properties": {
"allow_lazy_start": {
"type": "boolean"
},
"analysis": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer"
}
]
},
"analyzed_fields": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields"
}
]
},
"authorization": {
"description": "The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization"
}
]
},
"create_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"description": {
"type": "string"
},
"dest": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"max_num_threads": {
"type": "number"
},
"model_memory_limit": {
"type": "string"
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"_meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
},
"required": [
"analysis",
"dest",
"id",
"source"
]
},
"ml._types.DataframeAnalyticsAuthorization": {
"type": "object",
"properties": {
"api_key": {
"description": "If an API key was used for the most recent update to the job, its name and identifier are listed in the response.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ApiKeyAuthorization"
}
]
},
"roles": {
"description": "If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response.",
"type": "array",
"items": {
"type": "string"
}
},
"service_account": {
"description": "If a service account was used for the most recent update to the job, the account name is listed in the response.",
"type": "string"
}
}
},
"ml._types.ApiKeyAuthorization": {
"type": "object",
"properties": {
"id": {
"description": "The identifier for the API key.",
"type": "string"
},
"name": {
"description": "The name of the API key.",
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"ml._types.DataframeAnalytics": {
"type": "object",
"properties": {
"analysis_stats": {
"description": "An object containing information about the analysis job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsContainer"
}
]
},
"assignment_explanation": {
"description": "For running jobs only, contains messages relating to the selection of a node to run the job.",
"type": "string"
},
"data_counts": {
"description": "An object that provides counts for the quantity of documents skipped, used in training, or available for testing.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsDataCounts"
}
]
},
"id": {
"description": "The unique identifier of the data frame analytics job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"memory_usage": {
"description": "An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsMemoryUsage"
}
]
},
"node": {
"description": "Contains properties for the node that runs the job. This information is available only for running jobs.",
"x-state": "Generally available",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeAttributes"
}
]
},
"progress": {
"description": "The progress report of the data frame analytics job by phase.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsProgress"
}
},
"state": {
"description": "The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeState"
}
]
}
},
"required": [
"data_counts",
"id",
"memory_usage",
"progress",
"state"
]
},
"ml._types.DataframeAnalyticsStatsContainer": {
"type": "object",
"properties": {
"classification_stats": {
"description": "An object containing information about the classification analysis job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters"
}
]
},
"outlier_detection_stats": {
"description": "An object containing information about the outlier detection job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsOutlierDetection"
}
]
},
"regression_stats": {
"description": "An object containing information about the regression analysis.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.DataframeAnalyticsStatsHyperparameters": {
"type": "object",
"properties": {
"hyperparameters": {
"description": "An object containing the parameters of the classification analysis job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Hyperparameters"
}
]
},
"iteration": {
"description": "The number of iterations on the analysis.",
"type": "number"
},
"timestamp": {
"description": "The timestamp when the statistics were reported in milliseconds since the epoch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"timing_stats": {
"description": "An object containing time statistics about the data frame analytics job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TimingStats"
}
]
},
"validation_loss": {
"description": "An object containing information about validation loss.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ValidationLoss"
}
]
}
},
"required": [
"hyperparameters",
"iteration",
"timestamp",
"timing_stats",
"validation_loss"
]
},
"ml._types.Hyperparameters": {
"type": "object",
"properties": {
"alpha": {
"description": "Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis parameter affects loss calculations by acting as a multiplier of the tree depth.\nHigher alpha values result in shallower trees and faster training times.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to zero.",
"type": "number"
},
"lambda": {
"description": "Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest.\nA high lambda value causes training to favor small leaf weights.\nThis behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable.\nA small lambda value results in large individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value.",
"type": "number"
},
"gamma": {
"description": "Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies a linear penalty associated with the size of individual trees in the forest.\nA high gamma value causes training to prefer small trees.\nA small gamma value results in larger individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value.",
"type": "number"
},
"eta": {
"description": "Advanced configuration option.\nThe shrinkage applied to the weights.\nSmaller values result in larger forests which have a better generalization error.\nHowever, larger forests cause slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a value between `0.001` and `1`.",
"type": "number"
},
"eta_growth_rate_per_tree": {
"description": "Advanced configuration option.\nSpecifies the rate at which `eta` increases for each new tree that is added to the forest.\nFor example, a rate of 1.05 increases `eta` by 5% for each extra tree.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be between `0.5` and `2`.",
"type": "number"
},
"feature_bag_fraction": {
"description": "Advanced configuration option.\nDefines the fraction of features that will be used when selecting a random bag for each candidate split.\nBy default, this value is calculated during hyperparameter optimization.",
"type": "number"
},
"downsample_factor": {
"description": "Advanced configuration option.\nControls the fraction of data that is used to compute the derivatives of the loss function for tree training.\nA small value results in the use of a small fraction of the data.\nIf this value is set to be less than 1, accuracy typically improves.\nHowever, too small a value may result in poor convergence for the ensemble and so require more trees.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than zero and less than or equal to 1.",
"type": "number"
},
"max_attempts_to_add_tree": {
"description": "If the algorithm fails to determine a non-trivial tree (more than a single leaf), this parameter determines how many of such consecutive failures are tolerated.\nOnce the number of attempts exceeds the threshold, the forest training stops.",
"type": "number"
},
"max_optimization_rounds_per_hyperparameter": {
"description": "Advanced configuration option.\nA multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure.\nThe maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter.\nBy default, this value is calculated during hyperparameter optimization.",
"type": "number"
},
"max_trees": {
"description": "Advanced configuration option.\nDefines the maximum number of decision trees in the forest.\nThe maximum value is 2000.\nBy default, this value is calculated during hyperparameter optimization.",
"type": "number"
},
"num_folds": {
"description": "The maximum number of folds for the cross-validation procedure.",
"type": "number"
},
"num_splits_per_feature": {
"description": "Determines the maximum number of splits for every feature that can occur in a decision tree when the tree is trained.",
"type": "number"
},
"soft_tree_depth_limit": {
"description": "Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0.",
"type": "number"
},
"soft_tree_depth_tolerance": {
"description": "Advanced configuration option.\nThis option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0.01.",
"type": "number"
}
}
},
"ml._types.TimingStats": {
"type": "object",
"properties": {
"elapsed_time": {
"description": "Runtime of the analysis in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"iteration_time": {
"description": "Runtime of the latest iteration of the analysis in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"elapsed_time"
]
},
"ml._types.ValidationLoss": {
"type": "object",
"properties": {
"fold_values": {
"description": "Validation loss values for every added decision tree during the forest growing procedure.",
"type": "array",
"items": {
"type": "string"
}
},
"loss_type": {
"description": "The type of the loss metric. For example, binomial_logistic.",
"type": "string"
}
},
"required": [
"fold_values",
"loss_type"
]
},
"ml._types.DataframeAnalyticsStatsOutlierDetection": {
"type": "object",
"properties": {
"parameters": {
"description": "The list of job parameters specified by the user or determined by algorithmic heuristics.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.OutlierDetectionParameters"
}
]
},
"timestamp": {
"description": "The timestamp when the statistics were reported in milliseconds since the epoch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"timing_stats": {
"description": "An object containing time statistics about the data frame analytics job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TimingStats"
}
]
}
},
"required": [
"parameters",
"timestamp",
"timing_stats"
]
},
"ml._types.OutlierDetectionParameters": {
"type": "object",
"properties": {
"compute_feature_influence": {
"description": "Specifies whether the feature influence calculation is enabled.",
"default": true,
"type": "boolean"
},
"feature_influence_threshold": {
"description": "The minimum outlier score that a document needs to have in order to calculate its feature influence score.\nValue range: 0-1",
"default": 0.1,
"type": "number"
},
"method": {
"description": "The method that outlier detection uses.\nAvailable methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`.\nThe default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score.",
"type": "string"
},
"n_neighbors": {
"description": "Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score.\nWhen the value is not set, different values are used for different ensemble members.\nThis default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.",
"type": "number"
},
"outlier_fraction": {
"description": "The proportion of the data set that is assumed to be outlying prior to outlier detection.\nFor example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.",
"type": "number"
},
"standardization_enabled": {
"description": "If `true`, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i).",
"default": true,
"type": "boolean"
}
}
},
"ml._types.DataframeAnalyticsStatsDataCounts": {
"type": "object",
"properties": {
"skipped_docs_count": {
"description": "The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element.",
"type": "number"
},
"test_docs_count": {
"description": "The number of documents that are not used for training the model and can be used for testing.",
"type": "number"
},
"training_docs_count": {
"description": "The number of documents that are used for training the model.",
"type": "number"
}
},
"required": [
"skipped_docs_count",
"test_docs_count",
"training_docs_count"
]
},
"ml._types.DataframeAnalyticsStatsMemoryUsage": {
"type": "object",
"properties": {
"memory_reestimate_bytes": {
"description": "This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs.",
"type": "number"
},
"peak_usage_bytes": {
"description": "The number of bytes used at the highest peak of memory usage.",
"type": "number"
},
"status": {
"description": "The memory usage status.",
"type": "string"
},
"timestamp": {
"description": "The timestamp when memory usage was calculated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"peak_usage_bytes",
"status"
]
},
"_types.NodeAttributes": {
"type": "object",
"properties": {
"attributes": {
"description": "Lists node attributes.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ephemeral_id": {
"description": "The ephemeral ID of the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"id": {
"description": "The unique identifier of the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
}
]
},
"name": {
"description": "The unique identifier of the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeName"
}
]
},
"transport_address": {
"description": "The host and port where transport HTTP connections are accepted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
}
},
"required": [
"attributes",
"ephemeral_id",
"name",
"transport_address"
]
},
"ml._types.DataframeAnalyticsStatsProgress": {
"type": "object",
"properties": {
"phase": {
"description": "Defines the phase of the data frame analytics job.",
"type": "string"
},
"progress_percent": {
"description": "The progress that the data frame analytics job has made expressed in percentage.",
"type": "number"
}
},
"required": [
"phase",
"progress_percent"
]
},
"ml._types.DataframeState": {
"type": "string",
"enum": [
"started",
"stopped",
"starting",
"stopping",
"failed"
]
},
"ml._types.DatafeedStats": {
"type": "object",
"properties": {
"assignment_explanation": {
"description": "For started datafeeds only, contains messages relating to the selection of a node.",
"type": "string"
},
"datafeed_id": {
"description": "A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"node": {
"description": "For started datafeeds only, this information pertains to the node upon which the datafeed is started.",
"x-state": "Generally available",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DiscoveryNodeCompact"
}
]
},
"state": {
"description": "The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DatafeedState"
}
]
},
"timing_stats": {
"description": "An object that provides statistical information about timing aspect of this datafeed.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DatafeedTimingStats"
}
]
},
"running_state": {
"description": "An object containing the running state for this datafeed.\nIt is only provided if the datafeed is started.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DatafeedRunningState"
}
]
}
},
"required": [
"datafeed_id",
"state"
]
},
"ml._types.DiscoveryNodeCompact": {
"description": "Alternative representation of DiscoveryNode used in ml.get_job_stats and ml.get_datafeed_stats",
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"ephemeral_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"transport_address": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"name",
"ephemeral_id",
"id",
"transport_address",
"attributes"
]
},
"ml._types.DatafeedTimingStats": {
"type": "object",
"properties": {
"bucket_count": {
"description": "The number of buckets processed.",
"type": "number"
},
"exponential_average_search_time_per_hour_ms": {
"description": "The exponential average search time per hour, in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"exponential_average_calculation_context": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ExponentialAverageCalculationContext"
}
]
},
"job_id": {
"description": "Identifier for the anomaly detection job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"search_count": {
"description": "The number of searches run by the datafeed.",
"type": "number"
},
"total_search_time_ms": {
"description": "The total time the datafeed spent searching, in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"average_search_time_per_bucket_ms": {
"description": "The average search time per bucket, in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
}
},
"required": [
"bucket_count",
"exponential_average_search_time_per_hour_ms",
"job_id",
"search_count",
"total_search_time_ms"
]
},
"_types.DurationValueUnitFloatMillis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.UnitFloatMillis"
}
]
},
"_types.UnitFloatMillis": {
"description": "Time unit for fractional milliseconds",
"type": "number"
},
"ml._types.ExponentialAverageCalculationContext": {
"type": "object",
"properties": {
"incremental_metric_value_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"latest_timestamp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"previous_exponential_average_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
}
},
"required": [
"incremental_metric_value_ms"
]
},
"ml._types.DatafeedRunningState": {
"type": "object",
"properties": {
"real_time_configured": {
"description": "Indicates if the datafeed is \"real-time\"; meaning that the datafeed has no configured `end` time.",
"type": "boolean"
},
"real_time_running": {
"description": "Indicates whether the datafeed has finished running on the available past data.\nFor datafeeds without a configured `end` time, this means that the datafeed is now running on \"real-time\" data.",
"type": "boolean"
},
"search_interval": {
"description": "Provides the latest time interval the datafeed has searched.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.RunningStateSearchInterval"
}
]
}
},
"required": [
"real_time_configured",
"real_time_running"
]
},
"ml._types.RunningStateSearchInterval": {
"type": "object",
"properties": {
"end": {
"description": "The end time.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"end_ms": {
"description": "The end time as an epoch in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"start": {
"description": "The start time.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"start_ms": {
"description": "The start time as an epoch in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"end_ms",
"start_ms"
]
},
"ml._types.Datafeed": {
"type": "object",
"properties": {
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"authorization": {
"description": "The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DatafeedAuthorization"
}
]
},
"chunking_config": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ChunkingConfig"
}
]
},
"datafeed_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"frequency": {
"description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"indices": {
"type": "array",
"items": {
"type": "string"
}
},
"indexes": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"max_empty_searches": {
"type": "number"
},
"query_delay": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"script_fields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ScriptField"
}
},
"scroll_size": {
"type": "number"
},
"delayed_data_check_config": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig"
}
]
},
"runtime_mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"indices_options": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndicesOptions"
}
]
},
"query": {
"x-model": true,
"type": "object",
"description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: `{\"match_all\": {\"boost\": 1}}`.\n",
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl",
"description": "Query DSL"
}
}
},
"required": [
"datafeed_id",
"indices",
"job_id",
"query",
"delayed_data_check_config"
]
},
"ml._types.DatafeedAuthorization": {
"type": "object",
"properties": {
"api_key": {
"description": "If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ApiKeyAuthorization"
}
]
},
"roles": {
"description": "If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response.",
"type": "array",
"items": {
"type": "string"
}
},
"service_account": {
"description": "If a service account was used for the most recent update to the datafeed, the account name is listed in the response.",
"type": "string"
}
}
},
"ml._types.ChunkingConfig": {
"type": "object",
"properties": {
"mode": {
"description": "If the mode is `auto`, the chunk size is dynamically calculated;\nthis is the recommended value when the datafeed does not use aggregations.\nIf the mode is `manual`, chunking is applied according to the specified `time_span`;\nuse this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ChunkingMode"
}
]
},
"time_span": {
"description": "The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`.",
"default": "3h",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"mode"
]
},
"ml._types.ChunkingMode": {
"type": "string",
"enum": [
"auto",
"manual",
"off"
]
},
"ml._types.DelayedDataCheckConfig": {
"type": "object",
"properties": {
"check_window": {
"description": "The window of time that is searched for late data. This window of time ends with the latest finalized bucket.\nIt defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.\nIn particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"enabled": {
"description": "Specifies whether the datafeed periodically checks for delayed data.",
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"_types.IndicesOptions": {
"description": "Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded\nto actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.",
"type": "object",
"properties": {
"allow_no_indices": {
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"type": "boolean"
},
"expand_wildcards": {
"description": "Type of index that wildcard patterns 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",
"allOf": [
{
"$ref": "#/components/schemas/_types.ExpandWildcards"
}
]
},
"ignore_unavailable": {
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"default": false,
"type": "boolean"
},
"ignore_throttled": {
"description": "If true, concrete, expanded or aliased indices are ignored when frozen.",
"default": true,
"type": "boolean"
}
}
},
"ml._types.Filter": {
"type": "object",
"properties": {
"description": {
"description": "A description of the filter.",
"type": "string"
},
"filter_id": {
"description": "A string that uniquely identifies a filter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"items": {
"description": "An array of strings which is the filter item list.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"filter_id",
"items"
]
},
"ml._types.Influencer": {
"type": "object",
"properties": {
"bucket_span": {
"description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitSeconds"
}
]
},
"influencer_score": {
"description": "A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated\nacross detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new\ndata is analyzed.",
"type": "number"
},
"influencer_field_name": {
"description": "The field name of the influencer.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"influencer_field_value": {
"description": "The entity that influenced, contributed to, or was to blame for the anomaly.",
"type": "string"
},
"initial_influencer_score": {
"description": "A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors.\nThis is the initial value that was calculated at the time the bucket was processed.",
"type": "number"
},
"is_interim": {
"description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.",
"type": "boolean"
},
"job_id": {
"description": "Identifier for the anomaly detection job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"probability": {
"description": "The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high\nprecision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly\ninterpretation of this value.",
"type": "number"
},
"result_type": {
"description": "Internal. This value is always set to `influencer`.",
"type": "string"
},
"timestamp": {
"description": "The start time of the bucket for which these results were calculated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"foo": {
"description": "Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s\nanalyzing `user_name` as an influencer, a field `user_name` is added to the result document. This\ninformation enables you to filter the anomaly results more easily.",
"type": "string"
}
},
"required": [
"bucket_span",
"influencer_score",
"influencer_field_name",
"influencer_field_value",
"initial_influencer_score",
"is_interim",
"job_id",
"probability",
"result_type",
"timestamp"
]
},
"ml._types.JobStats": {
"type": "object",
"properties": {
"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_counts": {
"description": "An object that describes the quantity of input to the job and any related error counts.\nThe `data_count` values are cumulative for the lifetime of a job.\nIf a model snapshot is reverted or old results are deleted, the job counts are not reset.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataCounts"
}
]
},
"forecasts_stats": {
"description": "An object that provides statistical information about forecasts belonging to this job.\nSome statistics are omitted if no forecasts have been made.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobForecastStatistics"
}
]
},
"job_id": {
"description": "Identifier for the anomaly detection job.",
"type": "string"
},
"model_size_stats": {
"description": "An object that provides information about the size and contents of the model.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ModelSizeStats"
}
]
},
"node": {
"description": "Contains properties for the node that runs the job.\nThis information is available only for open jobs.",
"x-state": "Generally available",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DiscoveryNodeCompact"
}
]
},
"open_time": {
"description": "For open jobs only, the elapsed time for which the job has been open.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"state": {
"description": "The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`.\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"
}
]
},
"timing_stats": {
"description": "An object that provides statistical information about timing aspect of this job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobTimingStats"
}
]
},
"deleting": {
"description": "Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`.",
"type": "boolean"
}
},
"required": [
"data_counts",
"forecasts_stats",
"job_id",
"model_size_stats",
"state",
"timing_stats"
]
},
"ml._types.DataCounts": {
"type": "object",
"properties": {
"bucket_count": {
"type": "number"
},
"earliest_record_timestamp": {
"type": "number"
},
"empty_bucket_count": {
"type": "number"
},
"input_bytes": {
"type": "number"
},
"input_field_count": {
"type": "number"
},
"input_record_count": {
"type": "number"
},
"invalid_date_count": {
"type": "number"
},
"job_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"last_data_time": {
"type": "number"
},
"latest_empty_bucket_timestamp": {
"type": "number"
},
"latest_record_timestamp": {
"type": "number"
},
"latest_sparse_bucket_timestamp": {
"type": "number"
},
"latest_bucket_timestamp": {
"type": "number"
},
"log_time": {
"type": "number"
},
"missing_field_count": {
"type": "number"
},
"out_of_order_timestamp_count": {
"type": "number"
},
"processed_field_count": {
"type": "number"
},
"processed_record_count": {
"type": "number"
},
"sparse_bucket_count": {
"type": "number"
}
},
"required": [
"bucket_count",
"empty_bucket_count",
"input_bytes",
"input_field_count",
"input_record_count",
"invalid_date_count",
"job_id",
"missing_field_count",
"out_of_order_timestamp_count",
"processed_field_count",
"processed_record_count",
"sparse_bucket_count"
]
},
"ml._types.JobForecastStatistics": {
"type": "object",
"properties": {
"memory_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
},
"processing_time_ms": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
},
"records": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
},
"status": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"total": {
"type": "number"
},
"forecasted_jobs": {
"type": "number"
}
},
"required": [
"total",
"forecasted_jobs"
]
},
"ml._types.JobStatistics": {
"type": "object",
"properties": {
"avg": {
"type": "number"
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"total": {
"type": "number"
}
},
"required": [
"avg",
"max",
"min",
"total"
]
},
"ml._types.ModelSizeStats": {
"type": "object",
"properties": {
"bucket_allocation_failures_count": {
"type": "number"
},
"job_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"log_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"memory_status": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.MemoryStatus"
}
]
},
"model_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"model_bytes_exceeded": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"model_bytes_memory_limit": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"output_memory_allocator_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"peak_model_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"assignment_memory_basis": {
"type": "string"
},
"result_type": {
"type": "string"
},
"total_by_field_count": {
"type": "number"
},
"total_over_field_count": {
"type": "number"
},
"total_partition_field_count": {
"type": "number"
},
"categorization_status": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CategorizationStatus"
}
]
},
"categorized_doc_count": {
"type": "number"
},
"dead_category_count": {
"type": "number"
},
"failed_category_count": {
"type": "number"
},
"frequent_category_count": {
"type": "number"
},
"rare_category_count": {
"type": "number"
},
"total_category_count": {
"type": "number"
},
"timestamp": {
"type": "number"
}
},
"required": [
"bucket_allocation_failures_count",
"job_id",
"log_time",
"memory_status",
"model_bytes",
"result_type",
"total_by_field_count",
"total_over_field_count",
"total_partition_field_count",
"categorization_status",
"categorized_doc_count",
"dead_category_count",
"failed_category_count",
"frequent_category_count",
"rare_category_count",
"total_category_count"
]
},
"ml._types.JobTimingStats": {
"type": "object",
"properties": {
"average_bucket_processing_time_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"bucket_count": {
"type": "number"
},
"exponential_average_bucket_processing_time_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"exponential_average_bucket_processing_time_per_hour_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"job_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"total_bucket_processing_time_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"maximum_bucket_processing_time_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"minimum_bucket_processing_time_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
}
},
"required": [
"bucket_count",
"exponential_average_bucket_processing_time_per_hour_ms",
"job_id",
"total_bucket_processing_time_ms"
]
},
"ml._types.Job": {
"type": "object",
"properties": {
"allow_lazy_open": {
"description": "Advanced configuration option.\nSpecifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.",
"type": "boolean"
},
"analysis_config": {
"description": "The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.AnalysisConfig"
}
]
},
"analysis_limits": {
"description": "Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.AnalysisLimits"
}
]
},
"background_persist_interval": {
"description": "Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"blocked": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobBlocked"
}
]
},
"create_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"custom_settings": {
"description": "Advanced configuration option.\nContains custom metadata about the job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CustomSettings"
}
]
},
"daily_model_snapshot_retention_after_days": {
"description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nValid values range from 0 to `model_snapshot_retention_days`.",
"default": 1,
"type": "number"
},
"data_description": {
"description": "The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configuring a datafeed, these properties are automatically set.\nWhen data is received via the post data API, it is not stored in Elasticsearch.\nOnly the results for anomaly detection are retained.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataDescription"
}
]
},
"datafeed_config": {
"description": "The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Datafeed"
}
]
},
"deleting": {
"description": "Indicates that the process of deleting the job is in progress but not yet completed.\nIt is only reported when `true`.",
"type": "boolean"
},
"description": {
"description": "A description of the job.",
"type": "string"
},
"finished_time": {
"description": "If the job closed or failed, this is the time the job finished, otherwise it is `null`.\nThis property is informational; you cannot change its value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"groups": {
"description": "A list of job groups.\nA job can belong to no groups or many.",
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"description": "Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"job_type": {
"description": "Reserved for future use, currently set to `anomaly_detector`.",
"type": "string"
},
"job_version": {
"description": "The machine learning configuration version number at which the the job was created.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"model_plot_config": {
"description": "This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ModelPlotConfig"
}
]
},
"model_snapshot_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"model_snapshot_retention_days": {
"description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nBy default, snapshots ten days older than the newest snapshot are deleted.",
"type": "number"
},
"renormalization_window_days": {
"description": "Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`.",
"type": "number"
},
"results_index_name": {
"description": "A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"results_retention_days": {
"description": "Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever.",
"type": "number"
}
},
"required": [
"allow_lazy_open",
"analysis_config",
"data_description",
"job_id",
"model_snapshot_retention_days",
"results_index_name"
]
},
"ml._types.AnalysisLimits": {
"type": "object",
"properties": {
"categorization_examples_limit": {
"description": "The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization.",
"default": 4,
"type": "number"
},
"model_memory_limit": {
"description": "The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value.",
"default": "1024mb",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
}
},
"ml._types.JobBlocked": {
"type": "object",
"properties": {
"reason": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobBlockedReason"
}
]
},
"task_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TaskId"
}
]
}
},
"required": [
"reason"
]
},
"ml._types.JobBlockedReason": {
"type": "string",
"enum": [
"delete",
"reset",
"revert"
]
},
"ml._types.CustomSettings": {
"description": "Custom metadata about the job",
"type": "object"
},
"ml._types.DataDescription": {
"type": "object",
"properties": {
"format": {
"description": "Only JSON format is supported at this time.",
"type": "string"
},
"time_field": {
"description": "The name of the field that contains the timestamp.",
"default": "time",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"time_format": {
"description": "The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.",
"default": "epoch",
"type": "string"
},
"field_delimiter": {
"type": "string"
}
}
},
"ml._types.ModelPlotConfig": {
"type": "object",
"properties": {
"annotations_enabled": {
"description": "If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.",
"default": true,
"x-state": "Generally available; Added in 7.9.0",
"type": "boolean"
},
"enabled": {
"description": "If true, enables calculation and storage of the model bounds for each entity that is being analyzed.",
"default": false,
"type": "boolean"
},
"terms": {
"description": "Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer.",
"x-state": "Generally available; Added in 7.9.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
}
},
"ml.get_memory_stats.Memory": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"jvm": {
"description": "Contains Java Virtual Machine (JVM) statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/ml.get_memory_stats.JvmStats"
}
]
},
"mem": {
"description": "Contains statistics about memory usage for the node.",
"allOf": [
{
"$ref": "#/components/schemas/ml.get_memory_stats.MemStats"
}
]
},
"name": {
"description": "Human-readable identifier for the node. Based on the Node name setting setting.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"roles": {
"description": "Roles assigned to the node.",
"type": "array",
"items": {
"type": "string"
}
},
"transport_address": {
"description": "The host and port where transport HTTP connections are accepted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"ephemeral_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
},
"required": [
"attributes",
"jvm",
"mem",
"name",
"roles",
"transport_address",
"ephemeral_id"
]
},
"ml.get_memory_stats.JvmStats": {
"type": "object",
"properties": {
"heap_max": {
"description": "Maximum amount of memory available for use by the heap.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"heap_max_in_bytes": {
"description": "Maximum amount of memory, in bytes, available for use by the heap.",
"type": "number"
},
"java_inference": {
"description": "Amount of Java heap currently being used for caching inference models.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"java_inference_in_bytes": {
"description": "Amount of Java heap, in bytes, currently being used for caching inference models.",
"type": "number"
},
"java_inference_max": {
"description": "Maximum amount of Java heap to be used for caching inference models.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"java_inference_max_in_bytes": {
"description": "Maximum amount of Java heap, in bytes, to be used for caching inference models.",
"type": "number"
}
},
"required": [
"heap_max_in_bytes",
"java_inference_in_bytes",
"java_inference_max_in_bytes"
]
},
"ml.get_memory_stats.MemStats": {
"type": "object",
"properties": {
"adjusted_total": {
"description": "If the amount of physical memory has been overridden using the es.total_memory_bytes system property\nthen this reports the overridden value. Otherwise it reports the same value as total.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"adjusted_total_in_bytes": {
"description": "If the amount of physical memory has been overridden using the `es.total_memory_bytes` system property\nthen this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`.",
"type": "number"
},
"total": {
"description": "Total amount of physical memory.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_in_bytes": {
"description": "Total amount of physical memory in bytes.",
"type": "number"
},
"ml": {
"description": "Contains statistics about machine learning use of native memory on the node.",
"allOf": [
{
"$ref": "#/components/schemas/ml.get_memory_stats.MemMlStats"
}
]
}
},
"required": [
"adjusted_total_in_bytes",
"total_in_bytes",
"ml"
]
},
"ml.get_memory_stats.MemMlStats": {
"type": "object",
"properties": {
"anomaly_detectors": {
"description": "Amount of native memory set aside for anomaly detection jobs.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"anomaly_detectors_in_bytes": {
"description": "Amount of native memory, in bytes, set aside for anomaly detection jobs.",
"type": "number"
},
"data_frame_analytics": {
"description": "Amount of native memory set aside for data frame analytics jobs.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"data_frame_analytics_in_bytes": {
"description": "Amount of native memory, in bytes, set aside for data frame analytics jobs.",
"type": "number"
},
"max": {
"description": "Maximum amount of native memory (separate to the JVM heap) that may be used by machine learning native processes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_in_bytes": {
"description": "Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes.",
"type": "number"
},
"native_code_overhead": {
"description": "Amount of native memory set aside for loading machine learning native code shared libraries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"native_code_overhead_in_bytes": {
"description": "Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries.",
"type": "number"
},
"native_inference": {
"description": "Amount of native memory set aside for trained models that have a PyTorch model_type.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"native_inference_in_bytes": {
"description": "Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type.",
"type": "number"
}
},
"required": [
"anomaly_detectors_in_bytes",
"data_frame_analytics_in_bytes",
"max_in_bytes",
"native_code_overhead_in_bytes",
"native_inference_in_bytes"
]
},
"ml._types.ModelSnapshotUpgrade": {
"type": "object",
"properties": {
"job_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"snapshot_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.SnapshotUpgradeState"
}
]
},
"node": {
"x-state": "Generally available",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DiscoveryNode"
}
]
},
"assignment_explanation": {
"type": "string"
}
},
"required": [
"job_id",
"snapshot_id",
"state",
"node",
"assignment_explanation"
]
},
"ml._types.SnapshotUpgradeState": {
"type": "string",
"enum": [
"loading_old_state",
"saving_new_state",
"stopped",
"failed"
]
},
"ml._types.DiscoveryNode": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ml._types.DiscoveryNodeContent"
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.DiscoveryNodeContent": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"ephemeral_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"transport_address": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"external_id": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"min_index_version": {
"type": "number"
},
"max_index_version": {
"type": "number"
}
},
"required": [
"ephemeral_id",
"transport_address",
"external_id",
"attributes",
"roles",
"version",
"min_index_version",
"max_index_version"
]
},
"ml._types.ModelSnapshot": {
"type": "object",
"properties": {
"description": {
"description": "An optional description of the job.",
"type": "string"
},
"job_id": {
"description": "A numerical character string that uniquely identifies the job that the snapshot was created for.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"latest_record_time_stamp": {
"description": "The timestamp of the latest processed record.",
"type": "number"
},
"latest_result_time_stamp": {
"description": "The timestamp of the latest bucket result.",
"type": "number"
},
"min_version": {
"description": "The minimum version required to be able to restore the model snapshot.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"model_size_stats": {
"description": "Summary information describing the model.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ModelSizeStats"
}
]
},
"retain": {
"description": "If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false.",
"type": "boolean"
},
"snapshot_doc_count": {
"description": "For internal use only.",
"type": "number"
},
"snapshot_id": {
"description": "A numerical character string that uniquely identifies the model snapshot.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"timestamp": {
"description": "The creation timestamp for the snapshot.",
"type": "number"
}
},
"required": [
"job_id",
"min_version",
"retain",
"snapshot_doc_count",
"snapshot_id",
"timestamp"
]
},
"ml._types.OverallBucket": {
"type": "object",
"properties": {
"bucket_span": {
"description": "The length of the bucket in seconds. Matches the job with the longest bucket_span value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitSeconds"
}
]
},
"is_interim": {
"description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.",
"type": "boolean"
},
"jobs": {
"description": "An array of objects that contain the max_anomaly_score per job_id.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.OverallBucketJob"
}
},
"overall_score": {
"description": "The top_n average of the maximum bucket anomaly_score per job.",
"type": "number"
},
"result_type": {
"description": "Internal. This is always set to overall_bucket.",
"type": "string"
},
"timestamp": {
"description": "The start time of the bucket for which these results were calculated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"timestamp_string": {
"description": "The start time of the bucket for which these results were calculated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"bucket_span",
"is_interim",
"jobs",
"overall_score",
"result_type",
"timestamp"
]
},
"ml._types.OverallBucketJob": {
"type": "object",
"properties": {
"job_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"max_anomaly_score": {
"type": "number"
}
},
"required": [
"job_id",
"max_anomaly_score"
]
},
"ml._types.Anomaly": {
"type": "object",
"properties": {
"actual": {
"description": "The actual value for the bucket.",
"type": "array",
"items": {
"type": "number"
}
},
"anomaly_score_explanation": {
"description": "Information about the factors impacting the initial anomaly score.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.AnomalyExplanation"
}
]
},
"bucket_span": {
"description": "The length of the bucket in seconds. This value matches the `bucket_span` that is specified in the job.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitSeconds"
}
]
},
"by_field_name": {
"description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.",
"type": "string"
},
"by_field_value": {
"description": "The value of `by_field_name`.",
"type": "string"
},
"causes": {
"description": "For population analysis, an over field must be specified in the detector. This property contains an array of anomaly records that are the causes for the anomaly that has been identified for the over field. This sub-resource contains the most anomalous records for the `over_field_name`. For scalability reasons, a maximum of the 10 most significant causes of the anomaly are returned. As part of the core analytical modeling, these low-level anomaly records are aggregated for their parent over field record. The `causes` resource contains similar elements to the record resource, namely `actual`, `typical`, `geo_results.actual_point`, `geo_results.typical_point`, `*_field_name` and `*_field_value`. Probability and scores are not applicable to causes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.AnomalyCause"
}
},
"detector_index": {
"description": "A unique identifier for the detector.",
"type": "number"
},
"field_name": {
"description": "Certain functions require a field to operate on, for example, `sum()`. For those functions, this value is the name of the field to be analyzed.",
"type": "string"
},
"function": {
"description": "The function in which the anomaly occurs, as specified in the detector configuration. For example, `max`.",
"type": "string"
},
"function_description": {
"description": "The description of the function in which the anomaly occurs, as specified in the detector configuration.",
"type": "string"
},
"geo_results": {
"description": "If the detector function is `lat_long`, this object contains comma delimited strings for the latitude and longitude of the actual and typical values.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.GeoResults"
}
]
},
"influencers": {
"description": "If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Influence"
}
},
"initial_record_score": {
"description": "A normalized score between 0-100, which is based on the probability of the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed.",
"type": "number"
},
"is_interim": {
"description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.",
"type": "boolean"
},
"job_id": {
"description": "Identifier for the anomaly detection job.",
"type": "string"
},
"over_field_name": {
"description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.",
"type": "string"
},
"over_field_value": {
"description": "The value of `over_field_name`.",
"type": "string"
},
"partition_field_name": {
"description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.",
"type": "string"
},
"partition_field_value": {
"description": "The value of `partition_field_name`.",
"type": "string"
},
"probability": {
"description": "The probability of the individual anomaly occurring, in the range 0 to 1. For example, `0.0000772031`. This value can be held to a high precision of over 300 decimal places, so the `record_score` is provided as a human-readable and friendly interpretation of this.",
"type": "number"
},
"record_score": {
"description": "A normalized score between 0-100, which is based on the probability of the anomalousness of this record. Unlike `initial_record_score`, this value will be updated by a re-normalization process as new data is analyzed.",
"type": "number"
},
"result_type": {
"description": "Internal. This is always set to `record`.",
"type": "string"
},
"timestamp": {
"description": "The start time of the bucket for which these results were calculated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"typical": {
"description": "The typical value for the bucket, according to analytical modeling.",
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"bucket_span",
"detector_index",
"initial_record_score",
"is_interim",
"job_id",
"probability",
"record_score",
"result_type",
"timestamp"
]
},
"ml._types.AnomalyExplanation": {
"type": "object",
"properties": {
"anomaly_characteristics_impact": {
"description": "Impact from the duration and magnitude of the detected anomaly relative to the historical average.",
"type": "number"
},
"anomaly_length": {
"description": "Length of the detected anomaly in the number of buckets.",
"type": "number"
},
"anomaly_type": {
"description": "Type of the detected anomaly: `spike` or `dip`.",
"type": "string"
},
"high_variance_penalty": {
"description": "Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced.",
"type": "boolean"
},
"incomplete_bucket_penalty": {
"description": "If the bucket contains fewer samples than expected, the score is reduced.",
"type": "boolean"
},
"lower_confidence_bound": {
"description": "Lower bound of the 95% confidence interval.",
"type": "number"
},
"multi_bucket_impact": {
"description": "Impact of the deviation between actual and typical values in the past 12 buckets.",
"type": "number"
},
"single_bucket_impact": {
"description": "Impact of the deviation between actual and typical values in the current bucket.",
"type": "number"
},
"typical_value": {
"description": "Typical (expected) value for this bucket.",
"type": "number"
},
"upper_confidence_bound": {
"description": "Upper bound of the 95% confidence interval.",
"type": "number"
}
}
},
"ml._types.AnomalyCause": {
"type": "object",
"properties": {
"actual": {
"type": "array",
"items": {
"type": "number"
}
},
"by_field_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"by_field_value": {
"type": "string"
},
"correlated_by_field_value": {
"type": "string"
},
"field_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"function": {
"type": "string"
},
"function_description": {
"type": "string"
},
"geo_results": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.GeoResults"
}
]
},
"influencers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Influence"
}
},
"over_field_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"over_field_value": {
"type": "string"
},
"partition_field_name": {
"type": "string"
},
"partition_field_value": {
"type": "string"
},
"probability": {
"type": "number"
},
"typical": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"probability"
]
},
"ml._types.GeoResults": {
"type": "object",
"properties": {
"actual_point": {
"description": "The actual value for the bucket formatted as a `geo_point`.",
"type": "string"
},
"typical_point": {
"description": "The typical value for the bucket formatted as a `geo_point`.",
"type": "string"
}
}
},
"ml._types.Influence": {
"type": "object",
"properties": {
"influencer_field_name": {
"type": "string"
},
"influencer_field_values": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"influencer_field_name",
"influencer_field_values"
]
},
"ml._types.Include": {
"type": "string",
"enum": [
"definition",
"feature_importance_baseline",
"hyperparameters",
"total_feature_importance",
"definition_status"
]
},
"ml._types.TrainedModelConfig": {
"type": "object",
"properties": {
"model_id": {
"description": "Identifier for the trained model.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"model_type": {
"description": "The model type\n\nSupported values include:\n - `tree_ensemble`: The model definition is an ensemble model of decision trees.\n - `lang_ident`: A special type reserved for language identification models.\n - `pytorch`: The stored definition is a PyTorch (specifically a TorchScript) model.\nCurrently only NLP models are supported.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelType"
}
]
},
"tags": {
"description": "A comma delimited string of tags. A trained model can have many tags, or none.",
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"description": "The Elasticsearch version number in which the trained model was created.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"compressed_definition": {
"type": "string"
},
"created_by": {
"description": "Information on the creator of the trained model.",
"type": "string"
},
"create_time": {
"description": "The time when the trained model was created.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"default_field_map": {
"description": "Any field map described in the inference configuration takes precedence.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"description": {
"description": "The free-text description of the trained model.",
"type": "string"
},
"estimated_heap_memory_usage_bytes": {
"description": "The estimated heap usage in bytes to keep the trained model in memory.",
"type": "number"
},
"estimated_operations": {
"description": "The estimated number of operations to use the trained model.",
"type": "number"
},
"fully_defined": {
"description": "True if the full model definition is present.",
"type": "boolean"
},
"inference_config": {
"description": "The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer"
}
]
},
"input": {
"description": "The input field names for the model definition.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelConfigInput"
}
]
},
"license_level": {
"description": "The license level of the trained model.",
"type": "string"
},
"metadata": {
"description": "An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelConfigMetadata"
}
]
},
"model_size_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"model_package": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ModelPackageConfig"
}
]
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelLocation"
}
]
},
"platform_architecture": {
"type": "string"
},
"prefix_strings": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings"
}
]
}
},
"required": [
"model_id",
"tags",
"input"
]
},
"ml._types.TrainedModelType": {
"type": "string",
"enum": [
"tree_ensemble",
"lang_ident",
"pytorch"
]
},
"ml._types.InferenceConfigCreateContainer": {
"description": "Inference configuration provided when storing the model config",
"type": "object",
"properties": {
"regression": {
"description": "Regression configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.RegressionInferenceOptions"
}
]
},
"classification": {
"description": "Classification configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions"
}
]
},
"text_classification": {
"description": "Text classification configuration for inference.",
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TextClassificationInferenceOptions"
}
]
},
"zero_shot_classification": {
"description": "Zeroshot classification configuration for inference.",
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceOptions"
}
]
},
"fill_mask": {
"description": "Fill mask configuration for inference.",
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.FillMaskInferenceOptions"
}
]
},
"learning_to_rank": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.LearningToRankConfig"
}
]
},
"ner": {
"description": "Named entity recognition configuration for inference.",
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NerInferenceOptions"
}
]
},
"pass_through": {
"description": "Pass through configuration for inference.",
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.PassThroughInferenceOptions"
}
]
},
"text_embedding": {
"description": "Text embedding configuration for inference.",
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceOptions"
}
]
},
"text_expansion": {
"description": "Text expansion configuration for inference.",
"x-state": "Generally available; Added in 8.8.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TextExpansionInferenceOptions"
}
]
},
"question_answering": {
"description": "Question answering configuration for inference.",
"x-state": "Generally available; Added in 8.3.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceOptions"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.TextClassificationInferenceOptions": {
"description": "Text classification configuration options",
"type": "object",
"properties": {
"num_top_classes": {
"description": "Specifies the number of top class predictions to return. Defaults to 0.",
"type": "number"
},
"tokenization": {
"description": "The tokenization options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"classification_labels": {
"description": "Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels",
"type": "array",
"items": {
"type": "string"
}
},
"vocabulary": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Vocabulary"
}
]
}
}
},
"ml._types.TokenizationConfigContainer": {
"description": "Tokenization options stored in inference configuration",
"type": "object",
"properties": {
"bert": {
"description": "Indicates BERT tokenization and its options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig"
}
]
},
"bert_ja": {
"description": "Indicates BERT Japanese tokenization and its options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig"
}
]
},
"mpnet": {
"description": "Indicates MPNET tokenization and its options",
"x-state": "Generally available; Added in 8.1.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig"
}
]
},
"roberta": {
"description": "Indicates RoBERTa tokenization and its options",
"x-state": "Generally available; Added in 8.2.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpRobertaTokenizationConfig"
}
]
},
"xlm_roberta": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.XlmRobertaTokenizationConfig"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.NlpBertTokenizationConfig": {
"description": "BERT and MPNet tokenization configuration options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CommonTokenizationConfig"
},
{
"type": "object"
}
]
},
"ml._types.CommonTokenizationConfig": {
"type": "object",
"properties": {
"do_lower_case": {
"description": "Should the tokenizer lower case the text",
"default": false,
"type": "boolean"
},
"max_sequence_length": {
"description": "Maximum input sequence length for the model",
"default": 512,
"type": "number"
},
"span": {
"description": "Tokenization spanning options. Special value of -1 indicates no spanning takes place",
"default": -1,
"type": "number"
},
"truncate": {
"description": "Should tokenization input be automatically truncated before sending to the model for inference",
"default": "first",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationTruncate"
}
]
},
"with_special_tokens": {
"description": "Is tokenization completed with special tokens",
"default": true,
"type": "boolean"
}
}
},
"ml._types.TokenizationTruncate": {
"type": "string",
"enum": [
"first",
"second",
"none"
]
},
"ml._types.NlpRobertaTokenizationConfig": {
"description": "RoBERTa tokenization configuration options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CommonTokenizationConfig"
},
{
"type": "object",
"properties": {
"add_prefix_space": {
"description": "Should the tokenizer prefix input with a space character",
"default": false,
"type": "boolean"
}
}
}
]
},
"ml._types.XlmRobertaTokenizationConfig": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CommonTokenizationConfig"
},
{
"type": "object"
}
]
},
"ml._types.Vocabulary": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"index"
]
},
"ml._types.ZeroShotClassificationInferenceOptions": {
"description": "Zero shot classification configuration options",
"type": "object",
"properties": {
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
}
]
},
"hypothesis_template": {
"description": "Hypothesis template used when tokenizing labels for prediction",
"default": "\"This example is {}.\"",
"type": "string"
},
"classification_labels": {
"description": "The zero shot classification labels indicating entailment, neutral, and contradiction\nMust contain exactly and only entailment, neutral, and contradiction",
"type": "array",
"items": {
"type": "string"
}
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"multi_label": {
"description": "Indicates if more than one true label exists.",
"default": false,
"type": "boolean"
},
"labels": {
"description": "The labels to predict.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"classification_labels"
]
},
"ml._types.FillMaskInferenceOptions": {
"description": "Fill mask inference options",
"type": "object",
"properties": {
"mask_token": {
"description": "The string/token which will be removed from incoming documents and replaced with the inference prediction(s).\nIn a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer\nhas a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.\nHowever, if this field is present in a request, its value must match the predefined value for that model/tokenizer,\notherwise the request will fail.",
"type": "string"
},
"num_top_classes": {
"description": "Specifies the number of top class predictions to return. Defaults to 0.",
"type": "number"
},
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"vocabulary": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Vocabulary"
}
]
}
}
},
"ml._types.LearningToRankConfig": {
"type": "object",
"properties": {
"default_params": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"feature_extractors": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ml._types.FeatureExtractor"
}
}
},
"num_top_feature_importance_values": {
"type": "number"
}
},
"required": [
"num_top_feature_importance_values"
]
},
"ml._types.FeatureExtractor": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.QueryFeatureExtractor"
}
]
},
"ml._types.QueryFeatureExtractor": {
"type": "object",
"properties": {
"default_score": {
"type": "number"
},
"feature_name": {
"type": "string"
},
"query": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"feature_name",
"query"
]
},
"ml._types.NerInferenceOptions": {
"description": "Named entity recognition options",
"type": "object",
"properties": {
"tokenization": {
"description": "The tokenization options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"classification_labels": {
"description": "The token classification labels. Must be IOB formatted tags",
"type": "array",
"items": {
"type": "string"
}
},
"vocabulary": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Vocabulary"
}
]
}
}
},
"ml._types.PassThroughInferenceOptions": {
"description": "Pass through configuration options",
"type": "object",
"properties": {
"tokenization": {
"description": "The tokenization options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"vocabulary": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Vocabulary"
}
]
}
}
},
"ml._types.TextEmbeddingInferenceOptions": {
"description": "Text embedding inference options",
"type": "object",
"properties": {
"embedding_size": {
"description": "The number of dimensions in the embedding output",
"type": "number"
},
"tokenization": {
"description": "The tokenization options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"vocabulary": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Vocabulary"
}
]
}
}
},
"ml._types.TextExpansionInferenceOptions": {
"description": "Text expansion inference options",
"type": "object",
"properties": {
"tokenization": {
"description": "The tokenization options",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"vocabulary": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Vocabulary"
}
]
}
}
},
"ml._types.QuestionAnsweringInferenceOptions": {
"description": "Question answering inference options",
"type": "object",
"properties": {
"num_top_classes": {
"description": "Specifies the number of top class predictions to return. Defaults to 0.",
"type": "number"
},
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"max_answer_length": {
"description": "The maximum answer length to consider",
"type": "number"
}
}
},
"ml._types.TrainedModelConfigInput": {
"type": "object",
"properties": {
"field_names": {
"description": "An array of input field names for the model.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
}
},
"required": [
"field_names"
]
},
"ml._types.TrainedModelConfigMetadata": {
"type": "object",
"properties": {
"model_aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"feature_importance_baseline": {
"description": "An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"hyperparameters": {
"description": "List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Hyperparameter"
}
},
"total_feature_importance": {
"description": "An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TotalFeatureImportance"
}
}
}
},
"ml._types.Hyperparameter": {
"type": "object",
"properties": {
"absolute_importance": {
"description": "A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.",
"type": "number"
},
"name": {
"description": "Name of the hyperparameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"relative_importance": {
"description": "A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.",
"type": "number"
},
"supplied": {
"description": "Indicates if the hyperparameter is specified by the user (true) or optimized (false).",
"type": "boolean"
},
"value": {
"description": "The value of the hyperparameter, either optimized or specified by the user.",
"type": "number"
}
},
"required": [
"name",
"supplied",
"value"
]
},
"ml._types.TotalFeatureImportance": {
"type": "object",
"properties": {
"feature_name": {
"description": "The feature for which this importance was calculated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"importance": {
"description": "A collection of feature importance statistics related to the training data set for this particular feature.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TotalFeatureImportanceStatistics"
}
},
"classes": {
"description": "If the trained model is a classification model, feature importance statistics are gathered per target class value.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TotalFeatureImportanceClass"
}
}
},
"required": [
"feature_name",
"importance",
"classes"
]
},
"ml._types.TotalFeatureImportanceStatistics": {
"type": "object",
"properties": {
"mean_magnitude": {
"description": "The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.",
"type": "number"
},
"max": {
"description": "The maximum importance value across all the training data for this feature.",
"type": "number"
},
"min": {
"description": "The minimum importance value across all the training data for this feature.",
"type": "number"
}
},
"required": [
"mean_magnitude",
"max",
"min"
]
},
"ml._types.TotalFeatureImportanceClass": {
"type": "object",
"properties": {
"class_name": {
"description": "The target class value. Could be a string, boolean, or number.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"importance": {
"description": "A collection of feature importance statistics related to the training data set for this particular feature.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TotalFeatureImportanceStatistics"
}
}
},
"required": [
"class_name",
"importance"
]
},
"ml._types.ModelPackageConfig": {
"type": "object",
"properties": {
"create_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"description": {
"type": "string"
},
"inference_config": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"minimum_version": {
"type": "string"
},
"model_repository": {
"type": "string"
},
"model_type": {
"type": "string"
},
"packaged_model_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"platform_architecture": {
"type": "string"
},
"prefix_strings": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings"
}
]
},
"size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"sha256": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"vocabulary_file": {
"type": "string"
}
},
"required": [
"packaged_model_id"
]
},
"ml._types.TrainedModelPrefixStrings": {
"type": "object",
"properties": {
"ingest": {
"description": "String prepended to input at ingest",
"type": "string"
},
"search": {
"description": "String prepended to input at search",
"type": "string"
}
}
},
"ml._types.TrainedModelLocation": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelLocationIndex"
}
]
}
},
"required": [
"index"
]
},
"ml._types.TrainedModelLocationIndex": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"name"
]
},
"ml._types.TrainedModelStats": {
"type": "object",
"properties": {
"deployment_stats": {
"description": "A collection of deployment stats, which is present when the models are deployed.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelDeploymentStats"
}
]
},
"inference_stats": {
"description": "A collection of inference stats fields.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelInferenceStats"
}
]
},
"ingest": {
"description": "A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"model_id": {
"description": "The unique identifier of the trained model.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"model_size_stats": {
"description": "A collection of model size stats.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelSizeStats"
}
]
},
"pipeline_count": {
"description": "The number of ingest pipelines that currently refer to the model.",
"type": "number"
}
},
"required": [
"model_id",
"model_size_stats",
"pipeline_count"
]
},
"ml._types.TrainedModelDeploymentStats": {
"type": "object",
"properties": {
"adaptive_allocations": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings"
}
]
},
"allocation_status": {
"description": "The detailed allocation status for the deployment.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelDeploymentAllocationStatus"
}
]
},
"cache_size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"deployment_id": {
"description": "The unique identifier for the trained model deployment.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"error_count": {
"description": "The sum of `error_count` for all nodes in the deployment.",
"type": "number"
},
"inference_count": {
"description": "The sum of `inference_count` for all nodes in the deployment.",
"type": "number"
},
"model_id": {
"description": "The unique identifier for the trained model.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"nodes": {
"description": "The deployment stats for each node that currently has the model allocated.\nIn serverless, stats are reported for a single unnamed virtual node.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TrainedModelDeploymentNodesStats"
}
},
"number_of_allocations": {
"description": "The number of allocations requested.",
"type": "number"
},
"peak_throughput_per_minute": {
"type": "number"
},
"priority": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainingPriority"
}
]
},
"queue_capacity": {
"description": "The number of inference requests that can be queued before new requests are rejected.",
"type": "number"
},
"rejected_execution_count": {
"description": "The sum of `rejected_execution_count` for all nodes in the deployment.\nIndividual nodes reject an inference request if the inference queue is full.\nThe queue size is controlled by the `queue_capacity` setting in the start\ntrained model deployment API.",
"type": "number"
},
"reason": {
"description": "The reason for the current deployment state. Usually only populated when\nthe model is not deployed to a node.",
"type": "string"
},
"start_time": {
"description": "The epoch timestamp when the deployment started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"state": {
"description": "The overall state of the deployment.\n\nSupported values include:\n - `started`: The deployment is usable; at least one node has the model allocated.\n - `starting`: The deployment has recently started but is not yet usable; the model is not allocated on any nodes.\n - `stopping`: The deployment is preparing to stop and deallocate the model from the relevant nodes.\n - `failed`: The deployment is on a failed state and must be re-deployed.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DeploymentAssignmentState"
}
]
},
"threads_per_allocation": {
"description": "The number of threads used be each allocation during inference.",
"type": "number"
},
"timeout_count": {
"description": "The sum of `timeout_count` for all nodes in the deployment.",
"type": "number"
}
},
"required": [
"deployment_id",
"model_id",
"nodes",
"peak_throughput_per_minute",
"priority",
"start_time"
]
},
"ml._types.AdaptiveAllocationsSettings": {
"type": "object",
"properties": {
"enabled": {
"description": "If true, adaptive_allocations is enabled",
"type": "boolean"
},
"min_number_of_allocations": {
"description": "Specifies the minimum number of allocations to scale to.\nIf set, it must be greater than or equal to 0.\nIf not defined, the deployment scales to 0.",
"type": "number"
},
"max_number_of_allocations": {
"description": "Specifies the maximum number of allocations to scale to.\nIf set, it must be greater than or equal to min_number_of_allocations.",
"type": "number"
}
},
"required": [
"enabled"
]
},
"ml._types.TrainedModelDeploymentAllocationStatus": {
"type": "object",
"properties": {
"allocation_count": {
"description": "The current number of nodes where the model is allocated.",
"type": "number"
},
"state": {
"description": "The detailed allocation state related to the nodes.\n\nSupported values include:\n - `started`: The trained model is started on at least one node.\n - `starting`: Trained model deployment is starting but it is not yet deployed on any nodes.\n - `fully_allocated`: Trained model deployment has started on all valid nodes.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DeploymentAllocationState"
}
]
},
"target_allocation_count": {
"description": "The desired number of nodes for model allocation.",
"type": "number"
}
},
"required": [
"allocation_count",
"state",
"target_allocation_count"
]
},
"ml._types.DeploymentAllocationState": {
"type": "string",
"enum": [
"started",
"starting",
"fully_allocated"
]
},
"ml._types.TrainedModelDeploymentNodesStats": {
"type": "object",
"properties": {
"average_inference_time_ms": {
"description": "The average time for each inference call to complete on this node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"average_inference_time_ms_last_minute": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"average_inference_time_ms_excluding_cache_hits": {
"description": "The average time for each inference call to complete on this node, excluding cache",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"average_inference_process_memory_rss_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"error_count": {
"description": "The number of errors when evaluating the trained model.",
"type": "number"
},
"inference_count": {
"description": "The total number of inference calls made against this node for this model.",
"type": "number"
},
"inference_cache_hit_count": {
"type": "number"
},
"inference_cache_hit_count_last_minute": {
"type": "number"
},
"last_access": {
"description": "The epoch time stamp of the last inference call for the model on this node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"node": {
"description": "Information pertaining to the node.",
"x-state": "Generally available",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DiscoveryNode"
}
]
},
"number_of_allocations": {
"description": "The number of allocations assigned to this node.",
"type": "number"
},
"number_of_pending_requests": {
"description": "The number of inference requests queued to be processed.",
"type": "number"
},
"peak_throughput_per_minute": {
"type": "number"
},
"rejected_execution_count": {
"description": "The number of inference requests that were not processed because the queue was full.",
"type": "number"
},
"routing_state": {
"description": "The current routing state and reason for the current routing state for this allocation.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelAssignmentRoutingStateAndReason"
}
]
},
"start_time": {
"description": "The epoch timestamp when the allocation started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"threads_per_allocation": {
"description": "The number of threads used by each allocation during inference.",
"type": "number"
},
"throughput_last_minute": {
"type": "number"
},
"timeout_count": {
"description": "The number of inference requests that timed out before being processed.",
"type": "number"
}
},
"required": [
"peak_throughput_per_minute",
"routing_state",
"throughput_last_minute"
]
},
"ml._types.TrainedModelAssignmentRoutingStateAndReason": {
"type": "object",
"properties": {
"reason": {
"description": "The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`.",
"type": "string"
},
"routing_state": {
"description": "The current routing state.\n\nSupported values include:\n - `failed`: The allocation attempt failed.\n - `started`: The trained model is allocated and ready to accept inference requests.\n - `starting`: The trained model is attempting to allocate on this node; inference requests are not yet accepted.\n - `stopped`: The trained model is fully deallocated from this node.\n - `stopping`: The trained model is being deallocated from this node.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.RoutingState"
}
]
}
},
"required": [
"routing_state"
]
},
"ml._types.RoutingState": {
"type": "string",
"enum": [
"failed",
"started",
"starting",
"stopped",
"stopping"
]
},
"ml._types.TrainingPriority": {
"type": "string",
"enum": [
"normal",
"low"
]
},
"ml._types.DeploymentAssignmentState": {
"type": "string",
"enum": [
"started",
"starting",
"stopping",
"failed"
]
},
"ml._types.TrainedModelInferenceStats": {
"type": "object",
"properties": {
"cache_miss_count": {
"description": "The number of times the model was loaded for inference and was not retrieved from the cache.\nIf this number is close to the `inference_count`, the cache is not being appropriately used.\nThis can be solved by increasing the cache size or its time-to-live (TTL).\nRefer to general machine learning settings for the appropriate settings.",
"type": "number"
},
"failure_count": {
"description": "The number of failures when using the model for inference.",
"type": "number"
},
"inference_count": {
"description": "The total number of times the model has been called for inference.\nThis is across all inference contexts, including all pipelines.",
"type": "number"
},
"missing_all_fields_count": {
"description": "The number of inference calls where all the training features for the model were missing.",
"type": "number"
},
"timestamp": {
"description": "The time when the statistics were last updated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"cache_miss_count",
"failure_count",
"inference_count",
"missing_all_fields_count",
"timestamp"
]
},
"ml._types.TrainedModelSizeStats": {
"type": "object",
"properties": {
"model_size_bytes": {
"description": "The size of the model in bytes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"required_native_memory_bytes": {
"description": "The amount of memory required to load the model in bytes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
},
"required": [
"model_size_bytes",
"required_native_memory_bytes"
]
},
"ml._types.InferenceConfigUpdateContainer": {
"type": "object",
"properties": {
"regression": {
"description": "Regression configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.RegressionInferenceOptions"
}
]
},
"classification": {
"description": "Classification configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions"
}
]
},
"text_classification": {
"description": "Text classification configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TextClassificationInferenceUpdateOptions"
}
]
},
"zero_shot_classification": {
"description": "Zeroshot classification configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceUpdateOptions"
}
]
},
"fill_mask": {
"description": "Fill mask configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.FillMaskInferenceUpdateOptions"
}
]
},
"ner": {
"description": "Named entity recognition configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NerInferenceUpdateOptions"
}
]
},
"pass_through": {
"description": "Pass through configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.PassThroughInferenceUpdateOptions"
}
]
},
"text_embedding": {
"description": "Text embedding configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceUpdateOptions"
}
]
},
"text_expansion": {
"description": "Text expansion configuration for inference.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TextExpansionInferenceUpdateOptions"
}
]
},
"question_answering": {
"description": "Question answering configuration for inference",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceUpdateOptions"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml._types.TextClassificationInferenceUpdateOptions": {
"type": "object",
"properties": {
"num_top_classes": {
"description": "Specifies the number of top class predictions to return. Defaults to 0.",
"type": "number"
},
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"classification_labels": {
"description": "Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ml._types.NlpTokenizationUpdateOptions": {
"type": "object",
"properties": {
"truncate": {
"description": "Truncate options to apply",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TokenizationTruncate"
}
]
},
"span": {
"description": "Span options to apply",
"type": "number"
}
}
},
"ml._types.ZeroShotClassificationInferenceUpdateOptions": {
"type": "object",
"properties": {
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"multi_label": {
"description": "Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value.",
"type": "boolean"
},
"labels": {
"description": "The labels to predict.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"labels"
]
},
"ml._types.FillMaskInferenceUpdateOptions": {
"type": "object",
"properties": {
"num_top_classes": {
"description": "Specifies the number of top class predictions to return. Defaults to 0.",
"type": "number"
},
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
}
}
},
"ml._types.NerInferenceUpdateOptions": {
"type": "object",
"properties": {
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
}
}
},
"ml._types.PassThroughInferenceUpdateOptions": {
"type": "object",
"properties": {
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
}
}
},
"ml._types.TextEmbeddingInferenceUpdateOptions": {
"type": "object",
"properties": {
"tokenization": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
}
}
},
"ml._types.TextExpansionInferenceUpdateOptions": {
"type": "object",
"properties": {
"tokenization": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
}
}
},
"ml._types.QuestionAnsweringInferenceUpdateOptions": {
"type": "object",
"properties": {
"question": {
"description": "The question to answer given the inference context",
"type": "string"
},
"num_top_classes": {
"description": "Specifies the number of top class predictions to return. Defaults to 0.",
"type": "number"
},
"tokenization": {
"description": "The tokenization options to update when inferring",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
}
]
},
"results_field": {
"description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
"type": "string"
},
"max_answer_length": {
"description": "The maximum answer length to consider for extraction",
"type": "number"
}
},
"required": [
"question"
]
},
"ml._types.InferenceResponseResult": {
"type": "object",
"properties": {
"entities": {
"description": "If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TrainedModelEntities"
}
},
"is_truncated": {
"description": "Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property\nis present only when it is true.",
"type": "boolean"
},
"predicted_value": {
"description": "If the model is trained for a text classification or zero shot classification task, the response is the\npredicted class.\nFor named entity recognition (NER) tasks, it contains the annotated text output.\nFor fill mask tasks, it contains the top prediction for replacing the mask token.\nFor text embedding tasks, it contains the raw numerical text embedding values.\nFor regression models, its a numerical value\nFor classification models, it may be an integer, double, boolean or string depending on prediction type",
"oneOf": [
{
"$ref": "#/components/schemas/ml._types.PredictedValue"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.PredictedValue"
}
}
]
},
"predicted_value_sequence": {
"description": "For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted\nvalue.\nAdditionally",
"type": "string"
},
"prediction_probability": {
"description": "Specifies a probability for the predicted value.",
"type": "number"
},
"prediction_score": {
"description": "Specifies a confidence score for the predicted value.",
"type": "number"
},
"top_classes": {
"description": "For fill mask, text classification, and zero shot classification tasks, the response contains a list of top\nclass entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TopClassEntry"
}
},
"warning": {
"description": "If the request failed, the response contains the reason for the failure.",
"type": "string"
},
"feature_importance": {
"description": "The feature importance for the inference results. Relevant only for classification or regression models",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TrainedModelInferenceFeatureImportance"
}
}
}
},
"ml._types.TrainedModelEntities": {
"type": "object",
"properties": {
"class_name": {
"type": "string"
},
"class_probability": {
"type": "number"
},
"entity": {
"type": "string"
},
"start_pos": {
"type": "number"
},
"end_pos": {
"type": "number"
}
},
"required": [
"class_name",
"class_probability",
"entity",
"start_pos",
"end_pos"
]
},
"ml._types.PredictedValue": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.ScalarValue"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ScalarValue"
}
}
]
},
"ml._types.TopClassEntry": {
"type": "object",
"properties": {
"class_name": {
"type": "string"
},
"class_probability": {
"type": "number"
},
"class_score": {
"type": "number"
}
},
"required": [
"class_name",
"class_probability",
"class_score"
]
},
"ml._types.TrainedModelInferenceFeatureImportance": {
"type": "object",
"properties": {
"feature_name": {
"type": "string"
},
"importance": {
"type": "number"
},
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TrainedModelInferenceClassImportance"
}
}
},
"required": [
"feature_name"
]
},
"ml._types.TrainedModelInferenceClassImportance": {
"type": "object",
"properties": {
"class_name": {
"type": "string"
},
"importance": {
"type": "number"
}
},
"required": [
"class_name",
"importance"
]
},
"ml.info.Defaults": {
"type": "object",
"properties": {
"anomaly_detectors": {
"allOf": [
{
"$ref": "#/components/schemas/ml.info.AnomalyDetectors"
}
]
},
"datafeeds": {
"allOf": [
{
"$ref": "#/components/schemas/ml.info.Datafeeds"
}
]
}
},
"required": [
"anomaly_detectors",
"datafeeds"
]
},
"ml.info.AnomalyDetectors": {
"type": "object",
"properties": {
"categorization_analyzer": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CategorizationAnalyzer"
}
]
},
"categorization_examples_limit": {
"type": "number"
},
"model_memory_limit": {
"type": "string"
},
"model_snapshot_retention_days": {
"type": "number"
},
"daily_model_snapshot_retention_after_days": {
"type": "number"
}
},
"required": [
"categorization_analyzer",
"categorization_examples_limit",
"model_memory_limit",
"model_snapshot_retention_days",
"daily_model_snapshot_retention_after_days"
]
},
"ml.info.Datafeeds": {
"type": "object",
"properties": {
"scroll_size": {
"type": "number"
}
},
"required": [
"scroll_size"
]
},
"ml.info.Limits": {
"type": "object",
"properties": {
"max_single_ml_node_processors": {
"type": "number"
},
"total_ml_processors": {
"type": "number"
},
"max_model_memory_limit": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"effective_max_model_memory_limit": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_ml_memory": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
},
"required": [
"total_ml_memory"
]
},
"ml.info.NativeCode": {
"type": "object",
"properties": {
"build_hash": {
"type": "string"
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
},
"required": [
"build_hash",
"version"
]
},
"ml.preview_data_frame_analytics.DataframePreviewConfig": {
"type": "object",
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource"
}
]
},
"analysis": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer"
}
]
},
"model_memory_limit": {
"type": "string"
},
"max_num_threads": {
"type": "number"
},
"analyzed_fields": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields"
}
]
}
},
"required": [
"source",
"analysis"
]
},
"ml._types.DatafeedConfig": {
"type": "object",
"properties": {
"aggregations": {
"description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"chunking_config": {
"description": "Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ChunkingConfig"
}
]
},
"datafeed_id": {
"description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"delayed_data_check_config": {
"description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig"
}
]
},
"frequency": {
"description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"indices": {
"description": "An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"indices_options": {
"description": "Specifies index expansion options that are used during search.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndicesOptions"
}
]
},
"job_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"max_empty_searches": {
"description": "If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped.",
"type": "number"
},
"query": {
"description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"query_delay": {
"description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"runtime_mappings": {
"description": "Specifies runtime fields for the datafeed search.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"script_fields": {
"description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ScriptField"
}
},
"scroll_size": {
"description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default.",
"default": 1000,
"type": "number"
}
}
},
"ml._types.JobConfig": {
"type": "object",
"properties": {
"allow_lazy_open": {
"description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.",
"default": false,
"type": "boolean"
},
"analysis_config": {
"description": "The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.AnalysisConfig"
}
]
},
"analysis_limits": {
"description": "Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.AnalysisLimits"
}
]
},
"background_persist_interval": {
"description": "Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"custom_settings": {
"description": "Advanced configuration option.\nContains custom metadata about the job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CustomSettings"
}
]
},
"daily_model_snapshot_retention_after_days": {
"description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.",
"default": 1,
"type": "number"
},
"data_description": {
"description": "The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configure a datafeed, these properties are automatically set.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataDescription"
}
]
},
"datafeed_config": {
"description": "The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DatafeedConfig"
}
]
},
"description": {
"description": "A description of the job.",
"type": "string"
},
"groups": {
"description": "A list of job groups. A job can belong to no groups or many.",
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"description": "Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"model_plot_config": {
"description": "This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ModelPlotConfig"
}
]
},
"model_snapshot_retention_days": {
"description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nThe default value is `10`, which means snapshots ten days older than the newest snapshot are deleted.",
"default": 10,
"type": "number"
},
"renormalization_window_days": {
"description": "Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`.",
"type": "number"
},
"results_index_name": {
"description": "A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`.",
"default": "shared",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"results_retention_days": {
"description": "Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever.",
"type": "number"
}
},
"required": [
"analysis_config",
"data_description"
]
},
"_types.HttpHeaders": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"ml._types.AnalysisConfigRead": {
"type": "object",
"properties": {
"bucket_span": {
"description": "The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation.",
"default": "5m",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"detectors": {
"description": "Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DetectorRead"
}
},
"influencers": {
"description": "A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"categorization_analyzer": {
"description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.CategorizationAnalyzer"
}
]
},
"categorization_field_name": {
"description": "If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"categorization_filters": {
"description": "If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same.",
"type": "array",
"items": {
"type": "string"
}
},
"latency": {
"description": "The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API.",
"default": "0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"model_prune_window": {
"description": "Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"multivariate_by_fields": {
"description": "This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector.",
"type": "boolean"
},
"per_partition_categorization": {
"description": "Settings related to how categorization interacts with partition fields.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.PerPartitionCategorization"
}
]
},
"summary_count_field_name": {
"description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"bucket_span",
"detectors",
"influencers"
]
},
"ml._types.DetectorRead": {
"type": "object",
"properties": {
"function": {
"description": "The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`.",
"type": "string"
},
"by_field_name": {
"description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"custom_rules": {
"description": "Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DetectionRule"
}
},
"detector_description": {
"description": "A description of the detector.",
"type": "string"
},
"detector_index": {
"description": "A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored.",
"type": "number"
},
"exclude_frequent": {
"description": "If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ExcludeFrequent"
}
]
},
"field_name": {
"description": "The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"over_field_name": {
"description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"partition_field_name": {
"description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"use_null": {
"description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.",
"default": false,
"type": "boolean"
}
},
"required": [
"function"
]
},
"ml.put_trained_model.Definition": {
"type": "object",
"properties": {
"preprocessors": {
"description": "Collection of preprocessors",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.put_trained_model.Preprocessor"
}
},
"trained_model": {
"description": "The definition of the trained model.",
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.TrainedModel"
}
]
}
},
"required": [
"trained_model"
]
},
"ml.put_trained_model.Preprocessor": {
"type": "object",
"properties": {
"frequency_encoding": {
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.FrequencyEncodingPreprocessor"
}
]
},
"one_hot_encoding": {
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.OneHotEncodingPreprocessor"
}
]
},
"target_mean_encoding": {
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.TargetMeanEncodingPreprocessor"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"ml.put_trained_model.FrequencyEncodingPreprocessor": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"feature_name": {
"type": "string"
},
"frequency_map": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"field",
"feature_name",
"frequency_map"
]
},
"ml.put_trained_model.OneHotEncodingPreprocessor": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"hot_map": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"field",
"hot_map"
]
},
"ml.put_trained_model.TargetMeanEncodingPreprocessor": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"feature_name": {
"type": "string"
},
"target_map": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"default_value": {
"type": "number"
}
},
"required": [
"field",
"feature_name",
"target_map",
"default_value"
]
},
"ml.put_trained_model.TrainedModel": {
"type": "object",
"properties": {
"tree": {
"description": "The definition for a binary decision tree.",
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTree"
}
]
},
"tree_node": {
"description": "The definition of a node in a tree.\nThere are two major types of nodes: leaf nodes and not-leaf nodes.\n- Leaf nodes only need node_index and leaf_value defined.\n- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined.",
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTreeNode"
}
]
},
"ensemble": {
"description": "The definition for an ensemble model",
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.Ensemble"
}
]
}
}
},
"ml.put_trained_model.TrainedModelTree": {
"type": "object",
"properties": {
"classification_labels": {
"type": "array",
"items": {
"type": "string"
}
},
"feature_names": {
"type": "array",
"items": {
"type": "string"
}
},
"target_type": {
"type": "string"
},
"tree_structure": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTreeNode"
}
}
},
"required": [
"feature_names",
"tree_structure"
]
},
"ml.put_trained_model.TrainedModelTreeNode": {
"type": "object",
"properties": {
"decision_type": {
"type": "string"
},
"default_left": {
"type": "boolean"
},
"leaf_value": {
"type": "number"
},
"left_child": {
"type": "number"
},
"node_index": {
"type": "number"
},
"right_child": {
"type": "number"
},
"split_feature": {
"type": "number"
},
"split_gain": {
"type": "number"
},
"threshold": {
"type": "number"
}
},
"required": [
"node_index"
]
},
"ml.put_trained_model.Ensemble": {
"type": "object",
"properties": {
"aggregate_output": {
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.AggregateOutput"
}
]
},
"classification_labels": {
"type": "array",
"items": {
"type": "string"
}
},
"feature_names": {
"type": "array",
"items": {
"type": "string"
}
},
"target_type": {
"type": "string"
},
"trained_models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.put_trained_model.TrainedModel"
}
}
},
"required": [
"trained_models"
]
},
"ml.put_trained_model.AggregateOutput": {
"type": "object",
"properties": {
"logistic_regression": {
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.Weights"
}
]
},
"weighted_sum": {
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.Weights"
}
]
},
"weighted_mode": {
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.Weights"
}
]
},
"exponent": {
"allOf": [
{
"$ref": "#/components/schemas/ml.put_trained_model.Weights"
}
]
}
}
},
"ml.put_trained_model.Weights": {
"type": "object",
"properties": {
"weights": {
"type": "number"
}
},
"required": [
"weights"
]
},
"ml.put_trained_model.Input": {
"type": "object",
"properties": {
"field_names": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Names"
}
]
}
},
"required": [
"field_names"
]
},
"ml._types.TrainedModelAssignment": {
"type": "object",
"properties": {
"adaptive_allocations": {
"oneOf": [
{
"$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings"
},
{
"nullable": true,
"type": "string"
}
]
},
"assignment_state": {
"description": "The overall assignment state.\n\nSupported values include:\n - `started`: The deployment is usable; at least one node has the model allocated.\n - `starting`: The deployment has recently started but is not yet usable; the model is not allocated on any nodes.\n - `stopping`: The deployment is preparing to stop and deallocate the model from the relevant nodes.\n - `failed`: The deployment is on a failed state and must be re-deployed.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DeploymentAssignmentState"
}
]
},
"max_assigned_allocations": {
"type": "number"
},
"reason": {
"type": "string"
},
"routing_table": {
"description": "The allocation state for each node.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ml._types.TrainedModelAssignmentRoutingTable"
}
},
"start_time": {
"description": "The timestamp when the deployment started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"task_parameters": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainedModelAssignmentTaskParameters"
}
]
}
},
"required": [
"assignment_state",
"routing_table",
"start_time",
"task_parameters"
]
},
"ml._types.TrainedModelAssignmentRoutingTable": {
"type": "object",
"properties": {
"reason": {
"description": "The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`.",
"type": "string"
},
"routing_state": {
"description": "The current routing state.\n\nSupported values include:\n - `failed`: The allocation attempt failed.\n - `started`: The trained model is allocated and ready to accept inference requests.\n - `starting`: The trained model is attempting to allocate on this node; inference requests are not yet accepted.\n - `stopped`: The trained model is fully deallocated from this node.\n - `stopping`: The trained model is being deallocated from this node.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.RoutingState"
}
]
},
"current_allocations": {
"description": "Current number of allocations.",
"type": "number"
},
"target_allocations": {
"description": "Target number of allocations.",
"type": "number"
}
},
"required": [
"routing_state",
"current_allocations",
"target_allocations"
]
},
"ml._types.TrainedModelAssignmentTaskParameters": {
"type": "object",
"properties": {
"model_bytes": {
"description": "The size of the trained model in bytes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"model_id": {
"description": "The unique identifier for the trained model.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"deployment_id": {
"description": "The unique identifier for the trained model deployment.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"cache_size": {
"description": "The size of the trained model cache.",
"x-state": "Generally available; Added in 8.4.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"number_of_allocations": {
"description": "The total number of allocations this model is assigned across ML nodes.",
"type": "number"
},
"priority": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TrainingPriority"
}
]
},
"per_deployment_memory_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"per_allocation_memory_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"queue_capacity": {
"description": "Number of inference requests are allowed in the queue at a time.",
"type": "number"
},
"threads_per_allocation": {
"description": "Number of threads per allocation.",
"type": "number"
}
},
"required": [
"model_bytes",
"model_id",
"deployment_id",
"number_of_allocations",
"priority",
"per_deployment_memory_bytes",
"per_allocation_memory_bytes",
"queue_capacity",
"threads_per_allocation"
]
},
"ml._types.AnalysisMemoryLimit": {
"type": "object",
"properties": {
"model_memory_limit": {
"description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.",
"type": "string"
}
},
"required": [
"model_memory_limit"
]
},
"ml._types.DetectorUpdate": {
"type": "object",
"properties": {
"detector_index": {
"description": "A unique identifier for the detector.\nThis identifier is based on the order of the detectors in the `analysis_config`, starting at zero.",
"type": "number"
},
"description": {
"description": "A description of the detector.",
"type": "string"
},
"custom_rules": {
"description": "An array of custom rule objects, which enable you to customize the way detectors operate.\nFor example, a rule may dictate to the detector conditions under which results should be skipped.\nKibana refers to custom rules as job rules.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DetectionRule"
}
}
},
"required": [
"detector_index"
]
},
"_global.msearch.MultiSearchResult": {
"type": "object",
"properties": {
"took": {
"type": "number"
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.msearch.ResponseItem"
}
}
},
"required": [
"took",
"responses"
]
},
"_global.msearch_template.RequestItem": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.msearch.MultisearchHeader"
},
{
"$ref": "#/components/schemas/_global.msearch_template.TemplateConfig"
}
]
},
"_global.msearch_template.TemplateConfig": {
"type": "object",
"properties": {
"explain": {
"description": "If `true`, returns detailed information about score calculation as part of each hit.",
"default": false,
"type": "boolean"
},
"id": {
"description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"params": {
"description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"profile": {
"description": "If `true`, the query execution is profiled.",
"default": false,
"type": "boolean"
},
"source": {
"description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSource"
}
]
}
}
},
"_global.mtermvectors.Operation": {
"type": "object",
"properties": {
"_id": {
"description": "The ID of the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "The index of the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"doc": {
"description": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.",
"type": "object"
},
"fields": {
"description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"field_statistics": {
"description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.",
"default": true,
"type": "boolean"
},
"filter": {
"description": "Filter terms based on their tf-idf scores.",
"allOf": [
{
"$ref": "#/components/schemas/_global.termvectors.Filter"
}
]
},
"offsets": {
"description": "If `true`, the response includes term offsets.",
"default": true,
"type": "boolean"
},
"payloads": {
"description": "If `true`, the response includes term payloads.",
"default": true,
"type": "boolean"
},
"positions": {
"description": "If `true`, the response includes term positions.",
"default": true,
"type": "boolean"
},
"routing": {
"description": "Custom value used to route operations to a specific shard.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Routing"
}
]
},
"term_statistics": {
"description": "If true, the response includes term frequency and document frequency.",
"default": false,
"type": "boolean"
},
"version": {
"description": "If `true`, returns the document version as part of a hit.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"version_type": {
"description": "Specific version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionType"
}
]
}
}
},
"_global.termvectors.Filter": {
"type": "object",
"properties": {
"max_doc_freq": {
"description": "Ignore words which occur in more than this many docs.\nDefaults to unbounded.",
"type": "number"
},
"max_num_terms": {
"description": "The maximum number of terms that must be returned per field.",
"default": 25,
"type": "number"
},
"max_term_freq": {
"description": "Ignore words with more than this frequency in the source doc.\nIt defaults to unbounded.",
"type": "number"
},
"max_word_length": {
"description": "The maximum word length above which words will be ignored.\nDefaults to unbounded.",
"default": 0,
"type": "number"
},
"min_doc_freq": {
"description": "Ignore terms which do not occur in at least this many docs.",
"default": 1,
"type": "number"
},
"min_term_freq": {
"description": "Ignore words with less than this frequency in the source doc.",
"default": 1,
"type": "number"
},
"min_word_length": {
"description": "The minimum word length below which words will be ignored.",
"default": 0,
"type": "number"
}
}
},
"_global.mtermvectors.TermVectorsResult": {
"type": "object",
"properties": {
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"took": {
"type": "number"
},
"found": {
"type": "boolean"
},
"term_vectors": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.termvectors.TermVector"
}
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"_index"
]
},
"_global.termvectors.TermVector": {
"type": "object",
"properties": {
"field_statistics": {
"allOf": [
{
"$ref": "#/components/schemas/_global.termvectors.FieldStatistics"
}
]
},
"terms": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.termvectors.Term"
}
}
},
"required": [
"terms"
]
},
"_global.termvectors.FieldStatistics": {
"type": "object",
"properties": {
"doc_count": {
"type": "number"
},
"sum_doc_freq": {
"type": "number"
},
"sum_ttf": {
"type": "number"
}
},
"required": [
"doc_count",
"sum_doc_freq",
"sum_ttf"
]
},
"_global.termvectors.Term": {
"type": "object",
"properties": {
"doc_freq": {
"type": "number"
},
"score": {
"type": "number"
},
"term_freq": {
"type": "number"
},
"tokens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.termvectors.Token"
}
},
"ttf": {
"type": "number"
}
},
"required": [
"term_freq"
]
},
"_global.termvectors.Token": {
"type": "object",
"properties": {
"end_offset": {
"type": "number"
},
"payload": {
"type": "string"
},
"position": {
"type": "number"
},
"start_offset": {
"type": "number"
}
},
"required": [
"position"
]
},
"nodes.clear_repositories_metering_archive.ResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.NodesResponseBase"
},
{
"type": "object",
"properties": {
"cluster_name": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/deploy/self-managed/important-settings-configuration##_cluster_name_setting"
},
"description": "Name of the cluster. Based on the `cluster.name` setting.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"description": "Contains repositories metering information for the nodes selected by the request.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.RepositoryMeteringInformation"
}
}
},
"required": [
"cluster_name",
"nodes"
]
}
]
},
"nodes._types.RepositoryMeteringInformation": {
"type": "object",
"properties": {
"repository_name": {
"description": "Repository name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"repository_type": {
"description": "Repository type.",
"type": "string"
},
"repository_location": {
"description": "Represents an unique location within the repository.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.RepositoryLocation"
}
]
},
"repository_ephemeral_id": {
"description": "An identifier that changes every time the repository is updated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"repository_started_at": {
"description": "Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"repository_stopped_at": {
"description": "Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"archived": {
"description": "A flag that tells whether or not this object has been archived. When a repository is closed or updated the\nrepository metering information is archived and kept for a certain period of time. This allows retrieving the\nrepository metering information of previous repository instantiations.",
"type": "boolean"
},
"cluster_version": {
"description": "The cluster state version when this object was archived, this field can be used as a logical timestamp to delete\nall the archived metrics up to an observed version. This field is only present for archived repository metering\ninformation objects. The main purpose of this field is to avoid possible race conditions during repository metering\ninformation deletions, i.e. deleting archived repositories metering information that we haven’t observed yet.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"request_counts": {
"description": "An object with the number of request performed against the repository grouped by request type.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.RequestCounts"
}
]
}
},
"required": [
"repository_name",
"repository_type",
"repository_location",
"repository_ephemeral_id",
"repository_started_at",
"archived",
"request_counts"
]
},
"nodes._types.RepositoryLocation": {
"type": "object",
"properties": {
"base_path": {
"type": "string"
},
"container": {
"description": "Container name (Azure)",
"type": "string"
},
"bucket": {
"description": "Bucket name (GCP, S3)",
"type": "string"
}
},
"required": [
"base_path"
]
},
"nodes._types.RequestCounts": {
"type": "object",
"properties": {
"GetBlobProperties": {
"description": "Number of Get Blob Properties requests (Azure)",
"type": "number"
},
"GetBlob": {
"description": "Number of Get Blob requests (Azure)",
"type": "number"
},
"ListBlobs": {
"description": "Number of List Blobs requests (Azure)",
"type": "number"
},
"PutBlob": {
"description": "Number of Put Blob requests (Azure)",
"type": "number"
},
"PutBlock": {
"description": "Number of Put Block (Azure)",
"type": "number"
},
"PutBlockList": {
"description": "Number of Put Block List requests",
"type": "number"
},
"GetObject": {
"description": "Number of get object requests (GCP, S3)",
"type": "number"
},
"ListObjects": {
"description": "Number of list objects requests (GCP, S3)",
"type": "number"
},
"InsertObject": {
"description": "Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads\ncan perform multiple http requests to insert a single object but they are considered as a single request\nsince they are billed as an individual operation. (GCP)",
"type": "number"
},
"PutObject": {
"description": "Number of PutObject requests (S3)",
"type": "number"
},
"PutMultipartObject": {
"description": "Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3)",
"type": "number"
}
}
},
"nodes.get_repositories_metering_info.ResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.NodesResponseBase"
},
{
"type": "object",
"properties": {
"cluster_name": {
"description": "Name of the cluster. Based on the `cluster.name` setting.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"description": "Contains repositories metering information for the nodes selected by the request.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.RepositoryMeteringInformation"
}
}
},
"required": [
"cluster_name",
"nodes"
]
}
]
},
"_types.ThreadType": {
"type": "string",
"enum": [
"cpu",
"wait",
"block",
"gpu",
"mem"
]
},
"nodes.info.NodesInfoMetrics": {
"oneOf": [
{
"$ref": "#/components/schemas/nodes.info.NodesInfoMetric"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes.info.NodesInfoMetric"
}
}
]
},
"nodes.info.NodesInfoMetric": {
"type": "string",
"enum": [
"_all",
"_none",
"settings",
"os",
"process",
"jvm",
"thread_pool",
"transport",
"http",
"remote_cluster_server",
"plugins",
"ingest",
"aggregations",
"indices"
]
},
"nodes.info.ResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.NodesResponseBase"
},
{
"type": "object",
"properties": {
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes.info.NodeInfo"
}
}
},
"required": [
"cluster_name",
"nodes"
]
}
]
},
"nodes.info.NodeInfo": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"build_flavor": {
"type": "string"
},
"build_hash": {
"description": "Short hash of the last git commit in this release.",
"type": "string"
},
"build_type": {
"type": "string"
},
"component_versions": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"host": {
"description": "The node’s host name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"http": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoHttp"
}
]
},
"index_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"ip": {
"description": "The node’s IP address.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Ip"
}
]
},
"jvm": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeJvmInfo"
}
]
},
"name": {
"description": "The node's name",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"os": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeOperatingSystemInfo"
}
]
},
"plugins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.PluginStats"
}
},
"process": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeProcessInfo"
}
]
},
"roles": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeRoles"
}
]
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettings"
}
]
},
"thread_pool": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes.info.NodeThreadPoolInfo"
}
},
"total_indexing_buffer": {
"description": "Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.",
"type": "number"
},
"total_indexing_buffer_in_bytes": {
"description": "Same as total_indexing_buffer, but expressed in bytes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"transport": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoTransport"
}
]
},
"transport_address": {
"description": "Host and port where transport HTTP connections are accepted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"transport_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"version": {
"description": "Elasticsearch version running on this node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.PluginStats"
}
},
"ingest": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngest"
}
]
},
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes.info.NodeInfoAggregation"
}
},
"remote_cluster_server": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.RemoveClusterServer"
}
]
}
},
"required": [
"attributes",
"build_flavor",
"build_hash",
"build_type",
"component_versions",
"host",
"index_version",
"ip",
"name",
"roles",
"transport_address",
"transport_version",
"version"
]
},
"nodes.info.NodeInfoHttp": {
"type": "object",
"properties": {
"bound_address": {
"type": "array",
"items": {
"type": "string"
}
},
"max_content_length": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_content_length_in_bytes": {
"type": "number"
},
"publish_address": {
"type": "string"
}
},
"required": [
"bound_address",
"max_content_length_in_bytes",
"publish_address"
]
},
"nodes.info.NodeJvmInfo": {
"type": "object",
"properties": {
"gc_collectors": {
"type": "array",
"items": {
"type": "string"
}
},
"mem": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoJvmMemory"
}
]
},
"memory_pools": {
"type": "array",
"items": {
"type": "string"
}
},
"pid": {
"type": "number"
},
"start_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"vm_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"vm_vendor": {
"type": "string"
},
"vm_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"using_bundled_jdk": {
"type": "boolean"
},
"using_compressed_ordinary_object_pointers": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"input_arguments": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"gc_collectors",
"mem",
"memory_pools",
"pid",
"start_time_in_millis",
"version",
"vm_name",
"vm_vendor",
"vm_version",
"using_bundled_jdk",
"input_arguments"
]
},
"nodes.info.NodeInfoJvmMemory": {
"type": "object",
"properties": {
"direct_max": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"direct_max_in_bytes": {
"type": "number"
},
"heap_init": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"heap_init_in_bytes": {
"type": "number"
},
"heap_max": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"heap_max_in_bytes": {
"type": "number"
},
"non_heap_init": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"non_heap_init_in_bytes": {
"type": "number"
},
"non_heap_max": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"non_heap_max_in_bytes": {
"type": "number"
}
},
"required": [
"direct_max_in_bytes",
"heap_init_in_bytes",
"heap_max_in_bytes",
"non_heap_init_in_bytes",
"non_heap_max_in_bytes"
]
},
"nodes.info.NodeOperatingSystemInfo": {
"type": "object",
"properties": {
"arch": {
"description": "Name of the JVM architecture (ex: amd64, x86)",
"type": "string"
},
"available_processors": {
"description": "Number of processors available to the Java virtual machine",
"type": "number"
},
"allocated_processors": {
"description": "The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS.",
"type": "number"
},
"name": {
"description": "Name of the operating system (ex: Linux, Windows, Mac OS X)",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"pretty_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"refresh_interval_in_millis": {
"description": "Refresh interval for the OS statistics",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"version": {
"description": "Version of the operating system",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"cpu": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoOSCPU"
}
]
},
"mem": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoMemory"
}
]
},
"swap": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoMemory"
}
]
}
},
"required": [
"arch",
"available_processors",
"name",
"pretty_name",
"refresh_interval_in_millis",
"version"
]
},
"nodes.info.NodeInfoOSCPU": {
"type": "object",
"properties": {
"cache_size": {
"type": "string"
},
"cache_size_in_bytes": {
"type": "number"
},
"cores_per_socket": {
"type": "number"
},
"mhz": {
"type": "number"
},
"model": {
"type": "string"
},
"total_cores": {
"type": "number"
},
"total_sockets": {
"type": "number"
},
"vendor": {
"type": "string"
}
},
"required": [
"cache_size",
"cache_size_in_bytes",
"cores_per_socket",
"mhz",
"model",
"total_cores",
"total_sockets",
"vendor"
]
},
"nodes.info.NodeInfoMemory": {
"type": "object",
"properties": {
"total": {
"type": "string"
},
"total_in_bytes": {
"type": "number"
}
},
"required": [
"total",
"total_in_bytes"
]
},
"nodes.info.NodeProcessInfo": {
"type": "object",
"properties": {
"id": {
"description": "Process identifier (PID)",
"type": "number"
},
"mlockall": {
"description": "Indicates if the process address space has been successfully locked in memory",
"type": "boolean"
},
"refresh_interval_in_millis": {
"description": "Refresh interval for the process statistics",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"id",
"mlockall",
"refresh_interval_in_millis"
]
},
"nodes.info.NodeInfoSettings": {
"type": "object",
"properties": {
"cluster": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsCluster"
}
]
},
"node": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsNode"
}
]
},
"path": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoPath"
}
]
},
"repositories": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoRepositories"
}
]
},
"discovery": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoDiscover"
}
]
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoAction"
}
]
},
"client": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoClient"
}
]
},
"http": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsHttp"
}
]
},
"bootstrap": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoBootstrap"
}
]
},
"transport": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransport"
}
]
},
"network": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsNetwork"
}
]
},
"xpack": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpack"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoScript"
}
]
},
"search": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSearch"
}
]
},
"ingest": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsIngest"
}
]
}
},
"required": [
"cluster",
"node",
"http",
"transport"
]
},
"nodes.info.NodeInfoSettingsCluster": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"routing": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexRouting"
}
]
},
"election": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsClusterElection"
}
]
},
"initial_master_nodes": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"deprecation_indexing": {
"x-state": "Generally available; Added in 7.16.0",
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.DeprecationIndexing"
}
]
}
},
"required": [
"name",
"election"
]
},
"nodes.info.NodeInfoSettingsClusterElection": {
"type": "object",
"properties": {
"strategy": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"strategy"
]
},
"nodes.info.DeprecationIndexing": {
"type": "object",
"properties": {
"enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
},
"required": [
"enabled"
]
},
"nodes.info.NodeInfoSettingsNode": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"attr": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"max_local_storage_nodes": {
"type": "string"
}
},
"required": [
"name",
"attr"
]
},
"nodes.info.NodeInfoPath": {
"type": "object",
"properties": {
"logs": {
"type": "string"
},
"home": {
"type": "string"
},
"repo": {
"type": "array",
"items": {
"type": "string"
}
},
"data": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
"nodes.info.NodeInfoRepositories": {
"type": "object",
"properties": {
"url": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoRepositoriesUrl"
}
]
}
},
"required": [
"url"
]
},
"nodes.info.NodeInfoRepositoriesUrl": {
"type": "object",
"properties": {
"allowed_urls": {
"type": "string"
}
},
"required": [
"allowed_urls"
]
},
"nodes.info.NodeInfoDiscover": {
"type": "object",
"properties": {
"seed_hosts": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"type": {
"type": "string"
},
"seed_providers": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"nodes.info.NodeInfoAction": {
"type": "object",
"properties": {
"destructive_requires_name": {
"type": "string"
}
},
"required": [
"destructive_requires_name"
]
},
"nodes.info.NodeInfoClient": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"nodes.info.NodeInfoSettingsHttp": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsHttpType"
}
]
},
"type.default": {
"type": "string"
},
"compression": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"port": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
}
},
"required": [
"type"
]
},
"nodes.info.NodeInfoSettingsHttpType": {
"type": "object",
"properties": {
"default": {
"type": "string"
}
},
"required": [
"default"
]
},
"nodes.info.NodeInfoBootstrap": {
"type": "object",
"properties": {
"memory_lock": {
"type": "string"
}
},
"required": [
"memory_lock"
]
},
"nodes.info.NodeInfoSettingsTransport": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransportType"
}
]
},
"type.default": {
"type": "string"
},
"features": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransportFeatures"
}
]
}
},
"required": [
"type"
]
},
"nodes.info.NodeInfoSettingsTransportType": {
"type": "object",
"properties": {
"default": {
"type": "string"
}
},
"required": [
"default"
]
},
"nodes.info.NodeInfoSettingsTransportFeatures": {
"type": "object",
"properties": {
"x-pack": {
"type": "string"
}
},
"required": [
"x-pack"
]
},
"nodes.info.NodeInfoSettingsNetwork": {
"type": "object",
"properties": {
"host": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Host"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Host"
}
}
]
}
}
},
"nodes.info.NodeInfoXpack": {
"type": "object",
"properties": {
"license": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackLicense"
}
]
},
"security": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurity"
}
]
},
"notification": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"ml": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackMl"
}
]
}
},
"required": [
"security"
]
},
"nodes.info.NodeInfoXpackLicense": {
"type": "object",
"properties": {
"self_generated": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackLicenseType"
}
]
}
},
"required": [
"self_generated"
]
},
"nodes.info.NodeInfoXpackLicenseType": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"nodes.info.NodeInfoXpackSecurity": {
"type": "object",
"properties": {
"http": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecuritySsl"
}
]
},
"enabled": {
"type": "string"
},
"transport": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecuritySsl"
}
]
},
"authc": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthc"
}
]
}
},
"required": [
"enabled"
]
},
"nodes.info.NodeInfoXpackSecuritySsl": {
"type": "object",
"properties": {
"ssl": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"ssl"
]
},
"nodes.info.NodeInfoXpackSecurityAuthc": {
"type": "object",
"properties": {
"realms": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcRealms"
}
]
},
"token": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcToken"
}
]
}
}
},
"nodes.info.NodeInfoXpackSecurityAuthcRealms": {
"type": "object",
"properties": {
"file": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcRealmsStatus"
}
},
"native": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcRealmsStatus"
}
},
"pki": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcRealmsStatus"
}
}
}
},
"nodes.info.NodeInfoXpackSecurityAuthcRealmsStatus": {
"type": "object",
"properties": {
"enabled": {
"type": "string"
},
"order": {
"type": "string"
}
},
"required": [
"order"
]
},
"nodes.info.NodeInfoXpackSecurityAuthcToken": {
"type": "object",
"properties": {
"enabled": {
"type": "string"
}
},
"required": [
"enabled"
]
},
"nodes.info.NodeInfoXpackMl": {
"type": "object",
"properties": {
"use_auto_machine_memory_percent": {
"type": "boolean"
}
}
},
"nodes.info.NodeInfoScript": {
"type": "object",
"properties": {
"allowed_types": {
"type": "string"
},
"disable_max_compilations_rate": {
"type": "string"
}
},
"required": [
"allowed_types"
]
},
"nodes.info.NodeInfoSearch": {
"type": "object",
"properties": {
"remote": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoSearchRemote"
}
]
}
},
"required": [
"remote"
]
},
"nodes.info.NodeInfoSearchRemote": {
"type": "object",
"properties": {
"connect": {
"type": "string"
}
},
"required": [
"connect"
]
},
"nodes.info.NodeInfoSettingsIngest": {
"type": "object",
"properties": {
"attachment": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"append": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"csv": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"convert": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"date": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"date_index_name": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"dot_expander": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"enrich": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"fail": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"foreach": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"json": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"user_agent": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"kv": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"geoip": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"grok": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"gsub": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"join": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"lowercase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"remove": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"rename": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"set": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"split": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"trim": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"uppercase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"urldecode": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"bytes": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"dissect": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"set_security_user": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"pipeline": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"drop": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"circle": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
},
"inference": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo"
}
]
}
}
},
"nodes.info.NodeInfoIngestInfo": {
"type": "object",
"properties": {
"downloader": {
"allOf": [
{
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestDownloader"
}
]
}
},
"required": [
"downloader"
]
},
"nodes.info.NodeInfoIngestDownloader": {
"type": "object",
"properties": {
"enabled": {
"type": "string"
}
},
"required": [
"enabled"
]
},
"nodes.info.NodeThreadPoolInfo": {
"type": "object",
"properties": {
"core": {
"type": "number"
},
"keep_alive": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max": {
"type": "number"
},
"queue_size": {
"type": "number"
},
"size": {
"type": "number"
},
"type": {
"type": "string"
}
},
"required": [
"queue_size",
"type"
]
},
"nodes.info.NodeInfoTransport": {
"type": "object",
"properties": {
"bound_address": {
"type": "array",
"items": {
"type": "string"
}
},
"publish_address": {
"type": "string"
},
"profiles": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"bound_address",
"publish_address",
"profiles"
]
},
"nodes.info.NodeInfoIngest": {
"type": "object",
"properties": {
"processors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes.info.NodeInfoIngestProcessor"
}
}
},
"required": [
"processors"
]
},
"nodes.info.NodeInfoIngestProcessor": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"nodes.info.NodeInfoAggregation": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"types"
]
},
"nodes.info.RemoveClusterServer": {
"type": "object",
"properties": {
"bound_address": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.TransportAddress"
}
},
"publish_address": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
}
},
"required": [
"bound_address",
"publish_address"
]
},
"_types.Password": {
"type": "string"
},
"nodes.reload_secure_settings.ResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.NodesResponseBase"
},
{
"type": "object",
"properties": {
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.NodeReloadResult"
}
}
},
"required": [
"cluster_name",
"nodes"
]
}
]
},
"nodes._types.NodeReloadResult": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"reload_exception": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"secure_setting_names": {
"description": "The names of the secure settings that were reloaded.",
"type": "array",
"items": {
"type": "string"
}
},
"keystore_path": {
"description": "The path to the keystore file.",
"type": "string"
},
"keystore_digest": {
"description": "A SHA-256 hash of the keystore file contents.",
"type": "string"
},
"keystore_last_modified_time": {
"description": "The last modification time of the keystore file.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"name"
]
},
"nodes.stats.NodeStatsMetrics": {
"oneOf": [
{
"$ref": "#/components/schemas/nodes.stats.NodeStatsMetric"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes.stats.NodeStatsMetric"
}
}
]
},
"nodes.stats.NodeStatsMetric": {
"type": "string",
"enum": [
"_all",
"_none",
"indices",
"os",
"process",
"jvm",
"thread_pool",
"fs",
"transport",
"http",
"breaker",
"script",
"discovery",
"ingest",
"adaptive_selection",
"script_cache",
"indexing_pressure",
"repositories",
"allocations"
]
},
"_types.NodeStatsLevel": {
"type": "string",
"enum": [
"node",
"indices",
"shards"
]
},
"nodes.stats.ResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.NodesResponseBase"
},
{
"type": "object",
"properties": {
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.Stats"
}
}
},
"required": [
"nodes"
]
}
]
},
"nodes._types.Stats": {
"type": "object",
"properties": {
"adaptive_selection": {
"description": "Statistics about adaptive replica selection.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.AdaptiveSelection"
}
},
"breakers": {
"description": "Statistics about the field data circuit breaker.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.Breaker"
}
},
"fs": {
"description": "File system information, data path, free disk space, read/write stats.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.FileSystem"
}
]
},
"host": {
"description": "Network host for the node, based on the network host setting.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"http": {
"description": "HTTP connection information.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Http"
}
]
},
"ingest": {
"description": "Statistics about ingest preprocessing.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Ingest"
}
]
},
"ip": {
"description": "IP address and port for the node.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.Ip"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Ip"
}
}
]
},
"jvm": {
"description": "JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Jvm"
}
]
},
"name": {
"description": "Human-readable identifier for the node.\nBased on the node name setting.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"os": {
"description": "Operating system stats, load average, mem, swap.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.OperatingSystem"
}
]
},
"process": {
"description": "Process statistics, memory consumption, cpu usage, open file descriptors.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Process"
}
]
},
"roles": {
"description": "Roles assigned to the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeRoles"
}
]
},
"script": {
"description": "Contains script statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Scripting"
}
]
},
"script_cache": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/nodes._types.ScriptCache"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.ScriptCache"
}
}
]
}
},
"thread_pool": {
"description": "Statistics about each thread pool, including current size, queue and rejected tasks.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.ThreadCount"
}
},
"timestamp": {
"type": "number"
},
"transport": {
"description": "Transport statistics about sent and received bytes in cluster communication.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Transport"
}
]
},
"transport_address": {
"description": "Host and port for the transport layer, used for internal communication between nodes in a cluster.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"attributes": {
"description": "Contains a list of attributes for the node.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"discovery": {
"description": "Contains node discovery statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Discovery"
}
]
},
"indexing_pressure": {
"description": "Contains indexing pressure statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.IndexingPressure"
}
]
},
"indices": {
"description": "Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.",
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardStats"
}
]
}
}
},
"nodes._types.AdaptiveSelection": {
"type": "object",
"properties": {
"avg_queue_size": {
"description": "The exponentially weighted moving average queue size of search requests on the keyed node.",
"type": "number"
},
"avg_response_time": {
"description": "The exponentially weighted moving average response time of search requests on the keyed node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"avg_response_time_ns": {
"description": "The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.",
"type": "number"
},
"avg_service_time": {
"description": "The exponentially weighted moving average service time of search requests on the keyed node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"avg_service_time_ns": {
"description": "The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.",
"type": "number"
},
"outgoing_searches": {
"description": "The number of outstanding search requests to the keyed node from the node these stats are for.",
"type": "number"
},
"rank": {
"description": "The rank of this node; used for shard selection when routing search requests.",
"type": "string"
}
}
},
"nodes._types.Breaker": {
"type": "object",
"properties": {
"estimated_size": {
"description": "Estimated memory used for the operation.",
"type": "string"
},
"estimated_size_in_bytes": {
"description": "Estimated memory used, in bytes, for the operation.",
"type": "number"
},
"limit_size": {
"description": "Memory limit for the circuit breaker.",
"type": "string"
},
"limit_size_in_bytes": {
"description": "Memory limit, in bytes, for the circuit breaker.",
"type": "number"
},
"overhead": {
"description": "A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.",
"type": "number"
},
"tripped": {
"description": "Total number of times the circuit breaker has been triggered and prevented an out of memory error.",
"type": "number"
}
}
},
"nodes._types.FileSystem": {
"type": "object",
"properties": {
"data": {
"description": "List of all file stores.",
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.DataPathStats"
}
},
"timestamp": {
"description": "Last time the file stores statistics were refreshed.\nRecorded in milliseconds since the Unix Epoch.",
"type": "number"
},
"total": {
"description": "Contains statistics for all file stores of the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.FileSystemTotal"
}
]
},
"io_stats": {
"description": "Contains I/O statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.IoStats"
}
]
}
}
},
"nodes._types.DataPathStats": {
"type": "object",
"properties": {
"available": {
"description": "Total amount of disk space available to this Java virtual machine on this file store.",
"type": "string"
},
"available_in_bytes": {
"description": "Total number of bytes available to this Java virtual machine on this file store.",
"type": "number"
},
"disk_queue": {
"type": "string"
},
"disk_reads": {
"type": "number"
},
"disk_read_size": {
"type": "string"
},
"disk_read_size_in_bytes": {
"type": "number"
},
"disk_writes": {
"type": "number"
},
"disk_write_size": {
"type": "string"
},
"disk_write_size_in_bytes": {
"type": "number"
},
"free": {
"description": "Total amount of unallocated disk space in the file store.",
"type": "string"
},
"free_in_bytes": {
"description": "Total number of unallocated bytes in the file store.",
"type": "number"
},
"mount": {
"description": "Mount point of the file store (for example: `/dev/sda2`).",
"type": "string"
},
"path": {
"description": "Path to the file store.",
"type": "string"
},
"total": {
"description": "Total size of the file store.",
"type": "string"
},
"total_in_bytes": {
"description": "Total size of the file store in bytes.",
"type": "number"
},
"type": {
"description": "Type of the file store (ex: ext4).",
"type": "string"
}
}
},
"nodes._types.FileSystemTotal": {
"type": "object",
"properties": {
"available": {
"description": "Total disk space available to this Java virtual machine on all file stores.\nDepending on OS or process level restrictions, this might appear less than `free`.\nThis is the actual amount of free disk space the Elasticsearch node can utilise.",
"type": "string"
},
"available_in_bytes": {
"description": "Total number of bytes available to this Java virtual machine on all file stores.\nDepending on OS or process level restrictions, this might appear less than `free_in_bytes`.\nThis is the actual amount of free disk space the Elasticsearch node can utilise.",
"type": "number"
},
"free": {
"description": "Total unallocated disk space in all file stores.",
"type": "string"
},
"free_in_bytes": {
"description": "Total number of unallocated bytes in all file stores.",
"type": "number"
},
"total": {
"description": "Total size of all file stores.",
"type": "string"
},
"total_in_bytes": {
"description": "Total size of all file stores in bytes.",
"type": "number"
}
}
},
"nodes._types.IoStats": {
"type": "object",
"properties": {
"devices": {
"description": "Array of disk metrics for each device that is backing an Elasticsearch data path.\nThese disk metrics are probed periodically and averages between the last probe and the current probe are computed.",
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.IoStatDevice"
}
},
"total": {
"description": "The sum of the disk metrics for all devices that back an Elasticsearch data path.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.IoStatDevice"
}
]
}
}
},
"nodes._types.IoStatDevice": {
"type": "object",
"properties": {
"device_name": {
"description": "The Linux device name.",
"type": "string"
},
"operations": {
"description": "The total number of read and write operations for the device completed since starting Elasticsearch.",
"type": "number"
},
"read_kilobytes": {
"description": "The total number of kilobytes read for the device since starting Elasticsearch.",
"type": "number"
},
"read_operations": {
"description": "The total number of read operations for the device completed since starting Elasticsearch.",
"type": "number"
},
"write_kilobytes": {
"description": "The total number of kilobytes written for the device since starting Elasticsearch.",
"type": "number"
},
"write_operations": {
"description": "The total number of write operations for the device completed since starting Elasticsearch.",
"type": "number"
}
}
},
"nodes._types.Jvm": {
"type": "object",
"properties": {
"buffer_pools": {
"description": "Contains statistics about JVM buffer pools for the node.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.NodeBufferPool"
}
},
"classes": {
"description": "Contains statistics about classes loaded by JVM for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.JvmClasses"
}
]
},
"gc": {
"description": "Contains statistics about JVM garbage collectors for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.GarbageCollector"
}
]
},
"mem": {
"description": "Contains JVM memory usage statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.JvmMemoryStats"
}
]
},
"threads": {
"description": "Contains statistics about JVM thread usage for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.JvmThreads"
}
]
},
"timestamp": {
"description": "Last time JVM statistics were refreshed.",
"type": "number"
},
"uptime": {
"description": "Human-readable JVM uptime.\nOnly returned if the `human` query parameter is `true`.",
"type": "string"
},
"uptime_in_millis": {
"description": "JVM uptime in milliseconds.",
"type": "number"
}
}
},
"nodes._types.NodeBufferPool": {
"type": "object",
"properties": {
"count": {
"description": "Number of buffer pools.",
"type": "number"
},
"total_capacity": {
"description": "Total capacity of buffer pools.",
"type": "string"
},
"total_capacity_in_bytes": {
"description": "Total capacity of buffer pools in bytes.",
"type": "number"
},
"used": {
"description": "Size of buffer pools.",
"type": "string"
},
"used_in_bytes": {
"description": "Size of buffer pools in bytes.",
"type": "number"
}
}
},
"nodes._types.JvmClasses": {
"type": "object",
"properties": {
"current_loaded_count": {
"description": "Number of classes currently loaded by JVM.",
"type": "number"
},
"total_loaded_count": {
"description": "Total number of classes loaded since the JVM started.",
"type": "number"
},
"total_unloaded_count": {
"description": "Total number of classes unloaded since the JVM started.",
"type": "number"
}
}
},
"nodes._types.GarbageCollector": {
"type": "object",
"properties": {
"collectors": {
"description": "Contains statistics about JVM garbage collectors for the node.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.GarbageCollectorTotal"
}
}
}
},
"nodes._types.GarbageCollectorTotal": {
"type": "object",
"properties": {
"collection_count": {
"description": "Total number of JVM garbage collectors that collect objects.",
"type": "number"
},
"collection_time": {
"description": "Total time spent by JVM collecting objects.",
"type": "string"
},
"collection_time_in_millis": {
"description": "Total time, in milliseconds, spent by JVM collecting objects.",
"type": "number"
}
}
},
"nodes._types.JvmMemoryStats": {
"type": "object",
"properties": {
"heap_used_in_bytes": {
"description": "Memory, in bytes, currently in use by the heap.",
"type": "number"
},
"heap_used_percent": {
"description": "Percentage of memory currently in use by the heap.",
"type": "number"
},
"heap_committed_in_bytes": {
"description": "Amount of memory, in bytes, available for use by the heap.",
"type": "number"
},
"heap_max_in_bytes": {
"description": "Maximum amount of memory, in bytes, available for use by the heap.",
"type": "number"
},
"heap_max": {
"description": "Maximum amount of memory, available for use by the heap.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"non_heap_used_in_bytes": {
"description": "Non-heap memory used, in bytes.",
"type": "number"
},
"non_heap_committed_in_bytes": {
"description": "Amount of non-heap memory available, in bytes.",
"type": "number"
},
"pools": {
"description": "Contains statistics about heap memory usage for the node.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.Pool"
}
}
}
},
"nodes._types.Pool": {
"type": "object",
"properties": {
"used_in_bytes": {
"description": "Memory, in bytes, used by the heap.",
"type": "number"
},
"max_in_bytes": {
"description": "Maximum amount of memory, in bytes, available for use by the heap.",
"type": "number"
},
"peak_used_in_bytes": {
"description": "Largest amount of memory, in bytes, historically used by the heap.",
"type": "number"
},
"peak_max_in_bytes": {
"description": "Largest amount of memory, in bytes, historically used by the heap.",
"type": "number"
}
}
},
"nodes._types.JvmThreads": {
"type": "object",
"properties": {
"count": {
"description": "Number of active threads in use by JVM.",
"type": "number"
},
"peak_count": {
"description": "Highest number of threads used by JVM.",
"type": "number"
}
}
},
"nodes._types.OperatingSystem": {
"type": "object",
"properties": {
"cpu": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Cpu"
}
]
},
"mem": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.ExtendedMemoryStats"
}
]
},
"swap": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.MemoryStats"
}
]
},
"cgroup": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Cgroup"
}
]
},
"timestamp": {
"type": "number"
}
}
},
"nodes._types.Cpu": {
"type": "object",
"properties": {
"percent": {
"type": "number"
},
"sys": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"sys_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"user_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"load_average": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
}
},
"nodes._types.ExtendedMemoryStats": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.MemoryStats"
},
{
"type": "object",
"properties": {
"free_percent": {
"description": "Percentage of free memory.",
"type": "number"
},
"used_percent": {
"description": "Percentage of used memory.",
"type": "number"
}
}
}
]
},
"nodes._types.MemoryStats": {
"type": "object",
"properties": {
"adjusted_total_in_bytes": {
"description": "If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes.\nOtherwise it reports the same value as `total_in_bytes`.",
"type": "number"
},
"resident": {
"type": "string"
},
"resident_in_bytes": {
"type": "number"
},
"share": {
"type": "string"
},
"share_in_bytes": {
"type": "number"
},
"total_virtual": {
"type": "string"
},
"total_virtual_in_bytes": {
"type": "number"
},
"total_in_bytes": {
"description": "Total amount of physical memory in bytes.",
"type": "number"
},
"free_in_bytes": {
"description": "Amount of free physical memory in bytes.",
"type": "number"
},
"used_in_bytes": {
"description": "Amount of used physical memory in bytes.",
"type": "number"
}
}
},
"nodes._types.Cgroup": {
"type": "object",
"properties": {
"cpuacct": {
"description": "Contains statistics about `cpuacct` control group for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.CpuAcct"
}
]
},
"cpu": {
"description": "Contains statistics about `cpu` control group for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.CgroupCpu"
}
]
},
"memory": {
"description": "Contains statistics about the memory control group for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.CgroupMemory"
}
]
}
}
},
"nodes._types.CpuAcct": {
"type": "object",
"properties": {
"control_group": {
"description": "The `cpuacct` control group to which the Elasticsearch process belongs.",
"type": "string"
},
"usage_nanos": {
"description": "The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
}
}
},
"nodes._types.CgroupCpu": {
"type": "object",
"properties": {
"control_group": {
"description": "The `cpu` control group to which the Elasticsearch process belongs.",
"type": "string"
},
"cfs_period_micros": {
"description": "The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated.",
"type": "number"
},
"cfs_quota_micros": {
"description": "The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period `cfs_period_micros`.",
"type": "number"
},
"stat": {
"description": "Contains CPU statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.CgroupCpuStat"
}
]
}
}
},
"nodes._types.CgroupCpuStat": {
"type": "object",
"properties": {
"number_of_elapsed_periods": {
"description": "The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed.",
"type": "number"
},
"number_of_times_throttled": {
"description": "The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled.",
"type": "number"
},
"time_throttled_nanos": {
"description": "The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
}
}
},
"nodes._types.CgroupMemory": {
"type": "object",
"properties": {
"control_group": {
"description": "The `memory` control group to which the Elasticsearch process belongs.",
"type": "string"
},
"limit_in_bytes": {
"description": "The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process.\nThis value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns.\nAny value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup.",
"type": "string"
},
"usage_in_bytes": {
"description": "The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process.\nThis value is stored as a string for consistency with `limit_in_bytes`.",
"type": "string"
}
}
},
"nodes._types.Process": {
"type": "object",
"properties": {
"cpu": {
"description": "Contains CPU statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.Cpu"
}
]
},
"mem": {
"description": "Contains virtual memory statistics for the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.MemoryStats"
}
]
},
"open_file_descriptors": {
"description": "Number of opened file descriptors associated with the current or `-1` if not supported.",
"type": "number"
},
"max_file_descriptors": {
"description": "Maximum number of file descriptors allowed on the system, or `-1` if not supported.",
"type": "number"
},
"timestamp": {
"description": "Last time the statistics were refreshed.\nRecorded in milliseconds since the Unix Epoch.",
"type": "number"
}
}
},
"nodes._types.ScriptCache": {
"type": "object",
"properties": {
"cache_evictions": {
"description": "Total number of times the script cache has evicted old data.",
"type": "number"
},
"compilation_limit_triggered": {
"description": "Total number of times the script compilation circuit breaker has limited inline script compilations.",
"type": "number"
},
"compilations": {
"description": "Total number of inline script compilations performed by the node.",
"type": "number"
},
"context": {
"type": "string"
}
}
},
"nodes._types.Transport": {
"type": "object",
"properties": {
"inbound_handling_time_histogram": {
"description": "The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.",
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.TransportHistogram"
}
},
"outbound_handling_time_histogram": {
"description": "The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.",
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.TransportHistogram"
}
},
"rx_count": {
"description": "Total number of RX (receive) packets received by the node during internal cluster communication.",
"type": "number"
},
"rx_size": {
"description": "Size of RX packets received by the node during internal cluster communication.",
"type": "string"
},
"rx_size_in_bytes": {
"description": "Size, in bytes, of RX packets received by the node during internal cluster communication.",
"type": "number"
},
"server_open": {
"description": "Current number of inbound TCP connections used for internal communication between nodes.",
"type": "number"
},
"tx_count": {
"description": "Total number of TX (transmit) packets sent by the node during internal cluster communication.",
"type": "number"
},
"tx_size": {
"description": "Size of TX packets sent by the node during internal cluster communication.",
"type": "string"
},
"tx_size_in_bytes": {
"description": "Size, in bytes, of TX packets sent by the node during internal cluster communication.",
"type": "number"
},
"total_outbound_connections": {
"description": "The cumulative number of outbound transport connections that this node has opened since it started.\nEach transport connection may comprise multiple TCP connections but is only counted once in this statistic.\nTransport connections are typically long-lived so this statistic should remain constant in a stable cluster.",
"type": "number"
}
}
},
"nodes._types.TransportHistogram": {
"type": "object",
"properties": {
"count": {
"description": "The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.",
"type": "number"
},
"lt_millis": {
"description": "The exclusive upper bound of the bucket in milliseconds.\nMay be omitted on the last bucket if this bucket has no upper bound.",
"type": "number"
},
"ge_millis": {
"description": "The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound.",
"type": "number"
}
}
},
"nodes._types.Discovery": {
"type": "object",
"properties": {
"cluster_state_queue": {
"description": "Contains statistics for the cluster state queue of the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.ClusterStateQueue"
}
]
},
"published_cluster_states": {
"description": "Contains statistics for the published cluster states of the node.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.PublishedClusterStates"
}
]
},
"cluster_state_update": {
"description": "Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master.\nOmitted if the node is not master-eligible.\nEvery field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`.\nThe human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes._types.ClusterStateUpdate"
}
},
"serialized_cluster_states": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.SerializedClusterState"
}
]
},
"cluster_applier_stats": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.ClusterAppliedStats"
}
]
}
}
},
"nodes._types.ClusterStateQueue": {
"type": "object",
"properties": {
"total": {
"description": "Total number of cluster states in queue.",
"type": "number"
},
"pending": {
"description": "Number of pending cluster states in queue.",
"type": "number"
},
"committed": {
"description": "Number of committed cluster states in queue.",
"type": "number"
}
}
},
"nodes._types.PublishedClusterStates": {
"type": "object",
"properties": {
"full_states": {
"description": "Number of published cluster states.",
"type": "number"
},
"incompatible_diffs": {
"description": "Number of incompatible differences between published cluster states.",
"type": "number"
},
"compatible_diffs": {
"description": "Number of compatible differences between published cluster states.",
"type": "number"
}
}
},
"nodes._types.ClusterStateUpdate": {
"type": "object",
"properties": {
"count": {
"description": "The number of cluster state update attempts that did not change the cluster state since the node started.",
"type": "number"
},
"computation_time": {
"description": "The cumulative amount of time spent computing no-op cluster state updates since the node started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"computation_time_millis": {
"description": "The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"publication_time": {
"description": "The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.\nThis includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"publication_time_millis": {
"description": "The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.\nThis includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"context_construction_time": {
"description": "The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded.\nThis statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"context_construction_time_millis": {
"description": "The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded.\nThis statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"commit_time": {
"description": "The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"commit_time_millis": {
"description": "The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"completion_time": {
"description": "The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"completion_time_millis": {
"description": "The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"master_apply_time": {
"description": "The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"master_apply_time_millis": {
"description": "The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"notification_time": {
"description": "The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"notification_time_millis": {
"description": "The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"count"
]
},
"nodes._types.SerializedClusterState": {
"type": "object",
"properties": {
"full_states": {
"description": "Number of published cluster states.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.SerializedClusterStateDetail"
}
]
},
"diffs": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.SerializedClusterStateDetail"
}
]
}
}
},
"nodes._types.SerializedClusterStateDetail": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"uncompressed_size": {
"type": "string"
},
"uncompressed_size_in_bytes": {
"type": "number"
},
"compressed_size": {
"type": "string"
},
"compressed_size_in_bytes": {
"type": "number"
}
}
},
"nodes._types.ClusterAppliedStats": {
"type": "object",
"properties": {
"recordings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes._types.Recording"
}
}
}
},
"nodes._types.Recording": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"cumulative_execution_count": {
"type": "number"
},
"cumulative_execution_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"cumulative_execution_time_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
}
},
"nodes._types.IndexingPressure": {
"type": "object",
"properties": {
"memory": {
"description": "Contains statistics for memory consumption from indexing load.",
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.IndexingPressureMemory"
}
]
}
}
},
"nodes.usage.NodesUsageMetrics": {
"oneOf": [
{
"$ref": "#/components/schemas/nodes.usage.NodesUsageMetric"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/nodes.usage.NodesUsageMetric"
}
}
]
},
"nodes.usage.NodesUsageMetric": {
"type": "string",
"enum": [
"_all",
"rest_actions",
"aggregations"
]
},
"nodes.usage.ResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/nodes._types.NodesResponseBase"
},
{
"type": "object",
"properties": {
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/nodes.usage.NodeUsage"
}
}
},
"required": [
"cluster_name",
"nodes"
]
}
]
},
"nodes.usage.NodeUsage": {
"type": "object",
"properties": {
"rest_actions": {
"description": "The total number of times each REST endpoint has been called on this node since the last restart.\n Note that the REST endpoint names are not considered stable.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"since": {
"description": "The timestamp for when the collection of these statistics started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"timestamp": {
"description": "The timestamp for when these statistics were collected.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"aggregations": {
"description": "The total number of times search aggregations have been called on this node since the last restart.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"rest_actions",
"since",
"timestamp",
"aggregations"
]
},
"query_rules._types.QueryRule": {
"type": "object",
"properties": {
"rule_id": {
"description": "A unique identifier for the rule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"type": {
"description": "The type of rule.\n`pinned` will identify and pin specific documents to the top of search results.\n`exclude` will exclude specific documents from search results.",
"allOf": [
{
"$ref": "#/components/schemas/query_rules._types.QueryRuleType"
}
]
},
"criteria": {
"description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.",
"oneOf": [
{
"$ref": "#/components/schemas/query_rules._types.QueryRuleCriteria"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/query_rules._types.QueryRuleCriteria"
}
}
]
},
"actions": {
"description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.",
"allOf": [
{
"$ref": "#/components/schemas/query_rules._types.QueryRuleActions"
}
]
},
"priority": {
"type": "number"
}
},
"required": [
"rule_id",
"type",
"criteria",
"actions"
]
},
"query_rules._types.QueryRuleType": {
"type": "string",
"enum": [
"pinned",
"exclude"
]
},
"query_rules._types.QueryRuleCriteria": {
"type": "object",
"properties": {
"type": {
"description": "The type of criteria. The following criteria types are supported:\n\n* `always`: Matches all queries, regardless of input.\n* `contains`: Matches that contain this value anywhere in the field meet the criteria defined by the rule. Only applicable for string values.\n* `exact`: Only exact matches meet the criteria defined by the rule. Applicable for string or numerical values.\n* `fuzzy`: Exact matches or matches within the allowed Levenshtein Edit Distance meet the criteria defined by the rule. Only applicable for string values.\n* `gt`: Matches with a value greater than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `gte`: Matches with a value greater than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lt`: Matches with a value less than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lte`: Matches with a value less than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `prefix`: Matches that start with this value meet the criteria defined by the rule. Only applicable for string values.\n* `suffix`: Matches that end with this value meet the criteria defined by the rule. Only applicable for string values.",
"allOf": [
{
"$ref": "#/components/schemas/query_rules._types.QueryRuleCriteriaType"
}
]
},
"metadata": {
"description": "The metadata field to match against.\nThis metadata will be used to match against `match_criteria` sent in the rule.\nIt is required for all criteria types except `always`.",
"type": "string"
},
"values": {
"description": "The values to match against the `metadata` field.\nOnly one value must match for the criteria to be met.\nIt is required for all criteria types except `always`.",
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"type"
]
},
"query_rules._types.QueryRuleCriteriaType": {
"type": "string",
"enum": [
"global",
"exact",
"fuzzy",
"prefix",
"suffix",
"contains",
"lt",
"lte",
"gt",
"gte",
"always"
]
},
"query_rules._types.QueryRuleActions": {
"type": "object",
"properties": {
"ids": {
"description": "The unique document IDs of the documents to apply the rule to.\nOnly one of `ids` or `docs` may be specified and at least one must be specified.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
},
"docs": {
"description": "The documents to apply the rule to.\nOnly one of `ids` or `docs` may be specified and at least one must be specified.\nThere is a maximum value of 100 documents in a rule.\nYou can specify the following attributes for each document:\n\n* `_index`: The index of the document to pin.\n* `_id`: The unique document ID.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.PinnedDoc"
}
}
}
},
"query_rules._types.QueryRuleset": {
"type": "object",
"properties": {
"ruleset_id": {
"description": "A unique identifier for the ruleset.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"rules": {
"description": "Rules associated with the query ruleset.",
"type": "array",
"items": {
"$ref": "#/components/schemas/query_rules._types.QueryRule"
}
}
},
"required": [
"ruleset_id",
"rules"
]
},
"query_rules.list_rulesets.QueryRulesetListItem": {
"type": "object",
"properties": {
"ruleset_id": {
"description": "A unique identifier for the ruleset.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"rule_total_count": {
"description": "The number of rules associated with the ruleset.",
"type": "number"
},
"rule_criteria_types_counts": {
"description": "A map of criteria type (for example, `exact`) to the number of rules of that type.\n\nNOTE: The counts in `rule_criteria_types_counts` may be larger than the value of `rule_total_count` because a rule may have multiple criteria.",
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"rule_type_counts": {
"description": "A map of rule type (for example, `pinned`) to the number of rules of that type.",
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"ruleset_id",
"rule_total_count",
"rule_criteria_types_counts",
"rule_type_counts"
]
},
"query_rules.test.QueryRulesetMatchedRule": {
"type": "object",
"properties": {
"ruleset_id": {
"description": "Ruleset unique identifier",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"rule_id": {
"description": "Rule unique identifier within that ruleset",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
},
"required": [
"ruleset_id",
"rule_id"
]
},
"_global.rank_eval.RankEvalRequestItem": {
"type": "object",
"properties": {
"id": {
"description": "The search request’s ID, used to group result details later.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"request": {
"description": "The query being evaluated.",
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalQuery"
}
]
},
"ratings": {
"description": "List of document ratings",
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.rank_eval.DocumentRating"
}
},
"template_id": {
"description": "The search template Id",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"params": {
"description": "The search template parameters.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"id",
"ratings"
]
},
"_global.rank_eval.RankEvalQuery": {
"type": "object",
"properties": {
"query": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"size": {
"type": "number"
}
},
"required": [
"query"
]
},
"_global.rank_eval.DocumentRating": {
"type": "object",
"properties": {
"_id": {
"description": "The document ID.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "The document’s index. For data streams, this should be the document’s backing index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"rating": {
"description": "The document’s relevance with regard to this search request.",
"type": "number"
}
},
"required": [
"_id",
"_index",
"rating"
]
},
"_global.rank_eval.RankEvalMetric": {
"type": "object",
"properties": {
"precision": {
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricPrecision"
}
]
},
"recall": {
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRecall"
}
]
},
"mean_reciprocal_rank": {
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricMeanReciprocalRank"
}
]
},
"dcg": {
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricDiscountedCumulativeGain"
}
]
},
"expected_reciprocal_rank": {
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricExpectedReciprocalRank"
}
]
}
}
},
"_global.rank_eval.RankEvalMetricPrecision": {
"description": "Precision at K (P@k)",
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold"
},
{
"type": "object",
"properties": {
"ignore_unlabeled": {
"description": "Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant.",
"default": false,
"type": "boolean"
}
}
}
]
},
"_global.rank_eval.RankEvalMetricRatingTreshold": {
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase"
},
{
"type": "object",
"properties": {
"relevant_rating_threshold": {
"description": "Sets the rating threshold above which documents are considered to be \"relevant\".",
"default": 1,
"type": "number"
}
}
}
]
},
"_global.rank_eval.RankEvalMetricBase": {
"type": "object",
"properties": {
"k": {
"description": "Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.",
"default": 10,
"type": "number"
}
}
},
"_global.rank_eval.RankEvalMetricRecall": {
"description": "Recall at K (R@k)",
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold"
},
{
"type": "object"
}
]
},
"_global.rank_eval.RankEvalMetricMeanReciprocalRank": {
"description": "Mean Reciprocal Rank",
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold"
},
{
"type": "object"
}
]
},
"_global.rank_eval.RankEvalMetricDiscountedCumulativeGain": {
"description": "Discounted cumulative gain (DCG)",
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase"
},
{
"type": "object",
"properties": {
"normalize": {
"description": "If set to true, this metric will calculate the Normalized DCG.",
"default": false,
"type": "boolean"
}
}
}
]
},
"_global.rank_eval.RankEvalMetricExpectedReciprocalRank": {
"description": "Expected Reciprocal Rank (ERR)",
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase"
},
{
"type": "object",
"properties": {
"maximum_relevance": {
"description": "The highest relevance grade used in the user-supplied relevance judgments.",
"type": "number"
}
},
"required": [
"maximum_relevance"
]
}
]
},
"_global.rank_eval.RankEvalMetricDetail": {
"type": "object",
"properties": {
"metric_score": {
"description": "The metric_score in the details section shows the contribution of this query to the global quality metric score",
"type": "number"
},
"unrated_docs": {
"description": "The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents",
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.rank_eval.UnratedDocument"
}
},
"hits": {
"description": "The hits section shows a grouping of the search results with their supplied ratings",
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.rank_eval.RankEvalHitItem"
}
},
"metric_details": {
"description": "The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"required": [
"metric_score",
"unrated_docs",
"hits",
"metric_details"
]
},
"_global.rank_eval.UnratedDocument": {
"type": "object",
"properties": {
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"_id",
"_index"
]
},
"_global.rank_eval.RankEvalHitItem": {
"type": "object",
"properties": {
"hit": {
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalHit"
}
]
},
"rating": {
"oneOf": [
{
"type": "number"
},
{
"nullable": true,
"type": "string"
}
]
}
},
"required": [
"hit"
]
},
"_global.rank_eval.RankEvalHit": {
"type": "object",
"properties": {
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_score": {
"type": "number"
}
},
"required": [
"_id",
"_index",
"_score"
]
},
"_global.reindex.Destination": {
"type": "object",
"properties": {
"index": {
"description": "The name of the data stream, index, or index alias you are copying to.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"op_type": {
"description": "If it is `create`, the operation will only index documents that do not already exist (also known as \"put if absent\").\n\nIMPORTANT: To reindex to a data stream destination, this argument must be `create`.\n\nSupported values include:\n - `index`: Overwrite any documents that already exist.\n - `create`: Only index documents that do not already exist.\n\n",
"default": "index",
"allOf": [
{
"$ref": "#/components/schemas/_types.OpType"
}
]
},
"pipeline": {
"description": "The name of the pipeline to use.",
"type": "string"
},
"routing": {
"description": "By default, a document's routing is preserved unless it's changed by the script.\nIf it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.\nIf it is `discard`, the routing on the bulk request sent for each match is set to `null`.\nIf it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`).",
"default": "keep",
"type": "string"
},
"version_type": {
"description": "The versioning to use for the indexing operation.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionType"
}
]
}
},
"required": [
"index"
]
},
"_global.reindex.Source": {
"type": "object",
"properties": {
"index": {
"description": "The name of the data stream, index, or alias you are copying from.\nIt accepts a comma-separated list to reindex from multiple sources.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"query": {
"description": "The documents to reindex, which is defined with Query DSL.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"remote": {
"description": "A remote instance of Elasticsearch that you want to index from.",
"x-state": "Generally available; Added in 5.0.0",
"allOf": [
{
"$ref": "#/components/schemas/_global.reindex.RemoteSource"
}
]
},
"size": {
"description": "The number of documents to index per batch.\nUse it when you are indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.",
"default": 1000,
"type": "number"
},
"slice": {
"description": "Slice the reindex request manually using the provided slice ID and total number of slices.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SlicedScroll"
}
]
},
"sort": {
"deprecated": true,
"description": "A comma-separated list of `:` pairs to sort by before indexing.\nUse it in conjunction with `max_docs` to control what documents are reindexed.\n\nWARNING: Sort in reindex is deprecated.\nSorting in reindex was never guaranteed to index documents in order and prevents further development of reindex such as resilience and performance improvements.\nIf used in combination with `max_docs`, consider using a query filter instead.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"_source": {
"description": "If `true`, reindex all source fields.\nSet it to a list to reindex select fields.",
"default": "true",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"runtime_mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
}
},
"required": [
"index"
]
},
"_global.reindex.RemoteSource": {
"type": "object",
"properties": {
"connect_timeout": {
"description": "The remote connection timeout.",
"default": "30s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"headers": {
"description": "An object containing the headers of the request.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"host": {
"description": "The URL for the remote instance of Elasticsearch that you want to index from.\nThis information is required when you're indexing from remote.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"username": {
"description": "The username to use for authentication with the remote host (required when using basic auth).",
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
},
"password": {
"description": "The password to use for authentication with the remote host (required when using basic auth).",
"allOf": [
{
"$ref": "#/components/schemas/_types.Password"
}
]
},
"api_key": {
"description": "The API key to use for authentication with the remote host (as an alternative to basic auth when the remote cluster is in Elastic Cloud).\n(It is not permitted to set this and also to set an `Authorization` header via `headers`.)",
"x-state": "Generally available; Added in 9.3.0",
"type": "string"
},
"socket_timeout": {
"description": "The remote socket read timeout.",
"default": "30s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"host"
]
},
"_types.Username": {
"type": "string"
},
"tasks._types.GroupBy": {
"type": "string",
"enum": [
"nodes",
"parents",
"none"
]
},
"_global.reindex_rethrottle.ReindexNode": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.BaseNode"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.reindex_rethrottle.ReindexTask"
}
}
},
"required": [
"tasks"
]
}
]
},
"_global.reindex_rethrottle.ReindexTask": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"cancellable": {
"type": "boolean"
},
"cancelled": {
"type": "boolean"
},
"description": {
"type": "string"
},
"id": {
"type": "number"
},
"node": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"running_time_in_nanos": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"start_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/_global.reindex_rethrottle.ParentReindexStatus"
}
]
},
"type": {
"type": "string"
},
"headers": {
"allOf": [
{
"$ref": "#/components/schemas/_types.HttpHeaders"
}
]
}
},
"required": [
"action",
"cancellable",
"cancelled",
"description",
"id",
"node",
"running_time_in_nanos",
"start_time_in_millis",
"status",
"type",
"headers"
]
},
"_global.reindex_rethrottle.ParentReindexStatus": {
"type": "object",
"properties": {
"slices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ReindexStatus"
}
},
"slice_id": {
"description": "The slice ID",
"type": "number"
},
"batches": {
"description": "The number of scroll responses pulled back by the reindex.",
"type": "number"
},
"created": {
"description": "The number of documents that were successfully created.",
"type": "number"
},
"deleted": {
"description": "The number of documents that were successfully deleted.",
"type": "number"
},
"noops": {
"description": "The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.",
"type": "number"
},
"requests_per_second": {
"description": "The number of requests per second effectively executed during the reindex.",
"type": "number"
},
"retries": {
"description": "The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Retries"
}
]
},
"throttled": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_millis": {
"description": "Number of milliseconds the request slept to conform to `requests_per_second`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"throttled_until": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_until_millis": {
"description": "This field should always be equal to zero in a `_reindex` response.\nIt only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total": {
"description": "The number of documents that were successfully processed.",
"type": "number"
},
"updated": {
"description": "The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.",
"type": "number"
},
"version_conflicts": {
"description": "The number of version conflicts that reindex hits.",
"type": "number"
},
"cancelled": {
"description": "The reason for cancellation if the slice was canceled",
"type": "string"
}
},
"required": [
"batches",
"deleted",
"noops",
"requests_per_second",
"retries",
"throttled_millis",
"throttled_until_millis",
"total",
"version_conflicts"
]
},
"_spec_utils.BaseNode": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"host": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"ip": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Ip"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"roles": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeRoles"
}
]
},
"transport_address": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
}
},
"required": [
"attributes",
"host",
"ip",
"name",
"transport_address"
]
},
"_global.reindex_rethrottle.ReindexTasks": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.reindex_rethrottle.ReindexTask"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.reindex_rethrottle.ParentReindexTask"
}
}
]
},
"_global.reindex_rethrottle.ParentReindexTask": {
"allOf": [
{
"$ref": "#/components/schemas/_global.reindex_rethrottle.ReindexTask"
},
{
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.reindex_rethrottle.ReindexTask"
}
}
}
}
]
},
"rollup.get_jobs.RollupJob": {
"type": "object",
"properties": {
"config": {
"description": "The rollup job configuration.",
"allOf": [
{
"$ref": "#/components/schemas/rollup.get_jobs.RollupJobConfiguration"
}
]
},
"stats": {
"description": "Transient statistics about the rollup job, such as how many documents have been processed and how many rollup summary docs have been indexed.\nThese stats are not persisted.\nIf a node is restarted, these stats are reset.",
"allOf": [
{
"$ref": "#/components/schemas/rollup.get_jobs.RollupJobStats"
}
]
},
"status": {
"description": "The current status of the indexer for the rollup job.",
"allOf": [
{
"$ref": "#/components/schemas/rollup.get_jobs.RollupJobStatus"
}
]
}
},
"required": [
"config",
"stats",
"status"
]
},
"rollup.get_jobs.RollupJobConfiguration": {
"type": "object",
"properties": {
"cron": {
"type": "string"
},
"groups": {
"allOf": [
{
"$ref": "#/components/schemas/rollup._types.Groupings"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"index_pattern": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/rollup._types.FieldMetric"
}
},
"page_size": {
"type": "number"
},
"rollup_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"timeout": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"cron",
"groups",
"id",
"index_pattern",
"metrics",
"page_size",
"rollup_index",
"timeout"
]
},
"rollup._types.Groupings": {
"type": "object",
"properties": {
"date_histogram": {
"description": "A date histogram group aggregates a date field into time-based buckets.\nThis group is mandatory; you currently cannot roll up documents without a timestamp and a `date_histogram` group.",
"allOf": [
{
"$ref": "#/components/schemas/rollup._types.DateHistogramGrouping"
}
]
},
"histogram": {
"description": "The histogram group aggregates one or more numeric fields into numeric histogram intervals.",
"allOf": [
{
"$ref": "#/components/schemas/rollup._types.HistogramGrouping"
}
]
},
"terms": {
"description": "The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point.\nThe indexer enumerates and stores all values of a field for each time-period.\nThis can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse.",
"allOf": [
{
"$ref": "#/components/schemas/rollup._types.TermsGrouping"
}
]
}
}
},
"rollup._types.DateHistogramGrouping": {
"type": "object",
"properties": {
"delay": {
"description": "How long to wait before rolling up new documents.\nBy default, the indexer attempts to roll up all data that is available.\nHowever, it is not uncommon for data to arrive out of order.\nThe indexer is unable to deal with data that arrives after a time-span has been rolled up.\nYou need to specify a delay that matches the longest period of time you expect out-of-order data to arrive.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"field": {
"description": "The date field that is to be rolled up.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"format": {
"type": "string"
},
"interval": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"calendar_interval": {
"description": "The interval of time buckets to be generated when rolling up.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"fixed_interval": {
"description": "The interval of time buckets to be generated when rolling up.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_zone": {
"description": "Defines what `time_zone` the rollup documents are stored as.\nUnlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone.\nBy default, rollup documents are stored in `UTC`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
}
},
"required": [
"field"
]
},
"rollup._types.HistogramGrouping": {
"type": "object",
"properties": {
"fields": {
"description": "The set of fields that you wish to build histograms for.\nAll fields specified must be some kind of numeric.\nOrder does not matter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"interval": {
"description": "The interval of histogram buckets to be generated when rolling up.\nFor example, a value of `5` creates buckets that are five units wide (`0-5`, `5-10`, etc).\nNote that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval.",
"type": "number"
}
},
"required": [
"fields",
"interval"
]
},
"rollup._types.TermsGrouping": {
"type": "object",
"properties": {
"fields": {
"description": "The set of fields that you wish to collect terms for.\nThis array can contain fields that are both keyword and numerics.\nOrder does not matter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
}
},
"required": [
"fields"
]
},
"rollup._types.FieldMetric": {
"type": "object",
"properties": {
"field": {
"description": "The field to collect metrics for. This must be a numeric of some kind.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"metrics": {
"description": "An array of metrics to collect for the field. At least one metric must be configured.",
"type": "array",
"items": {
"$ref": "#/components/schemas/rollup._types.Metric"
}
}
},
"required": [
"field",
"metrics"
]
},
"rollup._types.Metric": {
"type": "string",
"enum": [
"min",
"max",
"sum",
"avg",
"value_count"
]
},
"rollup.get_jobs.RollupJobStats": {
"type": "object",
"properties": {
"documents_processed": {
"type": "number"
},
"index_failures": {
"type": "number"
},
"index_time_in_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"index_total": {
"type": "number"
},
"pages_processed": {
"type": "number"
},
"rollups_indexed": {
"type": "number"
},
"search_failures": {
"type": "number"
},
"search_time_in_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"search_total": {
"type": "number"
},
"trigger_count": {
"type": "number"
},
"processing_time_in_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"processing_total": {
"type": "number"
}
},
"required": [
"documents_processed",
"index_failures",
"index_time_in_ms",
"index_total",
"pages_processed",
"rollups_indexed",
"search_failures",
"search_time_in_ms",
"search_total",
"trigger_count",
"processing_time_in_ms",
"processing_total"
]
},
"rollup.get_jobs.RollupJobStatus": {
"type": "object",
"properties": {
"current_position": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"job_state": {
"allOf": [
{
"$ref": "#/components/schemas/rollup.get_jobs.IndexingJobState"
}
]
},
"upgraded_doc_id": {
"type": "boolean"
}
},
"required": [
"job_state"
]
},
"rollup.get_jobs.IndexingJobState": {
"type": "string",
"enum": [
"started",
"indexing",
"stopping",
"stopped",
"aborting"
]
},
"rollup.get_rollup_caps.RollupCapabilities": {
"type": "object",
"properties": {
"rollup_jobs": {
"description": "There can be multiple, independent jobs configured for a single index or index pattern. Each of these jobs may have different configurations, so the API returns a list of all the various configurations available.",
"type": "array",
"items": {
"$ref": "#/components/schemas/rollup.get_rollup_caps.RollupCapabilitySummary"
}
}
},
"required": [
"rollup_jobs"
]
},
"rollup.get_rollup_caps.RollupCapabilitySummary": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/rollup.get_rollup_caps.RollupFieldSummary"
}
}
},
"index_pattern": {
"type": "string"
},
"job_id": {
"type": "string"
},
"rollup_index": {
"type": "string"
}
},
"required": [
"fields",
"index_pattern",
"job_id",
"rollup_index"
]
},
"rollup.get_rollup_caps.RollupFieldSummary": {
"type": "object",
"properties": {
"agg": {
"type": "string"
},
"calendar_interval": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_zone": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
}
},
"required": [
"agg"
]
},
"rollup.get_rollup_index_caps.IndexCapabilities": {
"type": "object",
"properties": {
"rollup_jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/rollup.get_rollup_index_caps.RollupJobSummary"
}
}
},
"required": [
"rollup_jobs"
]
},
"rollup.get_rollup_index_caps.RollupJobSummary": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/rollup.get_rollup_index_caps.RollupJobSummaryField"
}
}
},
"index_pattern": {
"type": "string"
},
"job_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"rollup_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"fields",
"index_pattern",
"job_id",
"rollup_index"
]
},
"rollup.get_rollup_index_caps.RollupJobSummaryField": {
"type": "object",
"properties": {
"agg": {
"type": "string"
},
"time_zone": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
},
"calendar_interval": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"agg"
]
},
"_global.scripts_painless_execute.PainlessContext": {
"type": "string",
"enum": [
"painless_test",
"filter",
"score",
"boolean_field",
"date_field",
"double_field",
"geo_point_field",
"ip_field",
"keyword_field",
"long_field",
"composite_field"
]
},
"_global.scripts_painless_execute.PainlessContextSetup": {
"type": "object",
"properties": {
"document": {
"description": "Document that's temporarily indexed in-memory and accessible from the script.",
"type": "object"
},
"index": {
"description": "Index containing a mapping that's compatible with the indexed document.\nYou may specify a remote index by prefixing the index with the remote cluster alias.\nFor example, `remote1:my_index` indicates that you want to run the painless script against the \"my_index\" index on the \"remote1\" cluster.\nThis request will be forwarded to the \"remote1\" cluster if you have configured a connection to that remote cluster.\n\nNOTE: Wildcards are not accepted in the index expression for this endpoint.\nThe expression `*:myindex` will return the error \"No such remote cluster\" and the expression `logs*` or `remote1:logs*` will return the error \"index not found\".",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"query": {
"description": "Use this parameter to specify a query for computing a score.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"document",
"index"
]
},
"search_application._types.SearchApplication": {
"allOf": [
{
"$ref": "#/components/schemas/search_application._types.SearchApplicationParameters"
},
{
"type": "object",
"properties": {
"name": {
"description": "Search Application name",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"updated_at_millis": {
"description": "Last time the Search Application was updated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"name",
"updated_at_millis"
]
}
]
},
"search_application._types.SearchApplicationParameters": {
"type": "object",
"properties": {
"indices": {
"description": "Indices that are part of the Search Application.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
},
"analytics_collection_name": {
"description": "Analytics collection associated to the Search Application.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"template": {
"description": "Search template to use on search operations.",
"allOf": [
{
"$ref": "#/components/schemas/search_application._types.SearchApplicationTemplate"
}
]
}
},
"required": [
"indices"
]
},
"search_application._types.SearchApplicationTemplate": {
"type": "object",
"properties": {
"script": {
"description": "The associated mustache template.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"script"
]
},
"search_application._types.AnalyticsCollection": {
"type": "object",
"properties": {
"event_data_stream": {
"description": "Data stream for the collection.",
"allOf": [
{
"$ref": "#/components/schemas/search_application._types.EventDataStream"
}
]
}
},
"required": [
"event_data_stream"
]
},
"search_application._types.EventDataStream": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"name"
]
},
"search_application._types.EventType": {
"type": "string",
"enum": [
"page_view",
"search",
"search_click"
]
},
"search_application.put_behavioral_analytics.AnalyticsAcknowledgeResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
{
"type": "object",
"properties": {
"name": {
"description": "The name of the analytics collection created or updated",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"name"
]
}
]
},
"_global.search_mvt._types.ZoomLevel": {
"type": "number"
},
"_global.search_mvt._types.Coordinate": {
"type": "number"
},
"_global.search_mvt._types.GridAggregationType": {
"type": "string",
"enum": [
"geotile",
"geohex"
]
},
"_global.search_mvt._types.GridType": {
"type": "string",
"enum": [
"grid",
"point",
"centroid"
]
},
"_types.MapboxVectorTiles": {
"type": "object"
},
"_global.search_shards.SearchShardsNodeAttributes": {
"type": "object",
"properties": {
"name": {
"description": "The human-readable identifier of the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeName"
}
]
},
"ephemeral_id": {
"description": "The ephemeral ID of the node.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"transport_address": {
"description": "The host and port where transport HTTP connections are accepted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TransportAddress"
}
]
},
"external_id": {
"x-state": "Generally available; Added in 8.3.0",
"type": "string"
},
"attributes": {
"description": "Lists node attributes.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"roles": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeRoles"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"min_index_version": {
"type": "number"
},
"max_index_version": {
"type": "number"
}
},
"required": [
"name",
"ephemeral_id",
"transport_address",
"external_id",
"attributes",
"roles",
"version",
"min_index_version",
"max_index_version"
]
},
"_types.NodeShard": {
"type": "object",
"properties": {
"state": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.ShardRoutingState"
}
]
},
"primary": {
"type": "boolean"
},
"node": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeName"
}
]
},
"shard": {
"type": "number"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"allocation_id": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.Id"
}
},
"recovery_source": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.Id"
}
},
"unassigned_info": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformation"
}
]
},
"relocating_node": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
},
{
"nullable": true,
"type": "string"
}
]
},
"relocation_failure_info": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RelocationFailureInfo"
}
]
}
},
"required": [
"state",
"primary",
"shard",
"index"
]
},
"_types.RelocationFailureInfo": {
"type": "object",
"properties": {
"failed_attempts": {
"type": "number"
}
},
"required": [
"failed_attempts"
]
},
"_global.search_shards.ShardStoreIndex": {
"type": "object",
"properties": {
"aliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Name"
}
},
"filter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
}
},
"searchable_snapshots.cache_stats.Node": {
"type": "object",
"properties": {
"shared_cache": {
"allOf": [
{
"$ref": "#/components/schemas/searchable_snapshots.cache_stats.Shared"
}
]
}
},
"required": [
"shared_cache"
]
},
"searchable_snapshots.cache_stats.Shared": {
"type": "object",
"properties": {
"reads": {
"type": "number"
},
"bytes_read_in_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"writes": {
"type": "number"
},
"bytes_written_in_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"evictions": {
"type": "number"
},
"num_regions": {
"type": "number"
},
"size_in_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"region_size_in_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
},
"required": [
"reads",
"bytes_read_in_bytes",
"writes",
"bytes_written_in_bytes",
"evictions",
"num_regions",
"size_in_bytes",
"region_size_in_bytes"
]
},
"searchable_snapshots.mount.StorageOption": {
"type": "string",
"enum": [
"full_copy",
"shared_cache"
]
},
"searchable_snapshots.mount.MountedSnapshot": {
"type": "object",
"properties": {
"snapshot": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"indices": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
}
},
"required": [
"snapshot",
"indices",
"shards"
]
},
"searchable_snapshots._types.StatsLevel": {
"type": "string",
"enum": [
"cluster",
"indices",
"shards"
]
},
"security._types.GrantType": {
"type": "string",
"enum": [
"password",
"access_token"
]
},
"security._types.UserProfileWithMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.UserProfile"
},
{
"type": "object",
"properties": {
"last_synchronized": {
"type": "number"
},
"_doc": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.UserProfileHitMetadata"
}
]
}
},
"required": [
"last_synchronized",
"_doc"
]
}
]
},
"security._types.UserProfileHitMetadata": {
"type": "object",
"properties": {
"_primary_term": {
"type": "number"
},
"_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
}
},
"required": [
"_primary_term",
"_seq_no"
]
},
"security._types.UserProfile": {
"type": "object",
"properties": {
"uid": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.UserProfileId"
}
]
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.UserProfileUser"
}
]
},
"data": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"enabled": {
"type": "boolean"
}
},
"required": [
"uid",
"user",
"data",
"labels"
]
},
"security._types.UserProfileId": {
"type": "string"
},
"security._types.UserProfileUser": {
"type": "object",
"properties": {
"email": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"full_name": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Name"
},
{
"nullable": true,
"type": "string"
}
]
},
"realm_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"realm_domain": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
}
},
"required": [
"realm_name",
"roles",
"username"
]
},
"security.authenticate.AuthenticateApiKey": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"managed_by": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.CredentialManagedBy"
}
]
},
"internal": {
"type": "boolean"
}
},
"required": [
"id",
"managed_by"
]
},
"security._types.CredentialManagedBy": {
"type": "string",
"enum": [
"cloud",
"elasticsearch"
]
},
"security._types.RealmInfo": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
]
},
"security.authenticate.Token": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"type": {
"x-state": "Generally available; Added in 7.14.0",
"type": "string"
},
"managed_by": {
"x-state": "Generally available; Added in 9.4.0",
"allOf": [
{
"$ref": "#/components/schemas/security._types.CredentialManagedBy"
}
]
}
}
},
"security._types.BulkError": {
"type": "object",
"properties": {
"count": {
"description": "The number of errors",
"type": "number"
},
"details": {
"description": "Details about the errors, keyed by role name",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
}
},
"required": [
"count",
"details"
]
},
"security._types.RoleDescriptor": {
"type": "object",
"properties": {
"cluster": {
"description": "A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ClusterPrivilege"
}
},
"indices": {
"description": "A list of indices permissions entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndicesPrivileges"
}
},
"remote_indices": {
"description": "A list of indices permissions for remote clusters.",
"x-state": "Generally available; Added in 8.14.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteIndicesPrivileges"
}
},
"remote_cluster": {
"description": "A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.",
"x-state": "Generally available; Added in 8.15.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteClusterPrivileges"
}
},
"global": {
"description": "An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.",
"x-state": "Generally available",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.GlobalPrivilege"
}
},
{
"$ref": "#/components/schemas/security._types.GlobalPrivilege"
}
]
},
"applications": {
"description": "A list of application privilege entries",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ApplicationPrivileges"
}
},
"metadata": {
"description": "Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"run_as": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users"
},
"description": "A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.",
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"description": "Optional description of the role descriptor",
"type": "string"
},
"restriction": {
"description": "Restriction for when the role descriptor is allowed to be effective.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.Restriction"
}
]
},
"transient_metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"security._types.ClusterPrivilege": {
"anyOf": [
{
"type": "string",
"enum": [
"all",
"cancel_task",
"create_snapshot",
"cross_cluster_replication",
"cross_cluster_search",
"delegate_pki",
"grant_api_key",
"manage",
"manage_api_key",
"manage_autoscaling",
"manage_behavioral_analytics",
"manage_ccr",
"manage_data_frame_transforms",
"manage_data_stream_global_retention",
"manage_enrich",
"manage_esql",
"manage_ilm",
"manage_index_templates",
"manage_inference",
"manage_ingest_pipelines",
"manage_logstash_pipelines",
"manage_ml",
"manage_oidc",
"manage_own_api_key",
"manage_pipeline",
"manage_reindex",
"manage_rollup",
"manage_saml",
"manage_search_application",
"manage_search_query_rules",
"manage_search_synonyms",
"manage_security",
"manage_service_account",
"manage_slm",
"manage_token",
"manage_transform",
"manage_user_profile",
"manage_watcher",
"monitor",
"monitor_data_frame_transforms",
"monitor_data_stream_global_retention",
"monitor_enrich",
"monitor_esql",
"monitor_inference",
"monitor_ml",
"monitor_reindex",
"monitor_rollup",
"monitor_snapshot",
"monitor_stats",
"monitor_text_structure",
"monitor_transform",
"monitor_watcher",
"none",
"post_behavioral_analytics_event",
"read_ccr",
"read_fleet_secrets",
"read_ilm",
"read_pipeline",
"read_security",
"read_slm",
"transport_client",
"write_connector_secrets",
"write_fleet_secrets"
]
},
{
"type": "string"
}
]
},
"security._types.IndicesPrivileges": {
"type": "object",
"properties": {
"field_security": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level"
},
"description": "The document fields that the owners of the role have read access to.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.FieldSecurity"
}
]
},
"names": {
"description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
]
},
"privileges": {
"description": "The index level privileges that owners of the role have on the specified indices.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndexPrivilege"
}
},
"query": {
"description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery"
}
]
},
"allow_restricted_indices": {
"description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.",
"default": false,
"x-state": "Generally available",
"type": "boolean"
}
},
"required": [
"names",
"privileges"
]
},
"security._types.FieldSecurity": {
"type": "object",
"properties": {
"except": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"grant": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
}
}
},
"security._types.IndexPrivilege": {
"anyOf": [
{
"type": "string",
"enum": [
"all",
"auto_configure",
"create",
"create_doc",
"create_index",
"create_view",
"cross_cluster_replication",
"cross_cluster_replication_internal",
"delete",
"delete_index",
"delete_view",
"index",
"maintenance",
"manage",
"manage_data_stream_lifecycle",
"manage_follow_index",
"manage_ilm",
"manage_leader_index",
"manage_view",
"monitor",
"none",
"read",
"read_cross_cluster",
"read_view_metadata",
"view_index_metadata",
"write"
]
},
{
"type": "string"
}
]
},
"security._types.IndicesPrivilegesQuery": {
"description": "While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"$ref": "#/components/schemas/security._types.RoleTemplateQuery"
}
]
},
"security._types.RoleTemplateQuery": {
"type": "object",
"properties": {
"template": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query"
},
"description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.RoleTemplateScript"
}
]
}
}
},
"security._types.RoleTemplateScript": {
"type": "object",
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.RoleTemplateInlineQuery"
}
]
},
"id": {
"description": "The `id` for a stored script.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"params": {
"description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"lang": {
"description": "Specifies the language the script is written in.\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
"default": "painless",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptLanguage"
}
]
},
"options": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"x-model": true,
"externalDocs": {
"description": "Templating a role query",
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query"
}
},
"security._types.RoleTemplateInlineQuery": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"security._types.RemoteIndicesPrivileges": {
"description": "The subset of index level privileges that can be defined for remote clusters.",
"type": "object",
"properties": {
"clusters": {
"description": "A list of cluster aliases to which the permissions in this entry apply.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Names"
}
]
},
"field_security": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level"
},
"description": "The document fields that the owners of the role have read access to.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.FieldSecurity"
}
]
},
"names": {
"description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
]
},
"privileges": {
"description": "The index level privileges that owners of the role have on the specified indices.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndexPrivilege"
}
},
"query": {
"description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery"
}
]
},
"allow_restricted_indices": {
"description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.",
"default": false,
"x-state": "Generally available",
"type": "boolean"
}
},
"required": [
"clusters",
"names",
"privileges"
]
},
"security._types.RemoteClusterPrivileges": {
"description": "The subset of cluster level privileges that can be defined for remote clusters.",
"type": "object",
"properties": {
"clusters": {
"description": "A list of cluster aliases to which the permissions in this entry apply.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Names"
}
]
},
"privileges": {
"description": "The cluster level privileges that owners of the role have on the remote cluster.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteClusterPrivilege"
}
}
},
"required": [
"clusters",
"privileges"
]
},
"security._types.RemoteClusterPrivilege": {
"type": "string",
"enum": [
"monitor_enrich",
"monitor_stats"
]
},
"security._types.GlobalPrivilege": {
"type": "object",
"properties": {
"application": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.ApplicationGlobalUserPrivileges"
}
]
}
},
"required": [
"application"
]
},
"security._types.ApplicationGlobalUserPrivileges": {
"type": "object",
"properties": {
"manage": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.ManageUserPrivileges"
}
]
}
},
"required": [
"manage"
]
},
"security._types.ManageUserPrivileges": {
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"applications"
]
},
"security._types.ApplicationPrivileges": {
"type": "object",
"properties": {
"application": {
"description": "The name of the application to which this entry applies.",
"type": "string"
},
"privileges": {
"description": "A list of strings, where each element is the name of an application privilege or action.",
"type": "array",
"items": {
"type": "string"
}
},
"resources": {
"description": "A list resources to which the privileges are applied.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"application",
"privileges",
"resources"
]
},
"security._types.Restriction": {
"type": "object",
"properties": {
"workflows": {
"description": "A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RestrictionWorkflow"
}
}
},
"required": [
"workflows"
]
},
"security._types.RestrictionWorkflow": {
"anyOf": [
{
"type": "string",
"enum": [
"search_application_query"
]
},
{
"type": "string"
}
]
},
"security._types.ClusterNode": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"name"
]
},
"_types.Namespace": {
"type": "string"
},
"_types.Service": {
"type": "string"
},
"security._types.Access": {
"type": "object",
"properties": {
"replication": {
"description": "A list of indices permission entries for cross-cluster replication.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ReplicationAccess"
}
},
"search": {
"description": "A list of indices permission entries for cross-cluster search.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.SearchAccess"
}
}
}
},
"security._types.ReplicationAccess": {
"type": "object",
"properties": {
"names": {
"description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
]
},
"allow_restricted_indices": {
"description": "This needs to be set to true if the patterns in the names field should cover system indices.",
"default": false,
"type": "boolean"
}
},
"required": [
"names"
]
},
"security._types.SearchAccess": {
"type": "object",
"properties": {
"field_security": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level"
},
"description": "The document fields that the owners of the role have read access to.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.FieldSecurity"
}
]
},
"names": {
"description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
]
},
"query": {
"description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery"
}
]
},
"allow_restricted_indices": {
"description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.",
"default": false,
"x-state": "Generally available",
"type": "boolean"
}
},
"required": [
"names"
]
},
"security.create_service_token.Token": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
},
"security.delegate_pki.Authentication": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"full_name": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"email": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"token": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"enabled": {
"type": "boolean"
},
"authentication_realm": {
"allOf": [
{
"$ref": "#/components/schemas/security.delegate_pki.AuthenticationRealm"
}
]
},
"lookup_realm": {
"allOf": [
{
"$ref": "#/components/schemas/security.delegate_pki.AuthenticationRealm"
}
]
},
"authentication_type": {
"type": "string"
},
"api_key": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"username",
"roles",
"full_name",
"email",
"metadata",
"enabled",
"authentication_realm",
"lookup_realm",
"authentication_type"
]
},
"security.delegate_pki.AuthenticationRealm": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"domain": {
"type": "string"
}
},
"required": [
"name",
"type"
]
},
"security.delete_privileges.FoundStatus": {
"type": "object",
"properties": {
"found": {
"type": "boolean"
}
},
"required": [
"found"
]
},
"security.enroll_kibana.Token": {
"type": "object",
"properties": {
"name": {
"description": "The name of the bearer token for the `elastic/kibana` service account.",
"type": "string"
},
"value": {
"description": "The value of the bearer token for the `elastic/kibana` service account.\nUse this value to authenticate the service account with Elasticsearch.",
"type": "string"
}
},
"required": [
"name",
"value"
]
},
"security._types.ApiKey": {
"type": "object",
"properties": {
"id": {
"description": "Id for the API key",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"name": {
"description": "Name of the API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"type": {
"description": "The type of the API key (e.g. `rest` or `cross_cluster`).",
"x-state": "Generally available; Added in 8.10.0",
"allOf": [
{
"$ref": "#/components/schemas/security._types.ApiKeyType"
}
]
},
"creation": {
"description": "Creation time for the API key in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"expiration": {
"description": "Expiration time for the API key in milliseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"invalidated": {
"description": "Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`.",
"type": "boolean"
},
"invalidation": {
"description": "If the key has been invalidated, invalidation time in milliseconds.",
"x-state": "Generally available; Added in 8.12.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"username": {
"description": "Principal for which this API key was created",
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
},
"realm": {
"description": "Realm name of the principal for which this API key was created.",
"type": "string"
},
"realm_type": {
"description": "Realm type of the principal for which this API key was created",
"x-state": "Generally available; Added in 8.14.0",
"type": "string"
},
"metadata": {
"description": "Metadata of the API key",
"x-state": "Generally available; Added in 7.13.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"role_descriptors": {
"description": "The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleDescriptor"
}
},
"limited_by": {
"description": "The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.",
"x-state": "Generally available; Added in 8.5.0",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleDescriptor"
}
}
},
"access": {
"description": "The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.",
"x-state": "Generally available; Added in 8.10.0",
"allOf": [
{
"$ref": "#/components/schemas/security._types.Access"
}
]
},
"certificate_identity": {
"description": "The certificate identity associated with a cross-cluster API key.\nRestricts the API key to connections authenticated by a specific TLS certificate.\nOnly applicable to cross-cluster API keys.",
"x-state": "Generally available; Added in 9.3.0",
"type": "string"
},
"profile_uid": {
"description": "The profile uid for the API key owner principal, if requested and if it exists",
"x-state": "Generally available; Added in 8.14.0",
"type": "string"
},
"_sort": {
"description": "Sorting values when using the `sort` parameter with the `security.query_api_keys` API.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
}
},
"required": [
"id",
"name",
"type",
"creation",
"invalidated",
"username",
"realm",
"metadata"
]
},
"security._types.ApiKeyType": {
"type": "string",
"enum": [
"rest",
"cross_cluster"
]
},
"security.put_privileges.Actions": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
}
},
"application": {
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
},
"required": [
"actions"
]
},
"security.get_role.Role": {
"type": "object",
"properties": {
"cluster": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ClusterPrivilege"
}
},
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security.get_role.IndicesPrivilegesRead"
}
},
"remote_indices": {
"x-state": "Generally available; Added in 8.14.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteIndicesPrivileges"
}
},
"remote_cluster": {
"x-state": "Generally available; Added in 8.15.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteClusterPrivileges"
}
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"description": {
"type": "string"
},
"run_as": {
"type": "array",
"items": {
"type": "string"
}
},
"transient_metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ApplicationPrivileges"
}
},
"role_templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RoleTemplate"
}
},
"global": {
"x-state": "Generally available; Added in 8.0.0",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"required": [
"cluster",
"indices",
"metadata",
"applications"
]
},
"security.get_role.IndicesPrivilegesRead": {
"description": "Read-side variant of `IndicesPrivileges` returned by the get role API.\nCarries the `implicitly_granted` marker that is set on entries contributed by\na registered `ImplicitPrivilegesProvider` when `include_implicit` is `true`.",
"type": "object",
"properties": {
"implicitly_granted": {
"description": "Set to `true` on entries that were contributed by a registered `ImplicitPrivilegesProvider`\nrather than explicitly stored on the role. Only present when the get role API is called with\n`include_implicit=true`. The put role API rejects this field, so clients must not echo it back\non a GET-then-PUT round-trip.",
"x-state": "Generally available; Added in 9.5.0",
"type": "boolean"
},
"field_security": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level"
},
"description": "The document fields that the owners of the role have read access to.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.FieldSecurity"
}
]
},
"names": {
"description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
]
},
"privileges": {
"description": "The index level privileges that owners of the role have on the specified indices.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndexPrivilege"
}
},
"query": {
"description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery"
}
]
},
"allow_restricted_indices": {
"description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.",
"default": false,
"x-state": "Generally available",
"type": "boolean"
}
},
"required": [
"names",
"privileges"
]
},
"security._types.RoleTemplate": {
"type": "object",
"properties": {
"format": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.TemplateFormat"
}
]
},
"template": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
},
"required": [
"template"
]
},
"security._types.TemplateFormat": {
"type": "string",
"enum": [
"string",
"json"
]
},
"security._types.RoleMapping": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"role_templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RoleTemplate"
}
},
"rules": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.RoleMappingRule"
}
]
}
},
"required": [
"enabled",
"metadata",
"rules"
]
},
"security._types.RoleMappingRule": {
"type": "object",
"properties": {
"any": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RoleMappingRule"
}
},
"all": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RoleMappingRule"
}
},
"field": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.FieldValue"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.FieldValue"
}
}
]
},
"minProperties": 1,
"maxProperties": 1
},
"except": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.RoleMappingRule"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"security.get_service_accounts.RoleDescriptorWrapper": {
"type": "object",
"properties": {
"role_descriptor": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.RoleDescriptorRead"
}
]
}
},
"required": [
"role_descriptor"
]
},
"security._types.RoleDescriptorRead": {
"type": "object",
"properties": {
"cluster": {
"description": "A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ClusterPrivilege"
}
},
"indices": {
"description": "A list of indices permissions entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndicesPrivileges"
}
},
"remote_indices": {
"description": "A list of indices permissions for remote clusters.",
"x-state": "Generally available; Added in 8.14.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteIndicesPrivileges"
}
},
"remote_cluster": {
"description": "A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.",
"x-state": "Generally available; Added in 8.15.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteClusterPrivileges"
}
},
"global": {
"description": "An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.",
"x-state": "Generally available",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.GlobalPrivilege"
}
},
{
"$ref": "#/components/schemas/security._types.GlobalPrivilege"
}
]
},
"applications": {
"description": "A list of application privilege entries",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ApplicationPrivileges"
}
},
"metadata": {
"description": "Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"run_as": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users"
},
"description": "A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.",
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"description": "Optional description of the role descriptor",
"type": "string"
},
"restriction": {
"description": "Restriction for when the role descriptor is allowed to be effective.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.Restriction"
}
]
},
"transient_metadata": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"cluster",
"indices"
]
},
"security.get_service_credentials.NodesCredentials": {
"type": "object",
"properties": {
"_nodes": {
"description": "General status showing how nodes respond to the above collection request",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
},
"file_tokens": {
"description": "File-backed tokens collected from all nodes",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.get_service_credentials.NodesCredentialsFileToken"
}
}
},
"required": [
"_nodes",
"file_tokens"
]
},
"security.get_service_credentials.NodesCredentialsFileToken": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"nodes"
]
},
"security._types.SecuritySettings": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
}
}
},
"security._types.NodeSecurityStats": {
"type": "object",
"properties": {
"roles": {
"description": "Role statistics.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.RolesStats"
}
]
}
},
"required": [
"roles"
]
},
"security._types.RolesStats": {
"type": "object",
"properties": {
"dls": {
"description": "Document-level security (DLS) statistics.",
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.SecurityRolesDls"
}
]
}
},
"required": [
"dls"
]
},
"xpack.usage.SecurityRolesDls": {
"type": "object",
"properties": {
"bit_set_cache": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.SecurityRolesDlsBitSetCache"
}
]
}
},
"required": [
"bit_set_cache"
]
},
"xpack.usage.SecurityRolesDlsBitSetCache": {
"type": "object",
"properties": {
"count": {
"description": "Number of entries in the cache.",
"type": "number"
},
"memory": {
"description": "Human-readable amount of memory taken up by the cache.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"memory_in_bytes": {
"description": "Memory taken up by the cache in bytes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ulong"
}
]
},
"hits": {
"description": "Total number of cache hits.",
"x-state": "Generally available; Added in 9.2.0",
"type": "number"
},
"misses": {
"description": "Total number of cache misses.",
"x-state": "Generally available; Added in 9.2.0",
"type": "number"
},
"evictions": {
"description": "Total number of cache evictions.",
"x-state": "Generally available; Added in 9.2.0",
"type": "number"
},
"hits_time_in_millis": {
"description": "Total combined time spent in cache for hits in milliseconds.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"misses_time_in_millis": {
"description": "Total combined time spent in cache for misses in milliseconds.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"count",
"memory_in_bytes",
"hits",
"misses",
"evictions",
"hits_time_in_millis",
"misses_time_in_millis"
]
},
"security.get_token.AccessTokenGrantType": {
"type": "string",
"enum": [
"password",
"client_credentials",
"_kerberos",
"refresh_token"
]
},
"security.get_token.AuthenticatedUser": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.User"
},
{
"type": "object",
"properties": {
"authentication_realm": {
"allOf": [
{
"$ref": "#/components/schemas/security.get_token.UserRealm"
}
]
},
"lookup_realm": {
"allOf": [
{
"$ref": "#/components/schemas/security.get_token.UserRealm"
}
]
},
"authentication_provider": {
"allOf": [
{
"$ref": "#/components/schemas/security.get_token.AuthenticationProvider"
}
]
},
"authentication_type": {
"type": "string"
}
},
"required": [
"authentication_realm",
"lookup_realm",
"authentication_type"
]
}
]
},
"security.get_token.UserRealm": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
]
},
"security.get_token.AuthenticationProvider": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"type",
"name"
]
},
"security._types.User": {
"type": "object",
"properties": {
"email": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"full_name": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Name"
},
{
"nullable": true,
"type": "string"
}
]
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
},
"enabled": {
"type": "boolean"
},
"profile_uid": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.UserProfileId"
}
]
}
},
"required": [
"metadata",
"roles",
"username",
"enabled"
]
},
"security._types.UserIndicesPrivileges": {
"type": "object",
"properties": {
"field_security": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level"
},
"description": "The document fields that the owners of the role have read access to.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.FieldSecurity"
}
},
"names": {
"description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
]
},
"privileges": {
"description": "The index level privileges that owners of the role have on the specified indices.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndexPrivilege"
}
},
"query": {
"description": "Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery"
}
},
"allow_restricted_indices": {
"description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.",
"type": "boolean"
}
},
"required": [
"names",
"privileges",
"allow_restricted_indices"
]
},
"security._types.RemoteUserIndicesPrivileges": {
"type": "object",
"properties": {
"clusters": {
"type": "array",
"items": {
"type": "string"
}
},
"field_security": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level"
},
"description": "The document fields that the owners of the role have read access to.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.FieldSecurity"
}
},
"names": {
"description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
}
]
},
"privileges": {
"description": "The index level privileges that owners of the role have on the specified indices.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndexPrivilege"
}
},
"query": {
"description": "Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery"
}
},
"allow_restricted_indices": {
"description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.",
"type": "boolean"
}
},
"required": [
"clusters",
"names",
"privileges",
"allow_restricted_indices"
]
},
"security.get_user_profile.GetUserProfileErrors": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"details": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
}
},
"required": [
"count",
"details"
]
},
"security.grant_api_key.GrantApiKey": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"expiration": {
"description": "Expiration time for the API key. By default, API keys never expire.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationLarge"
}
]
},
"role_descriptors": {
"description": "The role descriptors for this API key.\nWhen it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleDescriptor"
}
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleDescriptor"
}
}
}
]
},
"metadata": {
"description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the `metadata` object, keys beginning with `_` are reserved for system usage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
},
"required": [
"name"
]
},
"security.grant_api_key.ApiKeyGrantType": {
"type": "string",
"enum": [
"access_token",
"password"
]
},
"security.has_privileges.ApplicationPrivilegesCheck": {
"type": "object",
"properties": {
"application": {
"description": "The name of the application.",
"type": "string"
},
"privileges": {
"description": "A list of the privileges that you want to check for the specified resources.\nIt may be either application privilege names or the names of actions that are granted by those privileges",
"type": "array",
"items": {
"type": "string"
}
},
"resources": {
"description": "A list of resource names against which the privileges should be checked.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"application",
"privileges",
"resources"
]
},
"security.has_privileges.IndexPrivilegesCheck": {
"type": "object",
"properties": {
"names": {
"description": "A list of indices.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"privileges": {
"description": "A list of the privileges that you want to check for the specified indices.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndexPrivilege"
}
},
"allow_restricted_indices": {
"description": "This needs to be set to `true` (default is `false`) if using wildcards or regexps for patterns that cover restricted indices.\nImplicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false.\nIf restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of `allow_restricted_indices`.",
"type": "boolean"
}
},
"required": [
"names",
"privileges"
]
},
"security.has_privileges.ApplicationsPrivileges": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.has_privileges.ResourcePrivileges"
}
},
"security.has_privileges.ResourcePrivileges": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.has_privileges.Privileges"
}
},
"security.has_privileges.Privileges": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"security.has_privileges_user_profile.PrivilegesCheck": {
"type": "object",
"properties": {
"application": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security.has_privileges.ApplicationPrivilegesCheck"
}
},
"cluster": {
"description": "A list of the cluster privileges that you want to check.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ClusterPrivilege"
}
},
"index": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security.has_privileges.IndexPrivilegesCheck"
}
}
}
},
"security.has_privileges_user_profile.HasPrivilegesUserProfileErrors": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"details": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ErrorCause"
}
}
},
"required": [
"count",
"details"
]
},
"security._types.CreatedStatus": {
"type": "object",
"properties": {
"created": {
"type": "boolean"
}
},
"required": [
"created"
]
},
"security.query_api_keys.ApiKeyAggregationContainer": {
"allOf": [
{
"type": "object",
"properties": {
"aggregations": {
"description": "Sub-aggregations for this aggregation.\nOnly applies to bucket aggregations.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.query_api_keys.ApiKeyAggregationContainer"
}
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
}
},
{
"type": "object",
"properties": {
"cardinality": {
"description": "A single-value metrics aggregation that calculates an approximate count of distinct values.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation"
}
]
},
"composite": {
"description": "A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregation"
}
]
},
"date_range": {
"description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation"
}
]
},
"filter": {
"description": "A single bucket aggregation that narrows the set of documents to those that match a query.",
"allOf": [
{
"$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer"
}
]
},
"filters": {
"description": "A multi-bucket aggregation where each bucket contains the documents that match a query.",
"allOf": [
{
"$ref": "#/components/schemas/security.query_api_keys.ApiKeyFiltersAggregation"
}
]
},
"missing": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.MissingAggregation"
}
]
},
"range": {
"description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.RangeAggregation"
}
]
},
"terms": {
"description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregation"
}
]
},
"value_count": {
"description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"security.query_api_keys.ApiKeyQueryContainer": {
"type": "object",
"properties": {
"bool": {
"description": "Matches documents matching boolean combinations of other queries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.BoolQuery"
}
]
},
"exists": {
"description": "Returns documents that contain an indexed value for a field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ExistsQuery"
}
]
},
"ids": {
"description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IdsQuery"
}
]
},
"match": {
"description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.MatchQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"match_all": {
"description": "Matches all documents, giving them all a `_score` of 1.0.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery"
}
]
},
"prefix": {
"description": "Returns documents that contain a specific prefix in a provided field.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.PrefixQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"range": {
"description": "Returns documents that contain terms within a provided range.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.RangeQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"simple_query_string": {
"description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery"
}
]
},
"term": {
"description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.TermQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"terms": {
"description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.TermsQuery"
}
]
},
"wildcard": {
"description": "Returns documents that contain terms matching a wildcard pattern.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.WildcardQuery"
},
"minProperties": 1,
"maxProperties": 1
}
},
"minProperties": 1,
"maxProperties": 1
},
"security.query_api_keys.ApiKeyFiltersAggregation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
},
{
"type": "object",
"properties": {
"filters": {
"description": "Collection of queries from which to build buckets.",
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.BucketsApiKeyQueryContainer"
}
]
},
"other_bucket": {
"description": "Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.",
"type": "boolean"
},
"other_bucket_key": {
"description": "The key with which the other bucket is returned.",
"default": "_other_",
"type": "string"
},
"keyed": {
"description": "By default, the named filters aggregation returns the buckets as an object.\nSet to `false` to return the buckets as an array of objects.",
"default": true,
"type": "boolean"
}
}
}
]
},
"_types.aggregations.BucketsApiKeyQueryContainer": {
"description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer"
}
}
]
},
"security.query_api_keys.ApiKeyAggregate": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.aggregations.CardinalityAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.ValueCountAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.StringTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.LongTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.DoubleTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.UnmappedTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.MissingAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.FilterAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.FiltersAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.RangeAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.DateRangeAggregate"
},
{
"$ref": "#/components/schemas/_types.aggregations.CompositeAggregate"
}
]
},
"security.query_role.RoleQueryContainer": {
"type": "object",
"properties": {
"bool": {
"description": "matches roles matching boolean combinations of other queries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.BoolQuery"
}
]
},
"exists": {
"description": "Returns roles that contain an indexed value for a field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ExistsQuery"
}
]
},
"ids": {
"description": "Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IdsQuery"
}
]
},
"match": {
"description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.MatchQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"match_all": {
"description": "Matches all roles, giving them all a `_score` of 1.0.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery"
}
]
},
"prefix": {
"description": "Returns roles that contain a specific prefix in a provided field.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.PrefixQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"range": {
"description": "Returns roles that contain terms within a provided range.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.RangeQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"simple_query_string": {
"description": "Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery"
}
]
},
"term": {
"description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.TermQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"terms": {
"description": "Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.TermsQuery"
}
]
},
"wildcard": {
"description": "Returns roles that contain terms matching a wildcard pattern.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.WildcardQuery"
},
"minProperties": 1,
"maxProperties": 1
}
},
"minProperties": 1,
"maxProperties": 1
},
"security.query_role.QueryRole": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.RoleDescriptor"
},
{
"type": "object",
"properties": {
"_sort": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
},
"name": {
"description": "Name of the role.",
"type": "string"
}
},
"required": [
"name"
]
}
]
},
"security.query_user.UserQueryContainer": {
"type": "object",
"properties": {
"ids": {
"description": "Returns users based on their IDs.\nThis query uses the user document IDs stored in the `_id` field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.IdsQuery"
}
]
},
"bool": {
"description": "matches users matching boolean combinations of other queries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.BoolQuery"
}
]
},
"exists": {
"description": "Returns users that contain an indexed value for a field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.ExistsQuery"
}
]
},
"match": {
"description": "Returns users that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.MatchQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"match_all": {
"description": "Matches all users, giving them all a `_score` of 1.0.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery"
}
]
},
"prefix": {
"description": "Returns users that contain a specific prefix in a provided field.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.PrefixQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"range": {
"description": "Returns users that contain terms within a provided range.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.RangeQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"simple_query_string": {
"description": "Returns users based on a provided query string, using a parser with a limited but fault-tolerant syntax.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery"
}
]
},
"term": {
"description": "Returns users that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.TermQuery"
},
"minProperties": 1,
"maxProperties": 1
},
"terms": {
"description": "Returns users that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.TermsQuery"
}
]
},
"wildcard": {
"description": "Returns users that contain terms matching a wildcard pattern.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.query_dsl.WildcardQuery"
},
"minProperties": 1,
"maxProperties": 1
}
},
"minProperties": 1,
"maxProperties": 1
},
"security.query_user.QueryUser": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.User"
},
{
"type": "object",
"properties": {
"_sort": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
}
}
}
]
},
"security.suggest_user_profiles.Hint": {
"type": "object",
"properties": {
"uids": {
"description": "A list of profile UIDs to match against.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.UserProfileId"
}
},
"labels": {
"description": "A single key-value pair to match against the labels section\nof a profile. A profile is considered matching if it matches\nat least one of the strings.",
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
}
},
"security.suggest_user_profiles.TotalUserProfiles": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"relation": {
"allOf": [
{
"$ref": "#/components/schemas/_types.RelationName"
}
]
}
},
"required": [
"value",
"relation"
]
},
"simulate.ingest.MergeType": {
"type": "string",
"enum": [
"index",
"template"
]
},
"cluster._types.ComponentTemplateNode": {
"type": "object",
"properties": {
"template": {
"allOf": [
{
"$ref": "#/components/schemas/cluster._types.ComponentTemplateSummary"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"_meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"deprecated": {
"type": "boolean"
},
"created_date": {
"description": "Date and time when the component template was created. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"created_date_millis": {
"description": "Date and time when the component template was created, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"modified_date": {
"description": "Date and time when the component template was last modified. Only returned if the `human` query parameter is `true`.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"modified_date_millis": {
"description": "Date and time when the component template was last modified, in milliseconds since the epoch.",
"x-state": "Generally available; Added in 9.2.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"template"
]
},
"cluster._types.ComponentTemplateSummary": {
"type": "object",
"properties": {
"_meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"settings": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"aliases": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.AliasDefinition"
}
},
"lifecycle": {
"x-state": "Generally available; Added in 8.11.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamLifecycle"
}
]
},
"data_stream_options": {
"x-state": "Generally available; Added in 8.19.0",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamOptions"
}
]
}
}
},
"simulate.ingest.SimulateIngestDocumentResult": {
"type": "object",
"properties": {
"doc": {
"allOf": [
{
"$ref": "#/components/schemas/simulate.ingest.IngestDocumentSimulation"
}
]
}
}
},
"simulate.ingest.IngestDocumentSimulation": {
"description": "The results of ingest simulation on a single document. The _source of the document contains\nthe results after running all pipelines listed in executed_pipelines on the document. The\nlist of executed pipelines is derived from the pipelines that would be executed if this\ndocument had been ingested into _index.",
"type": "object",
"properties": {
"_id": {
"description": "Identifier for the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"description": "Name of the index that the document would be indexed into if this were not a simulation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_source": {
"description": "JSON body for the document.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"_version": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber"
}
]
},
"executed_pipelines": {
"description": "A list of the names of the pipelines executed on this document.",
"type": "array",
"items": {
"type": "string"
}
},
"ignored_fields": {
"description": "A list of the fields that would be ignored at the indexing step. For example, a field whose\nvalue is larger than the allowed limit would make it through all of the pipelines, but\nwould not be indexed into Elasticsearch.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"error": {
"description": "Any error resulting from simulatng ingest on this doc. This can be an error generated by\nexecuting a processor, or a mapping validation error when simulating indexing the resulting\ndoc.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
},
"effective_mapping": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
}
},
"required": [
"_id",
"_index",
"_source",
"_version",
"executed_pipelines"
]
},
"slm._types.SnapshotLifecycle": {
"type": "object",
"properties": {
"in_progress": {
"allOf": [
{
"$ref": "#/components/schemas/slm._types.InProgress"
}
]
},
"last_failure": {
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Invocation"
}
]
},
"last_success": {
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Invocation"
}
]
},
"modified_date": {
"description": "The last time the policy was modified.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"modified_date_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"next_execution": {
"description": "The next time the policy will run.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"next_execution_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"policy": {
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Policy"
}
]
},
"version": {
"description": "The version of the snapshot policy.\nOnly the latest version is stored and incremented when the policy is updated.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"stats": {
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Statistics"
}
]
}
},
"required": [
"modified_date_millis",
"next_execution_millis",
"policy",
"version",
"stats"
]
},
"slm._types.InProgress": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"start_time_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"state": {
"type": "string"
},
"uuid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
}
},
"required": [
"name",
"start_time_millis",
"state",
"uuid"
]
},
"slm._types.Invocation": {
"type": "object",
"properties": {
"snapshot_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"snapshot_name",
"time"
]
},
"slm._types.Policy": {
"type": "object",
"properties": {
"config": {
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Configuration"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"repository": {
"type": "string"
},
"retention": {
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Retention"
}
]
},
"schedule": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.CronExpression"
}
]
}
},
"required": [
"name",
"repository",
"schedule"
]
},
"slm._types.Configuration": {
"type": "object",
"properties": {
"ignore_unavailable": {
"description": "If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices.",
"default": false,
"type": "boolean"
},
"indices": {
"description": "A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported.\nBy default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"include_global_state": {
"description": "If true, the current global state is included in the snapshot.",
"default": true,
"type": "boolean"
},
"feature_states": {
"description": "A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API.\nEach feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false.",
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"description": "Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"partial": {
"description": "If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available.",
"default": false,
"type": "boolean"
}
}
},
"slm._types.Retention": {
"type": "object",
"properties": {
"expire_after": {
"description": "Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_count": {
"description": "Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots.",
"type": "number"
},
"min_count": {
"description": "Minimum number of snapshots to retain, even if the snapshots have expired.",
"type": "number"
}
},
"required": [
"expire_after",
"max_count",
"min_count"
]
},
"watcher._types.CronExpression": {
"type": "string"
},
"slm._types.Statistics": {
"type": "object",
"properties": {
"retention_deletion_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"retention_deletion_time_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"retention_failed": {
"type": "number"
},
"retention_runs": {
"type": "number"
},
"retention_timed_out": {
"type": "number"
},
"policy": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"total_snapshots_deleted": {
"type": "number"
},
"total_snapshot_deletion_failures": {
"type": "number"
},
"total_snapshots_failed": {
"type": "number"
},
"total_snapshots_taken": {
"type": "number"
}
}
},
"slm._types.SnapshotPolicyStats": {
"type": "object",
"properties": {
"policy": {
"type": "string"
},
"snapshots_taken": {
"type": "number"
},
"snapshots_failed": {
"type": "number"
},
"snapshots_deleted": {
"type": "number"
},
"snapshot_deletion_failures": {
"type": "number"
}
},
"required": [
"policy",
"snapshots_taken",
"snapshots_failed",
"snapshots_deleted",
"snapshot_deletion_failures"
]
},
"snapshot.cleanup_repository.CleanupRepositoryResults": {
"type": "object",
"properties": {
"deleted_blobs": {
"description": "The number of binary large objects (blobs) removed from the snapshot repository during cleanup operations.\nA non-zero value indicates that unreferenced blobs were found and subsequently cleaned up.",
"type": "number"
},
"deleted_bytes": {
"description": "The number of bytes freed by cleanup operations.",
"type": "number"
}
},
"required": [
"deleted_blobs",
"deleted_bytes"
]
},
"snapshot._types.SnapshotInfo": {
"type": "object",
"properties": {
"data_streams": {
"type": "array",
"items": {
"type": "string"
}
},
"duration": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"duration_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"end_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"end_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snapshot._types.SnapshotShardFailure"
}
},
"include_global_state": {
"type": "boolean"
},
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
},
"index_details": {
"x-state": "Generally available; Added in 7.13.0",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/snapshot._types.IndexDetails"
}
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"reason": {
"type": "string"
},
"repository": {
"x-state": "Generally available; Added in 7.14.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"snapshot": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"start_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"start_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"state": {
"type": "string"
},
"uuid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"version_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"feature_states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snapshot._types.InfoFeatureState"
}
}
},
"required": [
"data_streams",
"snapshot",
"uuid"
]
},
"snapshot._types.SnapshotShardFailure": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"node_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"reason": {
"type": "string"
},
"shard_id": {
"type": "number"
},
"index_uuid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"status": {
"type": "string"
}
},
"required": [
"index",
"reason",
"shard_id",
"index_uuid",
"status"
]
},
"snapshot._types.IndexDetails": {
"type": "object",
"properties": {
"shard_count": {
"type": "number"
},
"size": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"size_in_bytes": {
"type": "number"
},
"max_segments_per_shard": {
"type": "number"
}
},
"required": [
"shard_count",
"size_in_bytes",
"max_segments_per_shard"
]
},
"snapshot._types.InfoFeatureState": {
"type": "object",
"properties": {
"feature_name": {
"type": "string"
},
"indices": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
}
},
"required": [
"feature_name",
"indices"
]
},
"snapshot._types.Repository": {
"discriminator": {
"propertyName": "type",
"mapping": {
"azure": "#/components/schemas/snapshot._types.AzureRepository",
"fs": "#/components/schemas/snapshot._types.SharedFileSystemRepository",
"gcs": "#/components/schemas/snapshot._types.GcsRepository",
"s3": "#/components/schemas/snapshot._types.S3Repository",
"source": "#/components/schemas/snapshot._types.SourceOnlyRepository",
"url": "#/components/schemas/snapshot._types.ReadOnlyUrlRepository"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/snapshot._types.AzureRepository"
},
{
"$ref": "#/components/schemas/snapshot._types.GcsRepository"
},
{
"$ref": "#/components/schemas/snapshot._types.S3Repository"
},
{
"$ref": "#/components/schemas/snapshot._types.SharedFileSystemRepository"
},
{
"$ref": "#/components/schemas/snapshot._types.ReadOnlyUrlRepository"
},
{
"$ref": "#/components/schemas/snapshot._types.SourceOnlyRepository"
}
]
},
"snapshot._types.AzureRepository": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositoryBase"
},
{
"type": "object",
"properties": {
"type": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/azure-repository"
},
"description": "The Azure repository type.",
"type": "string",
"enum": [
"azure"
]
},
"settings": {
"description": "The repository settings.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.AzureRepositorySettings"
}
]
}
},
"required": [
"type"
]
}
]
},
"snapshot._types.AzureRepositorySettings": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositorySettingsBase"
},
{
"type": "object",
"properties": {
"base_path": {
"description": "The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.",
"type": "string"
},
"client": {
"description": "The name of the Azure repository client to use.",
"default": "default",
"type": "string"
},
"container": {
"description": "The Azure container.",
"default": "elasticsearch-snapshots",
"type": "string"
},
"delete_objects_max_size": {
"description": "The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API.",
"default": 256,
"type": "number"
},
"location_mode": {
"description": "Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`.",
"default": "primary_only",
"type": "string"
},
"max_concurrent_batch_deletes": {
"description": "The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100.",
"default": 10,
"type": "number"
},
"readonly": {
"description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.",
"default": false,
"type": "boolean"
}
}
}
]
},
"snapshot._types.RepositorySettingsBase": {
"type": "object",
"properties": {
"chunk_size": {
"description": "Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"compress": {
"description": "When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default.",
"default": true,
"type": "boolean"
},
"max_restore_bytes_per_sec": {
"description": "The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"max_snapshot_bytes_per_sec": {
"description": "The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
}
}
},
"snapshot._types.RepositoryBase": {
"type": "object",
"properties": {
"uuid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
}
}
},
"snapshot._types.GcsRepository": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositoryBase"
},
{
"type": "object",
"properties": {
"type": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository"
},
"description": "The Google Cloud Storage repository type.",
"type": "string",
"enum": [
"gcs"
]
},
"settings": {
"description": "The repository settings.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.GcsRepositorySettings"
}
]
}
},
"required": [
"type",
"settings"
]
}
]
},
"snapshot._types.GcsRepositorySettings": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositorySettingsBase"
},
{
"type": "object",
"properties": {
"bucket": {
"description": "The name of the bucket to be used for snapshots.",
"type": "string"
},
"application_name": {
"deprecated": true,
"description": "The name used by the client when it uses the Google Cloud Storage service.",
"type": "string"
},
"base_path": {
"description": "The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.",
"type": "string"
},
"client": {
"description": "The name of the client to use to connect to Google Cloud Storage.",
"default": "default",
"type": "string"
},
"readonly": {
"description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.",
"default": false,
"type": "boolean"
}
},
"required": [
"bucket"
]
}
]
},
"snapshot._types.S3Repository": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositoryBase"
},
{
"type": "object",
"properties": {
"type": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository"
},
"description": "The S3 repository type.",
"type": "string",
"enum": [
"s3"
]
},
"settings": {
"description": "The repository settings.\n\nNOTE: In addition to the specified settings, you can also use all non-secure client settings in the repository settings.\nIn this case, the client settings found in the repository settings will be merged with those of the named client used by the repository.\nConflicts between client and repository settings are resolved by the repository settings taking precedence over client settings.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.S3RepositorySettings"
}
]
}
},
"required": [
"type",
"settings"
]
}
]
},
"snapshot._types.S3RepositorySettings": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositorySettingsBase"
},
{
"type": "object",
"properties": {
"bucket": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules"
},
"description": "The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules.",
"type": "string"
},
"base_path": {
"description": "The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket.",
"type": "string"
},
"buffer_size": {
"description": "The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"canned_acl": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl"
},
"description": "The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects.",
"default": "private",
"type": "string"
},
"client": {
"description": "The name of the S3 client to use to connect to S3.",
"default": "default",
"type": "string"
},
"delete_objects_max_size": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html"
},
"description": "The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the AWS DeleteObjects API.",
"default": 1000,
"type": "number"
},
"get_register_retry_delay": {
"description": "The time to wait before trying again if an attempt to read a linearizable register fails.",
"default": "5s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_multipart_parts": {
"description": "The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3.",
"default": 10000,
"type": "number"
},
"max_multipart_upload_cleanup_size": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html"
},
"description": "The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads.",
"default": 1000,
"type": "number"
},
"readonly": {
"description": "If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.",
"default": false,
"type": "boolean"
},
"server_side_encryption": {
"description": "When set to `true`, files are encrypted on server side using an AES256 algorithm.",
"default": false,
"type": "boolean"
},
"storage_class": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository#repository-s3-storage-classes"
},
"description": "The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`.",
"default": "standard",
"type": "string"
},
"throttled_delete_retry.delay_increment": {
"description": "The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms.",
"default": "50ms",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_delete_retry.maximum_delay": {
"description": "The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms.",
"default": "5s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_delete_retry.maximum_number_of_retries": {
"description": "The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries.",
"type": "number"
}
},
"required": [
"bucket"
]
}
]
},
"snapshot._types.SharedFileSystemRepository": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositoryBase"
},
{
"type": "object",
"properties": {
"type": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/shared-file-system-repository"
},
"description": "The shared file system repository type.",
"type": "string",
"enum": [
"fs"
]
},
"settings": {
"description": "The repository settings.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.SharedFileSystemRepositorySettings"
}
]
}
},
"required": [
"type",
"settings"
]
}
]
},
"snapshot._types.SharedFileSystemRepositorySettings": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositorySettingsBase"
},
{
"type": "object",
"properties": {
"location": {
"description": "The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path.",
"type": "string"
},
"max_number_of_snapshots": {
"description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.",
"default": 2147483647,
"type": "number"
},
"readonly": {
"description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.",
"default": false,
"type": "boolean"
}
},
"required": [
"location"
]
}
]
},
"snapshot._types.ReadOnlyUrlRepository": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositoryBase"
},
{
"type": "object",
"properties": {
"type": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/read-only-url-repository"
},
"description": "The read-only URL repository type.",
"type": "string",
"enum": [
"url"
]
},
"settings": {
"description": "The repository settings.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.ReadOnlyUrlRepositorySettings"
}
]
}
},
"required": [
"type",
"settings"
]
}
]
},
"snapshot._types.ReadOnlyUrlRepositorySettings": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositorySettingsBase"
},
{
"type": "object",
"properties": {
"http_max_retries": {
"description": "The maximum number of retries for HTTP and HTTPS URLs.",
"default": 5,
"type": "number"
},
"http_socket_timeout": {
"description": "The maximum wait time for data transfers over a connection.",
"default": "50s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_number_of_snapshots": {
"description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.",
"default": 2147483647,
"type": "number"
},
"url": {
"description": "The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting.",
"type": "string"
}
},
"required": [
"url"
]
}
]
},
"snapshot._types.SourceOnlyRepository": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.RepositoryBase"
},
{
"type": "object",
"properties": {
"type": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/source-only-repository"
},
"description": "The source-only repository type.",
"type": "string",
"enum": [
"source"
]
},
"settings": {
"description": "The repository settings.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettings"
}
]
}
},
"required": [
"type",
"settings"
]
}
]
},
"snapshot._types.SourceOnlyRepositorySettings": {
"description": "The delegated repository type.\nSource repositories can use `settings` properties for its delegated repository type.",
"discriminator": {
"propertyName": "delegate_type",
"mapping": {
"azure": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForAzure",
"fs": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForSharedFileSystem",
"gcs": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForGcs",
"s3": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForS3",
"url": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForReadOnlyUrl"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForSharedFileSystem"
},
{
"$ref": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForReadOnlyUrl"
},
{
"$ref": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForAzure"
},
{
"$ref": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForGcs"
},
{
"$ref": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettingsForS3"
}
]
},
"snapshot._types.SourceOnlyRepositorySettingsForSharedFileSystem": {
"type": "object",
"properties": {
"delegate_type": {
"type": "string",
"enum": [
"fs"
]
},
"location": {
"description": "The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path.",
"type": "string"
},
"max_number_of_snapshots": {
"description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.",
"default": 2147483647,
"type": "number"
},
"readonly": {
"description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.",
"default": false,
"type": "boolean"
}
},
"required": [
"delegate_type",
"location"
]
},
"snapshot._types.SourceOnlyRepositorySettingsForReadOnlyUrl": {
"type": "object",
"properties": {
"delegate_type": {
"type": "string",
"enum": [
"url"
]
},
"http_max_retries": {
"description": "The maximum number of retries for HTTP and HTTPS URLs.",
"default": 5,
"type": "number"
},
"http_socket_timeout": {
"description": "The maximum wait time for data transfers over a connection.",
"default": "50s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_number_of_snapshots": {
"description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.",
"default": 2147483647,
"type": "number"
},
"url": {
"description": "The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting.",
"type": "string"
}
},
"required": [
"delegate_type",
"url"
]
},
"snapshot._types.SourceOnlyRepositorySettingsForAzure": {
"type": "object",
"properties": {
"delegate_type": {
"type": "string",
"enum": [
"azure"
]
},
"base_path": {
"description": "The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.",
"type": "string"
},
"client": {
"description": "The name of the Azure repository client to use.",
"default": "default",
"type": "string"
},
"container": {
"description": "The Azure container.",
"default": "elasticsearch-snapshots",
"type": "string"
},
"delete_objects_max_size": {
"description": "The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API.",
"default": 256,
"type": "number"
},
"location_mode": {
"description": "Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`.",
"default": "primary_only",
"type": "string"
},
"max_concurrent_batch_deletes": {
"description": "The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100.",
"default": 10,
"type": "number"
},
"readonly": {
"description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.",
"default": false,
"type": "boolean"
}
},
"required": [
"delegate_type"
]
},
"snapshot._types.SourceOnlyRepositorySettingsForGcs": {
"type": "object",
"properties": {
"delegate_type": {
"type": "string",
"enum": [
"gcs"
]
},
"bucket": {
"description": "The name of the bucket to be used for snapshots.",
"type": "string"
},
"application_name": {
"deprecated": true,
"description": "The name used by the client when it uses the Google Cloud Storage service.",
"type": "string"
},
"base_path": {
"description": "The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.",
"type": "string"
},
"client": {
"description": "The name of the client to use to connect to Google Cloud Storage.",
"default": "default",
"type": "string"
},
"readonly": {
"description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.",
"default": false,
"type": "boolean"
}
},
"required": [
"delegate_type",
"bucket"
]
},
"snapshot._types.SourceOnlyRepositorySettingsForS3": {
"type": "object",
"properties": {
"delegate_type": {
"type": "string",
"enum": [
"s3"
]
},
"bucket": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules"
},
"description": "The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules.",
"type": "string"
},
"base_path": {
"description": "The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket.",
"type": "string"
},
"buffer_size": {
"description": "The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"canned_acl": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl"
},
"description": "The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects.",
"default": "private",
"type": "string"
},
"client": {
"description": "The name of the S3 client to use to connect to S3.",
"default": "default",
"type": "string"
},
"delete_objects_max_size": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html"
},
"description": "The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the AWS DeleteObjects API.",
"default": 1000,
"type": "number"
},
"get_register_retry_delay": {
"description": "The time to wait before trying again if an attempt to read a linearizable register fails.",
"default": "5s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_multipart_parts": {
"description": "The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3.",
"default": 10000,
"type": "number"
},
"max_multipart_upload_cleanup_size": {
"externalDocs": {
"url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html"
},
"description": "The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads.",
"default": 1000,
"type": "number"
},
"readonly": {
"description": "If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.",
"default": false,
"type": "boolean"
},
"server_side_encryption": {
"description": "When set to `true`, files are encrypted on server side using an AES256 algorithm.",
"default": false,
"type": "boolean"
},
"storage_class": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository#repository-s3-storage-classes"
},
"description": "The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`.",
"default": "standard",
"type": "string"
},
"throttled_delete_retry.delay_increment": {
"description": "The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms.",
"default": "50ms",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_delete_retry.maximum_delay": {
"description": "The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms.",
"default": "5s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_delete_retry.maximum_number_of_retries": {
"description": "The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries.",
"type": "number"
}
},
"required": [
"delegate_type",
"bucket"
]
},
"snapshot._types.SnapshotSort": {
"type": "string",
"enum": [
"start_time",
"duration",
"name",
"index_count",
"repository",
"shard_count",
"failed_shard_count"
]
},
"snapshot._types.SnapshotState": {
"type": "string",
"enum": [
"IN_PROGRESS",
"SUCCESS",
"FAILED",
"PARTIAL",
"INCOMPATIBLE"
]
},
"snapshot.get.SnapshotResponseItem": {
"type": "object",
"properties": {
"repository": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"snapshots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snapshot._types.SnapshotInfo"
}
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"repository"
]
},
"snapshot.repository_analyze.SnapshotNodeInfo": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"id",
"name"
]
},
"snapshot.repository_analyze.DetailsInfo": {
"type": "object",
"properties": {
"blob": {
"description": "A description of the blob that was written and read.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.BlobDetails"
}
]
},
"overwrite_elapsed": {
"description": "The elapsed time spent overwriting the blob.\nIf the blob was not overwritten, this information is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"overwrite_elapsed_nanos": {
"description": "The elapsed time spent overwriting the blob, in nanoseconds.\nIf the blob was not overwritten, this information is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"write_elapsed": {
"description": "The elapsed time spent writing the blob.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"write_elapsed_nanos": {
"description": "The elapsed time spent writing the blob, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"write_throttled": {
"description": "The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or `indices.recovery.max_bytes_per_sec` if the recovery settings for managed services are set) throttle while writing the blob.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"write_throttled_nanos": {
"description": "The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or `indices.recovery.max_bytes_per_sec` if the recovery settings for managed services are set) throttle while writing the blob, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"writer_node": {
"description": "The node which wrote the blob and coordinated the read operations.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo"
}
]
}
},
"required": [
"blob",
"write_elapsed",
"write_elapsed_nanos",
"write_throttled",
"write_throttled_nanos",
"writer_node"
]
},
"snapshot.repository_analyze.BlobDetails": {
"type": "object",
"properties": {
"name": {
"description": "The name of the blob.",
"type": "string"
},
"overwritten": {
"description": "Indicates whether the blob was overwritten while the read operations were ongoing.\n /**",
"type": "boolean"
},
"read_early": {
"type": "boolean"
},
"read_end": {
"description": "The position, in bytes, at which read operations completed.",
"type": "number"
},
"read_start": {
"description": "The position, in bytes, at which read operations started.",
"type": "number"
},
"reads": {
"description": "A description of every read operation performed on the blob.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.ReadBlobDetails"
}
]
},
"size": {
"description": "The size of the blob.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"size_bytes": {
"description": "The size of the blob in bytes.",
"type": "number"
}
},
"required": [
"name",
"overwritten",
"read_early",
"read_end",
"read_start",
"reads",
"size",
"size_bytes"
]
},
"snapshot.repository_analyze.ReadBlobDetails": {
"type": "object",
"properties": {
"before_write_complete": {
"description": "Indicates whether the read operation may have started before the write operation was complete.",
"type": "boolean"
},
"elapsed": {
"description": "The length of time spent reading the blob.\nIf the blob was not found, this detail is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"elapsed_nanos": {
"description": "The length of time spent reading the blob, in nanoseconds.\nIf the blob was not found, this detail is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"first_byte_time": {
"description": "The length of time waiting for the first byte of the read operation to be received.\nIf the blob was not found, this detail is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"first_byte_time_nanos": {
"description": "The length of time waiting for the first byte of the read operation to be received, in nanoseconds.\nIf the blob was not found, this detail is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"found": {
"description": "Indicates whether the blob was found by the read operation.\nIf the read was started before the write completed or the write was ended before completion, it might be false.",
"type": "boolean"
},
"node": {
"description": "The node that performed the read operation.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo"
}
]
},
"throttled": {
"description": "The length of time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles during the read of the blob.\nIf the blob was not found, this detail is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttled_nanos": {
"description": "The length of time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles during the read of the blob, in nanoseconds.\nIf the blob was not found, this detail is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
}
},
"required": [
"first_byte_time_nanos",
"found",
"node"
]
},
"snapshot.repository_analyze.SummaryInfo": {
"type": "object",
"properties": {
"read": {
"description": "A collection of statistics that summarise the results of the read operations in the test.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.ReadSummaryInfo"
}
]
},
"write": {
"description": "A collection of statistics that summarise the results of the write operations in the test.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot.repository_analyze.WriteSummaryInfo"
}
]
}
},
"required": [
"read",
"write"
]
},
"snapshot.repository_analyze.ReadSummaryInfo": {
"type": "object",
"properties": {
"count": {
"description": "The number of read operations performed in the test.",
"type": "number"
},
"max_wait": {
"description": "The maximum time spent waiting for the first byte of any read request to be received.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"max_wait_nanos": {
"description": "The maximum time spent waiting for the first byte of any read request to be received, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"total_elapsed": {
"description": "The total elapsed time spent on reading blobs in the test.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_elapsed_nanos": {
"description": "The total elapsed time spent on reading blobs in the test, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"total_size": {
"description": "The total size of all the blobs or partial blobs read in the test.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_size_bytes": {
"description": "The total size of all the blobs or partial blobs read in the test, in bytes.",
"type": "number"
},
"total_throttled": {
"description": "The total time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_throttled_nanos": {
"description": "The total time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"total_wait": {
"description": "The total time spent waiting for the first byte of each read request to be received.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_wait_nanos": {
"description": "The total time spent waiting for the first byte of each read request to be received, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
}
},
"required": [
"count",
"max_wait",
"max_wait_nanos",
"total_elapsed",
"total_elapsed_nanos",
"total_size",
"total_size_bytes",
"total_throttled",
"total_throttled_nanos",
"total_wait",
"total_wait_nanos"
]
},
"snapshot.repository_analyze.WriteSummaryInfo": {
"type": "object",
"properties": {
"count": {
"description": "The number of write operations performed in the test.",
"type": "number"
},
"total_elapsed": {
"description": "The total elapsed time spent on writing blobs in the test.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_elapsed_nanos": {
"description": "The total elapsed time spent on writing blobs in the test, in nanoseconds.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitNanos"
}
]
},
"total_size": {
"description": "The total size of all the blobs written in the test.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_size_bytes": {
"description": "The total size of all the blobs written in the test, in bytes.",
"type": "number"
},
"total_throttled": {
"description": "The total time spent waiting due to the `max_snapshot_bytes_per_sec` throttle.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_throttled_nanos": {
"description": "The total time spent waiting due to the `max_snapshot_bytes_per_sec` throttle, in nanoseconds.",
"type": "number"
}
},
"required": [
"count",
"total_elapsed",
"total_elapsed_nanos",
"total_size",
"total_size_bytes",
"total_throttled",
"total_throttled_nanos"
]
},
"snapshot.restore.SnapshotRestore": {
"type": "object",
"properties": {
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
},
"snapshot": {
"type": "string"
},
"shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
}
},
"required": [
"indices",
"snapshot",
"shards"
]
},
"snapshot._types.Status": {
"type": "object",
"properties": {
"include_global_state": {
"description": "Indicates whether the current cluster state is included in the snapshot.",
"type": "boolean"
},
"indices": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/snapshot._types.SnapshotIndexStats"
}
},
"repository": {
"description": "The name of the repository that includes the snapshot.",
"type": "string"
},
"shards_stats": {
"description": "Statistics for the shards in the snapshot.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.ShardsStats"
}
]
},
"snapshot": {
"description": "The name of the snapshot.",
"type": "string"
},
"state": {
"description": "The current snapshot state:\n\n* `FAILED`: The snapshot finished with an error and failed to store any data.\n* `STARTED`: The snapshot is currently running.\n* `SUCCESS`: The snapshot completed.",
"type": "string"
},
"stats": {
"description": "Details about the number (`file_count`) and size (`size_in_bytes`) of files included in the snapshot.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.SnapshotStats"
}
]
},
"uuid": {
"description": "The universally unique identifier (UUID) for the snapshot.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Uuid"
}
]
}
},
"required": [
"include_global_state",
"indices",
"repository",
"shards_stats",
"snapshot",
"state",
"stats",
"uuid"
]
},
"snapshot._types.SnapshotIndexStats": {
"type": "object",
"properties": {
"shards": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/snapshot._types.SnapshotShardsStatus"
}
},
"shards_stats": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.ShardsStats"
}
]
},
"stats": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.SnapshotStats"
}
]
}
},
"required": [
"shards",
"shards_stats",
"stats"
]
},
"snapshot._types.SnapshotShardsStatus": {
"type": "object",
"properties": {
"stage": {
"description": "\n\nSupported values include:\n - `DONE`: The number of shards in the snapshot that were successfully stored in the repository.\n - `FAILURE`: The number of shards in the snapshot that were not successfully stored in the repository.\n - `FINALIZE`: The number of shards in the snapshot that are in the finalizing stage of being stored in the repository.\n - `INIT`: The number of shards in the snapshot that are in the initializing stage of being stored in the repository.\n - `STARTED`: The number of shards in the snapshot that are in the started stage of being stored in the repository.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.ShardsStatsStage"
}
]
},
"stats": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.ShardsStatsSummary"
}
]
}
},
"required": [
"stage",
"stats"
]
},
"snapshot._types.ShardsStatsStage": {
"type": "string",
"enum": [
"DONE",
"FAILURE",
"FINALIZE",
"INIT",
"STARTED"
]
},
"snapshot._types.ShardsStatsSummary": {
"type": "object",
"properties": {
"incremental": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.ShardsStatsSummaryItem"
}
]
},
"total": {
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.ShardsStatsSummaryItem"
}
]
},
"start_time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"incremental",
"total",
"start_time_in_millis",
"time_in_millis"
]
},
"snapshot._types.ShardsStatsSummaryItem": {
"type": "object",
"properties": {
"file_count": {
"type": "number"
},
"size_in_bytes": {
"type": "number"
}
},
"required": [
"file_count",
"size_in_bytes"
]
},
"snapshot._types.ShardsStats": {
"type": "object",
"properties": {
"done": {
"description": "The number of shards that initialized, started, and finalized successfully.",
"type": "number"
},
"failed": {
"description": "The number of shards that failed to be included in the snapshot.",
"type": "number"
},
"finalizing": {
"description": "The number of shards that are finalizing but are not done.",
"type": "number"
},
"initializing": {
"description": "The number of shards that are still initializing.",
"type": "number"
},
"started": {
"description": "The number of shards that have started but are not finalized.",
"type": "number"
},
"total": {
"description": "The total number of shards included in the snapshot.",
"type": "number"
}
},
"required": [
"done",
"failed",
"finalizing",
"initializing",
"started",
"total"
]
},
"snapshot._types.SnapshotStats": {
"type": "object",
"properties": {
"incremental": {
"description": "The number and size of files that still need to be copied as part of the incremental snapshot.\nFor completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.FileCountSnapshotStats"
}
]
},
"start_time_in_millis": {
"description": "The time, in milliseconds, when the snapshot creation process started.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"time_in_millis": {
"description": "The total time, in milliseconds, that it took for the snapshot process to complete.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"total": {
"description": "The total number and size of files that are referenced by the snapshot.",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.FileCountSnapshotStats"
}
]
}
},
"required": [
"incremental",
"start_time_in_millis",
"time_in_millis",
"total"
]
},
"snapshot._types.FileCountSnapshotStats": {
"type": "object",
"properties": {
"file_count": {
"type": "number"
},
"size_in_bytes": {
"type": "number"
}
},
"required": [
"file_count",
"size_in_bytes"
]
},
"snapshot.verify_repository.CompactNodeInfo": {
"type": "object",
"properties": {
"name": {
"description": "A human-readable name for the node.\nYou can set this name using the `node.name` property in `elasticsearch.yml`.\nThe default value is the machine's hostname.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
}
},
"required": [
"name"
]
},
"sql._types.Column": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
]
},
"sql._types.Row": {
"type": "array",
"items": {
"type": "object"
}
},
"sql.query.SqlFormat": {
"type": "string",
"enum": [
"csv",
"json",
"tsv",
"txt",
"yaml",
"cbor",
"smile"
]
},
"ssl.certificates.CertificateInformation": {
"type": "object",
"properties": {
"alias": {
"description": "If the path refers to a container file (a jks keystore, or a PKCS#12 file), it is the alias of the certificate.\nOtherwise, it is null.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"expiry": {
"description": "The ISO formatted date of the certificate's expiry (not-after) date.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"format": {
"description": "The format of the file.\nValid values include `jks`, `PKCS12`, and `PEM`.",
"type": "string"
},
"has_private_key": {
"description": "Indicates whether Elasticsearch has access to the private key for this certificate.",
"type": "boolean"
},
"issuer": {
"description": "The Distinguished Name of the certificate's issuer.",
"type": "string"
},
"path": {
"description": "The path to the certificate, as configured in the `elasticsearch.yml` file.",
"type": "string"
},
"serial_number": {
"description": "The hexadecimal representation of the certificate's serial number.",
"type": "string"
},
"subject_dn": {
"description": "The Distinguished Name of the certificate's subject.",
"type": "string"
}
},
"required": [
"alias",
"expiry",
"format",
"has_private_key",
"path",
"serial_number",
"subject_dn"
]
},
"streams._types.StreamType": {
"type": "string",
"enum": [
"logs",
"logs.otel",
"logs.ecs"
]
},
"streams.status.StreamStatus": {
"type": "object",
"properties": {
"enabled": {
"description": "If true, the stream feature is enabled.",
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"synonyms._types.SynonymsUpdateResult": {
"type": "object",
"properties": {
"result": {
"description": "The update operation result.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Result"
}
]
},
"reload_analyzers_details": {
"description": "Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result.",
"allOf": [
{
"$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult"
}
]
}
},
"required": [
"result"
]
},
"synonyms._types.SynonymRuleRead": {
"type": "object",
"properties": {
"id": {
"description": "The identifier for the synonym rule.\nIf you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"synonyms": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms"
},
"description": "The synonyms that conform the synonym rule in Solr format.",
"allOf": [
{
"$ref": "#/components/schemas/synonyms._types.SynonymString"
}
]
}
},
"required": [
"id",
"synonyms"
]
},
"synonyms._types.SynonymString": {
"type": "string"
},
"synonyms.get_synonyms_sets.SynonymsSetItem": {
"type": "object",
"properties": {
"synonyms_set": {
"description": "Synonyms set identifier",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"count": {
"description": "Number of synonym rules that the synonym set contains",
"type": "number"
}
},
"required": [
"synonyms_set",
"count"
]
},
"synonyms._types.SynonymRule": {
"type": "object",
"properties": {
"id": {
"description": "The identifier for the synonym rule.\nIf you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"synonyms": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms"
},
"description": "The synonyms that conform the synonym rule in Solr format.",
"allOf": [
{
"$ref": "#/components/schemas/synonyms._types.SynonymString"
}
]
}
},
"required": [
"synonyms"
]
},
"text_structure._types.EcsCompatibilityType": {
"type": "string",
"enum": [
"disabled",
"v1"
]
},
"text_structure._types.FormatType": {
"type": "string",
"enum": [
"delimited",
"ndjson",
"semi_structured_text",
"xml"
]
},
"text_structure._types.FieldStat": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"cardinality": {
"type": "number"
},
"top_hits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/text_structure._types.TopHit"
}
},
"mean_value": {
"type": "number"
},
"median_value": {
"type": "number"
},
"max_value": {
"type": "number"
},
"min_value": {
"type": "number"
},
"earliest": {
"type": "string"
},
"latest": {
"type": "string"
}
},
"required": [
"count",
"cardinality",
"top_hits"
]
},
"text_structure._types.TopHit": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"value": {
"type": "object"
}
},
"required": [
"count",
"value"
]
},
"ingest._types.PipelineConfig": {
"type": "object",
"properties": {
"description": {
"description": "Description of the ingest pipeline.",
"type": "string"
},
"version": {
"description": "Version number used by external systems to track ingest pipelines.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"processors": {
"description": "Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.ProcessorContainer"
}
}
},
"required": [
"processors"
]
},
"text_structure.find_structure.FindStructureFormat": {
"type": "string",
"enum": [
"ndjson",
"xml",
"delimited",
"semi_structured_text"
]
},
"text_structure.test_grok_pattern.MatchedText": {
"type": "object",
"properties": {
"matched": {
"type": "boolean"
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/text_structure.test_grok_pattern.MatchedField"
}
}
}
},
"required": [
"matched"
]
},
"text_structure.test_grok_pattern.MatchedField": {
"type": "object",
"properties": {
"match": {
"type": "string"
},
"offset": {
"type": "number"
},
"length": {
"type": "number"
}
},
"required": [
"match",
"offset",
"length"
]
},
"transform.get_node_stats.TransformNodeFullStats": {
"type": "object",
"properties": {
"total": {
"allOf": [
{
"$ref": "#/components/schemas/transform.get_node_stats.TransformNodeStats"
}
]
}
},
"required": [
"total"
]
},
"transform.get_node_stats.TransformNodeStats": {
"type": "object",
"properties": {
"scheduler": {
"allOf": [
{
"$ref": "#/components/schemas/transform.get_node_stats.TransformSchedulerStats"
}
]
}
},
"required": [
"scheduler"
]
},
"transform.get_node_stats.TransformSchedulerStats": {
"type": "object",
"properties": {
"registered_transform_count": {
"type": "number"
},
"peek_transform": {
"type": "string"
}
},
"required": [
"registered_transform_count"
]
},
"transform.get_transform.TransformSummary": {
"type": "object",
"properties": {
"authorization": {
"description": "The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.TransformAuthorization"
}
]
},
"create_time": {
"description": "The time the transform was created.",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"create_time_string": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"description": {
"description": "Free text description of the transform.",
"type": "string"
},
"dest": {
"description": "The destination for the transform.",
"allOf": [
{
"$ref": "#/components/schemas/_global.reindex.Destination"
}
]
},
"frequency": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"latest": {
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Latest"
}
]
},
"pivot": {
"description": "The pivot method transforms the data by aggregating and grouping it.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Pivot"
}
]
},
"retention_policy": {
"allOf": [
{
"$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
}
]
},
"settings": {
"description": "Defines optional transform settings.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Settings"
}
]
},
"source": {
"description": "The source of the data for the transform.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Source"
}
]
},
"sync": {
"description": "Defines the properties transforms require to run continuously.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.SyncContainer"
}
]
},
"version": {
"description": "The version of Elasticsearch that existed on the node when the transform was created.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
},
"_meta": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
},
"required": [
"dest",
"id",
"source"
]
},
"ml._types.TransformAuthorization": {
"type": "object",
"properties": {
"api_key": {
"description": "If an API key was used for the most recent update to the transform, its name and identifier are listed in the response.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.ApiKeyAuthorization"
}
]
},
"roles": {
"description": "If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response.",
"type": "array",
"items": {
"type": "string"
}
},
"service_account": {
"description": "If a service account was used for the most recent update to the transform, the account name is listed in the response.",
"type": "string"
}
}
},
"transform._types.Latest": {
"type": "object",
"properties": {
"sort": {
"description": "Specifies the date field that is used to identify the latest documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"unique_key": {
"description": "Specifies an array of one or more fields that are used to group the data.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
}
},
"required": [
"sort",
"unique_key"
]
},
"transform._types.Pivot": {
"type": "object",
"properties": {
"aggregations": {
"description": "Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket\nscript, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,\nmin, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted\naverage.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"group_by": {
"description": "Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are\ncurrently supported: date histogram, geotile grid, histogram, terms.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/transform._types.PivotGroupByContainer"
}
}
}
},
"transform._types.PivotGroupByContainer": {
"type": "object",
"properties": {
"date_histogram": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation"
}
]
},
"geotile_grid": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation"
}
]
},
"histogram": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.HistogramAggregation"
}
]
},
"terms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.aggregations.TermsAggregation"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"transform._types.RetentionPolicyContainer": {
"type": "object",
"properties": {
"time": {
"description": "Specifies that the transform uses a time field to set the retention policy.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.RetentionPolicy"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"transform._types.RetentionPolicy": {
"type": "object",
"properties": {
"field": {
"description": "The date field that is used to calculate the age of the document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"max_age": {
"description": "Specifies the maximum age of a document in the destination index. Documents that are older than the configured\nvalue are removed from the destination index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"field",
"max_age"
]
},
"transform._types.Settings": {
"description": "The source of the data for the transform.",
"type": "object",
"properties": {
"align_checkpoints": {
"description": "Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align\ncheckpoint ranges with the date histogram interval when date histogram is specified as a group source in the\ntransform config. As a result, less document updates in the destination index will be performed thus improving\noverall performance.",
"default": true,
"type": "boolean"
},
"dates_as_epoch_millis": {
"description": "Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was\nthe default for transforms created before version 7.11. For compatible output set this value to `true`.",
"default": false,
"type": "boolean"
},
"deduce_mappings": {
"description": "Specifies whether the transform should deduce the destination index mappings from the transform configuration.",
"default": true,
"type": "boolean"
},
"docs_per_second": {
"description": "Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a\nwait time between search requests. The default value is null, which disables throttling.",
"type": "number"
},
"max_page_search_size": {
"description": "Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker\nexceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500` for `pivot` transforms and `5000` for `latest` transforms.",
"type": "number"
},
"use_point_in_time": {
"externalDocs": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time"
},
"description": "Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.\nIn general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount\nof refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a\ngiven index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and\nthe amount of other consumers searching the same source index.",
"default": true,
"type": "boolean"
},
"num_failure_retries": {
"description": "Defines the number of retries on a recoverable failure before the transform task is marked as `failed`.\nThe minimum value is `0` and the maximum is `100`, where `-1` indicates that the transform retries indefinitely.\nIf unset, the cluster-level setting `num_transform_failure_retries` is used.\n\nThis setting cannot be specified when `unattended` is `true`, because unattended transforms always retry\nindefinitely.",
"x-state": "Generally available; Added in 8.4.0",
"type": "number"
},
"unattended": {
"description": "If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case\nof an error which means the transform never fails. Setting the number of retries other than infinite fails in\nvalidation.",
"default": false,
"x-state": "Generally available; Added in 8.5.0",
"type": "boolean"
}
}
},
"transform._types.Source": {
"type": "object",
"properties": {
"index": {
"description": "The source indices for the transform. It can be a single index, an index pattern (for example, `\"my-index-*\"\"`), an\narray of indices (for example, `[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns (for\nexample, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use the syntax `\"remote_name:index_name\"`. If\nany indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"runtime_mappings": {
"description": "Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data\nnodes, including remote nodes, must be 7.12 or later.",
"x-state": "Generally available; Added in 7.12.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"query": {
"x-model": true,
"type": "object",
"description": "A query clause that retrieves a subset of data from the source index.\n",
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl",
"description": "Query DSL"
}
}
},
"required": [
"index"
]
},
"transform._types.SyncContainer": {
"type": "object",
"properties": {
"time": {
"description": "Specifies that the transform uses a time field to synchronize the source and destination indices.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.TimeSync"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"transform._types.TimeSync": {
"type": "object",
"properties": {
"delay": {
"description": "The time delay between the current time and the latest input data time.",
"default": "60s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"field": {
"description": "The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field\nthat contains the ingest timestamp. If you use a different field, you might need to set the delay such that it\naccounts for data transmission delays.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"field"
]
},
"transform.get_transform_stats.TransformStats": {
"type": "object",
"properties": {
"checkpointing": {
"allOf": [
{
"$ref": "#/components/schemas/transform.get_transform_stats.Checkpointing"
}
]
},
"health": {
"allOf": [
{
"$ref": "#/components/schemas/transform.get_transform_stats.TransformStatsHealth"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"node": {
"x-state": "Generally available",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeAttributes"
}
]
},
"reason": {
"type": "string"
},
"state": {
"type": "string"
},
"stats": {
"allOf": [
{
"$ref": "#/components/schemas/transform.get_transform_stats.TransformIndexerStats"
}
]
}
},
"required": [
"checkpointing",
"id",
"state",
"stats"
]
},
"transform.get_transform_stats.Checkpointing": {
"type": "object",
"properties": {
"changes_last_detected_at": {
"type": "number"
},
"changes_last_detected_at_string": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"last": {
"allOf": [
{
"$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats"
}
]
},
"next": {
"allOf": [
{
"$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats"
}
]
},
"operations_behind": {
"type": "number"
},
"last_search_time": {
"type": "number"
},
"last_search_time_string": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"last"
]
},
"transform.get_transform_stats.CheckpointStats": {
"type": "object",
"properties": {
"checkpoint": {
"type": "number"
},
"checkpoint_progress": {
"allOf": [
{
"$ref": "#/components/schemas/transform.get_transform_stats.TransformProgress"
}
]
},
"timestamp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"timestamp_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"time_upper_bound": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"time_upper_bound_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
}
},
"required": [
"checkpoint"
]
},
"transform.get_transform_stats.TransformProgress": {
"type": "object",
"properties": {
"docs_indexed": {
"type": "number"
},
"docs_processed": {
"type": "number"
},
"docs_remaining": {
"type": "number"
},
"percent_complete": {
"type": "number"
},
"total_docs": {
"type": "number"
}
},
"required": [
"docs_indexed",
"docs_processed"
]
},
"transform.get_transform_stats.TransformStatsHealth": {
"type": "object",
"properties": {
"status": {
"description": "\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",
"allOf": [
{
"$ref": "#/components/schemas/_types.HealthStatus"
}
]
},
"issues": {
"description": "If a non-healthy status is returned, contains a list of issues of the transform.",
"type": "array",
"items": {
"$ref": "#/components/schemas/transform.get_transform_stats.TransformHealthIssue"
}
}
},
"required": [
"status"
]
},
"transform.get_transform_stats.TransformHealthIssue": {
"type": "object",
"properties": {
"type": {
"description": "The type of the issue",
"type": "string"
},
"issue": {
"description": "A description of the issue",
"type": "string"
},
"details": {
"description": "Details about the issue",
"type": "string"
},
"count": {
"description": "Number of times this issue has occurred since it started",
"type": "number"
},
"first_occurrence": {
"description": "The timestamp this issue occurred for for the first time",
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"first_occurence_string": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"type",
"issue",
"count"
]
},
"transform.get_transform_stats.TransformIndexerStats": {
"type": "object",
"properties": {
"delete_time_in_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"documents_indexed": {
"type": "number"
},
"documents_deleted": {
"type": "number"
},
"documents_processed": {
"type": "number"
},
"exponential_avg_checkpoint_duration_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
}
]
},
"exponential_avg_documents_indexed": {
"type": "number"
},
"exponential_avg_documents_processed": {
"type": "number"
},
"index_failures": {
"type": "number"
},
"index_time_in_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"index_total": {
"type": "number"
},
"pages_processed": {
"type": "number"
},
"processing_time_in_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"processing_total": {
"type": "number"
},
"search_failures": {
"type": "number"
},
"search_time_in_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"search_total": {
"type": "number"
},
"trigger_count": {
"type": "number"
}
},
"required": [
"documents_indexed",
"documents_processed",
"exponential_avg_checkpoint_duration_ms",
"exponential_avg_documents_indexed",
"exponential_avg_documents_processed",
"index_failures",
"index_time_in_ms",
"index_total",
"pages_processed",
"processing_time_in_ms",
"processing_total",
"search_failures",
"search_time_in_ms",
"search_total",
"trigger_count"
]
},
"transform._types.Destination": {
"type": "object",
"properties": {
"index": {
"description": "The destination index for the transform. The mappings of the destination index are deduced based on the source\nfields when possible. If alternate mappings are required, use the create index API prior to starting the\ntransform.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"pipeline": {
"description": "The unique identifier for an ingest pipeline.",
"type": "string"
}
}
},
"_global.update.UpdateWriteResponseBase": {
"allOf": [
{
"$ref": "#/components/schemas/_types.WriteResponseBase"
},
{
"type": "object",
"properties": {
"get": {
"allOf": [
{
"$ref": "#/components/schemas/_types.InlineGet"
}
]
}
}
}
]
},
"_global.update_by_query_rethrottle.UpdateByQueryRethrottleNode": {
"allOf": [
{
"$ref": "#/components/schemas/_spec_utils.BaseNode"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/tasks._types.TaskInfo"
}
}
},
"required": [
"tasks"
]
}
]
},
"watcher._types.WatchStatus": {
"type": "object",
"properties": {
"actions": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.Actions"
}
]
},
"last_checked": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"last_met_condition": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActivationState"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"execution_state": {
"type": "string"
}
},
"required": [
"actions",
"state",
"version"
]
},
"watcher._types.Actions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/watcher._types.ActionStatus"
}
},
"watcher._types.ActionStatus": {
"type": "object",
"properties": {
"ack": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.AcknowledgeState"
}
]
},
"last_execution": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ExecutionState"
}
]
},
"last_successful_execution": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ExecutionState"
}
]
},
"last_throttle": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ThrottleState"
}
]
}
},
"required": [
"ack"
]
},
"watcher._types.AcknowledgeState": {
"type": "object",
"properties": {
"state": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.AcknowledgementOptions"
}
]
},
"timestamp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"state",
"timestamp"
]
},
"watcher._types.AcknowledgementOptions": {
"type": "string",
"enum": [
"awaits_successful_execution",
"ackable",
"acked"
]
},
"watcher._types.ExecutionState": {
"type": "object",
"properties": {
"successful": {
"type": "boolean"
},
"timestamp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"reason": {
"type": "string"
}
},
"required": [
"successful",
"timestamp"
]
},
"watcher._types.ThrottleState": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"timestamp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"reason",
"timestamp"
]
},
"watcher._types.ActivationState": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"timestamp": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"active",
"timestamp"
]
},
"watcher._types.ActivationStatus": {
"type": "object",
"properties": {
"actions": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.Actions"
}
]
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActivationState"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"actions",
"state",
"version"
]
},
"watcher._types.ActionExecutionMode": {
"type": "string",
"enum": [
"simulate",
"force_simulate",
"execute",
"force_execute",
"skip"
]
},
"watcher._types.SimulatedActions": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
}
},
"all": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SimulatedActions"
}
]
},
"use_all": {
"type": "boolean"
}
},
"required": [
"actions",
"all",
"use_all"
]
},
"watcher._types.ScheduleTriggerEvent": {
"type": "object",
"properties": {
"scheduled_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"triggered_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"scheduled_time"
]
},
"watcher._types.Watch": {
"type": "object",
"properties": {
"actions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/watcher._types.Action"
}
},
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ConditionContainer"
}
]
},
"input": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.InputContainer"
}
]
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.WatchStatus"
}
]
},
"throttle_period": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttle_period_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"transform": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransformContainer"
}
]
},
"trigger": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.TriggerContainer"
}
]
}
},
"required": [
"actions",
"condition",
"input",
"trigger"
]
},
"watcher._types.Action": {
"type": "object",
"properties": {
"action_type": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActionType"
}
]
},
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ConditionContainer"
}
]
},
"foreach": {
"type": "string"
},
"max_iterations": {
"type": "number"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"throttle_period": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttle_period_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"transform": {
"allOf": [
{
"$ref": "#/components/schemas/_types.TransformContainer"
}
]
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.IndexAction"
}
]
},
"logging": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.LoggingAction"
}
]
},
"email": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.EmailAction"
}
]
},
"pagerduty": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.PagerDutyAction"
}
]
},
"slack": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SlackAction"
}
]
},
"webhook": {
"x-state": "Generally available; Added in 7.14.0",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.WebhookAction"
}
]
}
}
},
"watcher._types.ActionType": {
"type": "string",
"enum": [
"email",
"webhook",
"index",
"logging",
"slack",
"pagerduty"
]
},
"watcher._types.ConditionContainer": {
"type": "object",
"properties": {
"always": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.AlwaysCondition"
}
]
},
"array_compare": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/watcher._types.ArrayCompareCondition"
},
"minProperties": 1,
"maxProperties": 1
},
"compare": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.FieldValue"
},
"minProperties": 1,
"maxProperties": 1
},
"minProperties": 1,
"maxProperties": 1
},
"never": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.NeverCondition"
}
]
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ScriptCondition"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"watcher._types.AlwaysCondition": {
"type": "object"
},
"watcher._types.ArrayCompareCondition": {
"type": "object",
"properties": {
"path": {
"type": "string"
}
},
"required": [
"path"
]
},
"watcher._types.NeverCondition": {
"type": "object"
},
"watcher._types.ScriptCondition": {
"type": "object",
"properties": {
"lang": {
"description": "\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
"default": "painless",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptLanguage"
}
]
},
"params": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSource"
}
]
},
"id": {
"type": "string"
}
}
},
"_types.TransformContainer": {
"type": "object",
"properties": {
"chain": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.TransformContainer"
}
},
"script": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptTransform"
}
]
},
"search": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SearchTransform"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"_types.ScriptTransform": {
"type": "object",
"properties": {
"lang": {
"default": "painless",
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSource"
}
]
},
"id": {
"type": "string"
}
}
},
"_types.SearchTransform": {
"type": "object",
"properties": {
"request": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SearchInputRequestDefinition"
}
]
},
"timeout": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"request",
"timeout"
]
},
"watcher._types.SearchInputRequestDefinition": {
"type": "object",
"properties": {
"body": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SearchInputRequestBody"
}
]
},
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.IndexName"
}
},
"indices_options": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndicesOptions"
}
]
},
"search_type": {
"description": "\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.SearchType"
}
]
},
"template": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SearchTemplateRequestBody"
}
]
},
"rest_total_hits_as_int": {
"type": "boolean"
}
}
},
"watcher._types.SearchInputRequestBody": {
"type": "object",
"properties": {
"query": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
},
"required": [
"query"
]
},
"watcher._types.SearchTemplateRequestBody": {
"type": "object",
"properties": {
"explain": {
"default": false,
"type": "boolean"
},
"id": {
"description": "ID of the search template to use. If no source is specified,\nthis parameter is required.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"params": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"profile": {
"default": false,
"type": "boolean"
},
"source": {
"description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.",
"type": "string"
}
}
},
"watcher._types.IndexAction": {
"type": "object",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"doc_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"refresh": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Refresh"
}
]
},
"op_type": {
"description": "\n\nSupported values include:\n - `index`: Overwrite any documents that already exist.\n - `create`: Only index documents that do not already exist.\n\n",
"default": "index",
"allOf": [
{
"$ref": "#/components/schemas/_types.OpType"
}
]
},
"timeout": {
"default": "60s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"execution_time_field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"index"
]
},
"watcher._types.LoggingAction": {
"type": "object",
"properties": {
"level": {
"type": "string"
},
"text": {
"type": "string"
},
"category": {
"type": "string"
}
},
"required": [
"text"
]
},
"watcher._types.EmailAction": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.Email"
},
{
"type": "object"
}
]
},
"watcher._types.Email": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"bcc": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"body": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.EmailBody"
}
]
},
"cc": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"from": {
"type": "string"
},
"priority": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.EmailPriority"
}
]
},
"reply_to": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"sent_date": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"subject": {
"type": "string"
},
"to": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"attachments": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/watcher._types.EmailAttachmentContainer"
}
}
},
"required": [
"subject",
"to"
]
},
"watcher._types.EmailBody": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"text": {
"type": "string"
}
}
},
"watcher._types.EmailPriority": {
"type": "string",
"enum": [
"lowest",
"low",
"normal",
"high",
"highest"
]
},
"watcher._types.EmailAttachmentContainer": {
"type": "object",
"properties": {
"http": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpEmailAttachment"
}
]
},
"reporting": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ReportingEmailAttachment"
}
]
},
"data": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.DataEmailAttachment"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"watcher._types.HttpEmailAttachment": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"inline": {
"type": "boolean"
},
"request": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition"
}
]
}
}
},
"watcher._types.HttpInputRequestDefinition": {
"type": "object",
"properties": {
"auth": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputAuthentication"
}
]
},
"body": {
"type": "string"
},
"connection_timeout": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"host": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"method": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputMethod"
}
]
},
"params": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"path": {
"type": "string"
},
"port": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"proxy": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputProxy"
}
]
},
"read_timeout": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"scheme": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ConnectionScheme"
}
]
},
"url": {
"type": "string"
}
}
},
"watcher._types.HttpInputAuthentication": {
"type": "object",
"properties": {
"basic": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputBasicAuthentication"
}
]
}
},
"required": [
"basic"
]
},
"watcher._types.HttpInputBasicAuthentication": {
"type": "object",
"properties": {
"password": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Password"
}
]
},
"username": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
}
},
"required": [
"password",
"username"
]
},
"watcher._types.HttpInputMethod": {
"type": "string",
"enum": [
"head",
"get",
"post",
"put",
"delete"
]
},
"watcher._types.HttpInputProxy": {
"type": "object",
"properties": {
"host": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"port": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
}
},
"required": [
"host",
"port"
]
},
"watcher._types.ConnectionScheme": {
"type": "string",
"enum": [
"http",
"https"
]
},
"watcher._types.ReportingEmailAttachment": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"inline": {
"type": "boolean"
},
"retries": {
"default": 40,
"type": "number"
},
"interval": {
"default": "15s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"request": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition"
}
]
}
},
"required": [
"url"
]
},
"watcher._types.DataEmailAttachment": {
"type": "object",
"properties": {
"format": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.DataAttachmentFormat"
}
]
}
}
},
"watcher._types.DataAttachmentFormat": {
"type": "string",
"enum": [
"json",
"yaml"
]
},
"watcher._types.PagerDutyAction": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.PagerDutyEvent"
},
{
"type": "object"
}
]
},
"watcher._types.PagerDutyEvent": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"attach_payload": {
"type": "boolean"
},
"client": {
"type": "string"
},
"client_url": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.PagerDutyContext"
}
},
"description": {
"type": "string"
},
"event_type": {
"default": "trigger",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.PagerDutyEventType"
}
]
},
"incident_key": {
"type": "string"
},
"proxy": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.PagerDutyEventProxy"
}
]
}
},
"required": [
"attach_payload",
"description",
"incident_key"
]
},
"watcher._types.PagerDutyContext": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"src": {
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.PagerDutyContextType"
}
]
}
},
"required": [
"type"
]
},
"watcher._types.PagerDutyContextType": {
"type": "string",
"enum": [
"link",
"image"
]
},
"watcher._types.PagerDutyEventType": {
"type": "string",
"enum": [
"trigger",
"resolve",
"acknowledge"
]
},
"watcher._types.PagerDutyEventProxy": {
"type": "object",
"properties": {
"host": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Host"
}
]
},
"port": {
"type": "number"
}
}
},
"watcher._types.SlackAction": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"message": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SlackMessage"
}
]
}
},
"required": [
"message"
]
},
"watcher._types.SlackMessage": {
"type": "object",
"properties": {
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.SlackAttachment"
}
},
"dynamic_attachments": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SlackDynamicAttachment"
}
]
},
"from": {
"type": "string"
},
"icon": {
"type": "string"
},
"text": {
"type": "string"
},
"to": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"attachments",
"from",
"text",
"to"
]
},
"watcher._types.SlackAttachment": {
"type": "object",
"properties": {
"author_icon": {
"type": "string"
},
"author_link": {
"type": "string"
},
"author_name": {
"type": "string"
},
"color": {
"type": "string"
},
"fallback": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.SlackAttachmentField"
}
},
"footer": {
"type": "string"
},
"footer_icon": {
"type": "string"
},
"image_url": {
"type": "string"
},
"pretext": {
"type": "string"
},
"text": {
"type": "string"
},
"thumb_url": {
"type": "string"
},
"title": {
"type": "string"
},
"title_link": {
"type": "string"
},
"ts": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitSeconds"
}
]
}
},
"required": [
"author_name",
"title"
]
},
"watcher._types.SlackAttachmentField": {
"type": "object",
"properties": {
"short": {
"type": "boolean"
},
"title": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"short",
"title",
"value"
]
},
"watcher._types.SlackDynamicAttachment": {
"type": "object",
"properties": {
"attachment_template": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SlackAttachment"
}
]
},
"list_path": {
"type": "string"
}
},
"required": [
"attachment_template",
"list_path"
]
},
"watcher._types.WebhookAction": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition"
},
{
"type": "object"
}
]
},
"watcher._types.InputContainer": {
"type": "object",
"properties": {
"chain": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ChainInput"
}
]
},
"http": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInput"
}
]
},
"search": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SearchInput"
}
]
},
"simple": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"minProperties": 1,
"maxProperties": 1
},
"watcher._types.ChainInput": {
"type": "object",
"properties": {
"inputs": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/watcher._types.InputContainer"
},
"minProperties": 1,
"maxProperties": 1
}
}
},
"required": [
"inputs"
]
},
"watcher._types.HttpInput": {
"type": "object",
"properties": {
"extract": {
"type": "array",
"items": {
"type": "string"
}
},
"request": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition"
}
]
},
"response_content_type": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ResponseContentType"
}
]
}
}
},
"watcher._types.ResponseContentType": {
"type": "string",
"enum": [
"json",
"yaml",
"text"
]
},
"watcher._types.SearchInput": {
"type": "object",
"properties": {
"extract": {
"type": "array",
"items": {
"type": "string"
}
},
"request": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SearchInputRequestDefinition"
}
]
},
"timeout": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
},
"required": [
"request"
]
},
"watcher._types.TriggerContainer": {
"type": "object",
"properties": {
"schedule": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ScheduleContainer"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"watcher._types.ScheduleContainer": {
"type": "object",
"properties": {
"timezone": {
"type": "string"
},
"cron": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.CronExpression"
}
]
},
"daily": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.DailySchedule"
}
]
},
"hourly": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HourlySchedule"
}
]
},
"interval": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"monthly": {
"oneOf": [
{
"$ref": "#/components/schemas/watcher._types.TimeOfMonth"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.TimeOfMonth"
}
}
]
},
"weekly": {
"oneOf": [
{
"$ref": "#/components/schemas/watcher._types.TimeOfWeek"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.TimeOfWeek"
}
}
]
},
"yearly": {
"oneOf": [
{
"$ref": "#/components/schemas/watcher._types.TimeOfYear"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.TimeOfYear"
}
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"watcher._types.DailySchedule": {
"type": "object",
"properties": {
"at": {
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.ScheduleTimeOfDay"
}
}
},
"required": [
"at"
]
},
"watcher._types.HourlySchedule": {
"type": "object",
"properties": {
"minute": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"minute"
]
},
"watcher._types.TimeOfMonth": {
"type": "object",
"properties": {
"at": {
"type": "array",
"items": {
"type": "string"
}
},
"on": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"at",
"on"
]
},
"watcher._types.TimeOfWeek": {
"type": "object",
"properties": {
"at": {
"type": "array",
"items": {
"type": "string"
}
},
"on": {
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.Day"
}
}
},
"required": [
"at",
"on"
]
},
"watcher._types.Day": {
"type": "string",
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
]
},
"watcher._types.TimeOfYear": {
"type": "object",
"properties": {
"at": {
"type": "array",
"items": {
"type": "string"
}
},
"int": {
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.Month"
}
},
"on": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"at",
"int",
"on"
]
},
"watcher._types.Month": {
"type": "string",
"enum": [
"january",
"february",
"march",
"april",
"may",
"june",
"july",
"august",
"september",
"october",
"november",
"december"
]
},
"watcher.execute_watch.WatchRecord": {
"type": "object",
"properties": {
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ConditionContainer"
}
]
},
"input": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.InputContainer"
}
]
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"node": {
"type": "string"
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ExecutionResult"
}
]
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ExecutionStatus"
}
]
},
"trigger_event": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.TriggerEventResult"
}
]
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
},
"watch_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.WatchStatus"
}
]
}
},
"required": [
"condition",
"input",
"messages",
"node",
"result",
"state",
"trigger_event",
"user",
"watch_id"
]
},
"watcher._types.ExecutionResult": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.ExecutionResultAction"
}
},
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ExecutionResultCondition"
}
]
},
"execution_duration": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"execution_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"input": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ExecutionResultInput"
}
]
}
},
"required": [
"actions",
"condition",
"execution_duration",
"execution_time",
"input"
]
},
"watcher._types.ExecutionResultAction": {
"type": "object",
"properties": {
"email": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.EmailResult"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.IndexResult"
}
]
},
"logging": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.LoggingResult"
}
]
},
"pagerduty": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.PagerDutyResult"
}
]
},
"reason": {
"type": "string"
},
"slack": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SlackResult"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActionStatusOptions"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActionType"
}
]
},
"webhook": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.WebhookResult"
}
]
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ErrorCause"
}
]
}
},
"required": [
"id",
"status",
"type"
]
},
"watcher._types.EmailResult": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"message": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.Email"
}
]
},
"reason": {
"type": "string"
}
},
"required": [
"message"
]
},
"watcher._types.IndexResult": {
"type": "object",
"properties": {
"response": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.IndexResultSummary"
}
]
}
},
"required": [
"response"
]
},
"watcher._types.IndexResultSummary": {
"type": "object",
"properties": {
"created": {
"type": "boolean"
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Result"
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"created",
"id",
"index",
"result",
"version"
]
},
"watcher._types.LoggingResult": {
"type": "object",
"properties": {
"logged_text": {
"type": "string"
}
},
"required": [
"logged_text"
]
},
"watcher._types.PagerDutyResult": {
"type": "object",
"properties": {
"event": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.PagerDutyEvent"
}
]
},
"reason": {
"type": "string"
},
"request": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputRequestResult"
}
]
},
"response": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputResponseResult"
}
]
}
},
"required": [
"event"
]
},
"watcher._types.HttpInputRequestResult": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition"
},
{
"type": "object"
}
]
},
"watcher._types.HttpInputResponseResult": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"headers": {
"allOf": [
{
"$ref": "#/components/schemas/_types.HttpHeaders"
}
]
},
"status": {
"type": "number"
}
},
"required": [
"body",
"headers",
"status"
]
},
"watcher._types.SlackResult": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"message": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SlackMessage"
}
]
}
},
"required": [
"message"
]
},
"watcher._types.ActionStatusOptions": {
"type": "string",
"enum": [
"success",
"failure",
"simulated",
"throttled"
]
},
"watcher._types.WebhookResult": {
"type": "object",
"properties": {
"request": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputRequestResult"
}
]
},
"response": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.HttpInputResponseResult"
}
]
}
},
"required": [
"request"
]
},
"watcher._types.ExecutionResultCondition": {
"type": "object",
"properties": {
"met": {
"type": "boolean"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActionStatusOptions"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ConditionType"
}
]
}
},
"required": [
"met",
"status",
"type"
]
},
"watcher._types.ConditionType": {
"type": "string",
"enum": [
"always",
"never",
"script",
"compare",
"array_compare"
]
},
"watcher._types.ExecutionResultInput": {
"type": "object",
"properties": {
"payload": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActionStatusOptions"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.InputType"
}
]
}
},
"required": [
"payload",
"status",
"type"
]
},
"watcher._types.InputType": {
"type": "string",
"enum": [
"http",
"search",
"simple"
]
},
"watcher._types.ExecutionStatus": {
"type": "string",
"enum": [
"awaits_execution",
"checking",
"execution_not_needed",
"throttled",
"executed",
"failed",
"deleted_while_queued",
"not_executed_already_queued"
]
},
"watcher._types.TriggerEventResult": {
"type": "object",
"properties": {
"manual": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.TriggerEventContainer"
}
]
},
"triggered_time": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"type": {
"type": "string"
}
},
"required": [
"manual",
"triggered_time",
"type"
]
},
"watcher._types.TriggerEventContainer": {
"type": "object",
"properties": {
"schedule": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ScheduleTriggerEvent"
}
]
}
},
"minProperties": 1,
"maxProperties": 1
},
"watcher._types.QueryWatch": {
"type": "object",
"properties": {
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.WatchStatus"
}
]
},
"watch": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.Watch"
}
]
},
"_primary_term": {
"type": "number"
},
"_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
}
},
"required": [
"_id"
]
},
"watcher.stats.WatcherMetric": {
"type": "string",
"enum": [
"_all",
"all",
"queued_watches",
"current_watches",
"pending_watches"
]
},
"watcher.stats.WatcherNodeStats": {
"type": "object",
"properties": {
"current_watches": {
"description": "The current executing watches metric gives insight into the watches that are currently being executed by Watcher.\nAdditional information is shared per watch that is currently executing.\nThis information includes the `watch_id`, the time its execution started and its current execution phase.\nTo include this metric, the `metric` option should be set to `current_watches` or `_all`.\nIn addition you can also specify the `emit_stacktraces=true` parameter, which adds stack traces for each watch that is being run.\nThese stack traces can give you more insight into an execution of a watch.",
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher.stats.WatchRecordStats"
}
},
"execution_thread_pool": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ExecutionThreadPool"
}
]
},
"queued_watches": {
"description": "Watcher moderates the execution of watches such that their execution won't put too much pressure on the node and its resources.\nIf too many watches trigger concurrently and there isn't enough capacity to run them all, some of the watches are queued, waiting for the current running watches to finish.s\nThe queued watches metric gives insight on these queued watches.\n\nTo include this metric, the `metric` option should include `queued_watches` or `_all`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher.stats.WatchRecordQueuedStats"
}
},
"watch_count": {
"description": "The number of watches currently registered.",
"type": "number"
},
"watcher_state": {
"description": "The current state of Watcher.",
"allOf": [
{
"$ref": "#/components/schemas/watcher.stats.WatcherState"
}
]
},
"node_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
},
"required": [
"execution_thread_pool",
"watch_count",
"watcher_state",
"node_id"
]
},
"watcher.stats.WatchRecordStats": {
"allOf": [
{
"$ref": "#/components/schemas/watcher.stats.WatchRecordQueuedStats"
},
{
"type": "object",
"properties": {
"execution_phase": {
"description": "The current watch execution phase.",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ExecutionPhase"
}
]
},
"triggered_time": {
"description": "The time the watch was triggered by the trigger engine.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"executed_actions": {
"type": "array",
"items": {
"type": "string"
}
},
"watch_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"watch_record_id": {
"description": "The watch record identifier.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
},
"required": [
"execution_phase",
"triggered_time",
"watch_id",
"watch_record_id"
]
}
]
},
"watcher._types.ExecutionPhase": {
"type": "string",
"enum": [
"awaits_execution",
"started",
"input",
"condition",
"actions",
"watch_transform",
"aborted",
"finished"
]
},
"watcher.stats.WatchRecordQueuedStats": {
"type": "object",
"properties": {
"execution_time": {
"description": "The time the watch was run.\nThis is just before the input is being run.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
},
"required": [
"execution_time"
]
},
"watcher._types.ExecutionThreadPool": {
"type": "object",
"properties": {
"max_size": {
"description": "The largest size of the execution thread pool, which indicates the largest number of concurrent running watches.",
"type": "number"
},
"queue_size": {
"description": "The number of watches that were triggered and are currently queued.",
"type": "number"
}
},
"required": [
"max_size",
"queue_size"
]
},
"watcher.stats.WatcherState": {
"type": "string",
"enum": [
"stopped",
"starting",
"started",
"stopping"
]
},
"xpack.info.XPackCategory": {
"type": "string",
"enum": [
"build",
"features",
"license"
]
},
"xpack.info.BuildInformation": {
"type": "object",
"properties": {
"date": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"hash": {
"type": "string"
}
},
"required": [
"date",
"hash"
]
},
"xpack.info.Features": {
"type": "object",
"properties": {
"aggregate_metric": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"analytics": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"ccr": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"data_streams": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"data_tiers": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"enrich": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"enterprise_search": {
"x-state": "Generally available; Added in 8.8.0",
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"eql": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"esql": {
"x-state": "Generally available; Added in 8.14.0",
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"graph": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"gpu_vector_indexing": {
"x-state": "Generally available; Added in 9.3.2",
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"ilm": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"logstash": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"logsdb": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"ml": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"monitoring": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"rollup": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"runtime_fields": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"searchable_snapshots": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"security": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"slm": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"spatial": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"sql": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"transform": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"universal_profiling": {
"x-state": "Generally available; Added in 8.7.0",
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"voting_only": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"watcher": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
},
"archive": {
"x-state": "Generally available; Added in 8.2.0",
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.Feature"
}
]
}
},
"required": [
"aggregate_metric",
"analytics",
"ccr",
"data_streams",
"data_tiers",
"enrich",
"enterprise_search",
"eql",
"esql",
"graph",
"gpu_vector_indexing",
"ilm",
"logstash",
"logsdb",
"ml",
"monitoring",
"rollup",
"searchable_snapshots",
"security",
"slm",
"spatial",
"sql",
"transform",
"universal_profiling",
"voting_only",
"watcher",
"archive"
]
},
"xpack.info.Feature": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"native_code_info": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.info.NativeCodeInformation"
}
]
}
},
"required": [
"available",
"enabled"
]
},
"xpack.info.NativeCodeInformation": {
"type": "object",
"properties": {
"build_hash": {
"type": "string"
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionString"
}
]
}
},
"required": [
"build_hash",
"version"
]
},
"xpack.info.MinimalLicenseInformation": {
"type": "object",
"properties": {
"expiry_date_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
}
]
},
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/license._types.LicenseType"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/license._types.LicenseStatus"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/license._types.LicenseType"
}
]
},
"uid": {
"type": "string"
}
},
"required": [
"expiry_date_in_millis",
"mode",
"status",
"type",
"uid"
]
},
"xpack.usage.Base": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"available",
"enabled"
]
},
"xpack.usage.Analytics": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"stats": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.AnalyticsStatistics"
}
]
}
},
"required": [
"stats"
]
}
]
},
"xpack.usage.AnalyticsStatistics": {
"type": "object",
"properties": {
"boxplot_usage": {
"type": "number"
},
"cumulative_cardinality_usage": {
"type": "number"
},
"string_stats_usage": {
"type": "number"
},
"top_metrics_usage": {
"type": "number"
},
"t_test_usage": {
"type": "number"
},
"moving_percentiles_usage": {
"type": "number"
},
"normalize_usage": {
"type": "number"
},
"rate_usage": {
"type": "number"
},
"multi_terms_usage": {
"type": "number"
}
},
"required": [
"boxplot_usage",
"cumulative_cardinality_usage",
"string_stats_usage",
"top_metrics_usage",
"t_test_usage",
"moving_percentiles_usage",
"normalize_usage",
"rate_usage"
]
},
"xpack.usage.Archive": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"indices_count": {
"type": "number"
}
},
"required": [
"indices_count"
]
}
]
},
"xpack.usage.Watcher": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"execution": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.WatcherActions"
}
]
},
"watch": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.WatcherWatch"
}
]
},
"count": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Counter"
}
]
}
},
"required": [
"execution",
"watch",
"count"
]
}
]
},
"xpack.usage.WatcherActions": {
"type": "object",
"properties": {
"actions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.WatcherActionTotals"
}
}
},
"required": [
"actions"
]
},
"xpack.usage.WatcherActionTotals": {
"type": "object",
"properties": {
"total": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"total_time_in_ms": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"total",
"total_time_in_ms"
]
},
"xpack.usage.WatcherWatch": {
"type": "object",
"properties": {
"input": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.Counter"
}
},
"condition": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.Counter"
}
},
"action": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.Counter"
}
},
"trigger": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.WatcherWatchTrigger"
}
]
}
},
"required": [
"input",
"trigger"
]
},
"xpack.usage.Counter": {
"type": "object",
"properties": {
"active": {
"type": "number"
},
"total": {
"type": "number"
}
},
"required": [
"active",
"total"
]
},
"xpack.usage.WatcherWatchTrigger": {
"type": "object",
"properties": {
"schedule": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.WatcherWatchTriggerSchedule"
}
]
},
"_all": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Counter"
}
]
}
},
"required": [
"_all"
]
},
"xpack.usage.WatcherWatchTriggerSchedule": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Counter"
},
{
"type": "object",
"properties": {
"cron": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Counter"
}
]
},
"_all": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Counter"
}
]
}
},
"required": [
"cron",
"_all"
]
}
]
},
"xpack.usage.Ccr": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"auto_follow_patterns_count": {
"type": "number"
},
"follower_indices_count": {
"type": "number"
}
},
"required": [
"auto_follow_patterns_count",
"follower_indices_count"
]
}
]
},
"xpack.usage.DataStreams": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"data_streams": {
"type": "number"
},
"indices_count": {
"type": "number"
}
},
"required": [
"data_streams",
"indices_count"
]
}
]
},
"xpack.usage.DataTiers": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"data_warm": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics"
}
]
},
"data_frozen": {
"x-state": "Generally available; Added in 7.13.0",
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics"
}
]
},
"data_cold": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics"
}
]
},
"data_content": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics"
}
]
},
"data_hot": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics"
}
]
}
},
"required": [
"data_warm",
"data_cold",
"data_content",
"data_hot"
]
}
]
},
"xpack.usage.DataTierPhaseStatistics": {
"type": "object",
"properties": {
"node_count": {
"type": "number"
},
"index_count": {
"type": "number"
},
"total_shard_count": {
"type": "number"
},
"primary_shard_count": {
"type": "number"
},
"doc_count": {
"type": "number"
},
"total_size_bytes": {
"type": "number"
},
"primary_size_bytes": {
"type": "number"
},
"primary_shard_size_avg_bytes": {
"type": "number"
},
"primary_shard_size_median_bytes": {
"type": "number"
},
"primary_shard_size_mad_bytes": {
"type": "number"
}
},
"required": [
"node_count",
"index_count",
"total_shard_count",
"primary_shard_count",
"doc_count",
"total_size_bytes",
"primary_size_bytes",
"primary_shard_size_avg_bytes",
"primary_shard_size_median_bytes",
"primary_shard_size_mad_bytes"
]
},
"xpack.usage.Eql": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"features": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.EqlFeatures"
}
]
},
"queries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.Query"
}
}
},
"required": [
"features",
"queries"
]
}
]
},
"xpack.usage.EqlFeatures": {
"type": "object",
"properties": {
"join": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"joins": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.EqlFeaturesJoin"
}
]
},
"keys": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.EqlFeaturesKeys"
}
]
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"pipes": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.EqlFeaturesPipes"
}
]
},
"sequence": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"sequences": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.EqlFeaturesSequences"
}
]
}
},
"required": [
"join",
"joins",
"keys",
"event",
"pipes",
"sequence",
"sequences"
]
},
"xpack.usage.EqlFeaturesJoin": {
"type": "object",
"properties": {
"join_queries_two": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"join_queries_three": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"join_until": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"join_queries_five_or_more": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"join_queries_four": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
}
},
"required": [
"join_queries_two",
"join_queries_three",
"join_until",
"join_queries_five_or_more",
"join_queries_four"
]
},
"xpack.usage.EqlFeaturesKeys": {
"type": "object",
"properties": {
"join_keys_two": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"join_keys_one": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"join_keys_three": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"join_keys_five_or_more": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"join_keys_four": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
}
},
"required": [
"join_keys_two",
"join_keys_one",
"join_keys_three",
"join_keys_five_or_more",
"join_keys_four"
]
},
"xpack.usage.EqlFeaturesPipes": {
"type": "object",
"properties": {
"pipe_tail": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"pipe_head": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
}
},
"required": [
"pipe_tail",
"pipe_head"
]
},
"xpack.usage.EqlFeaturesSequences": {
"type": "object",
"properties": {
"sequence_queries_three": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"sequence_queries_four": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"sequence_queries_two": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"sequence_until": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"sequence_queries_five_or_more": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"sequence_maxspan": {
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
}
},
"required": [
"sequence_queries_three",
"sequence_queries_four",
"sequence_queries_two",
"sequence_until",
"sequence_queries_five_or_more",
"sequence_maxspan"
]
},
"xpack.usage.Query": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"failed": {
"type": "number"
},
"paging": {
"type": "number"
},
"total": {
"type": "number"
}
}
},
"xpack.usage.Flattened": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"field_count": {
"type": "number"
}
},
"required": [
"field_count"
]
}
]
},
"xpack.usage.GpuVectorIndexing": {
"description": "GPU vector indexing usage statistics.",
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"index_build_count": {
"description": "Total GPU index builds across the cluster.",
"type": "number"
},
"nodes_with_gpu": {
"description": "Count of data nodes with GPU support.",
"type": "number"
},
"nodes": {
"description": "Per-node GPU details including type, memory, enabled status, and build count.",
"type": "array",
"items": {
"$ref": "#/components/schemas/xpack.usage.GpuNodeStats"
}
}
},
"required": [
"index_build_count",
"nodes_with_gpu",
"nodes"
]
}
]
},
"xpack.usage.GpuNodeStats": {
"description": "Per-node GPU statistics for vector indexing.",
"type": "object",
"properties": {
"type": {
"description": "GPU device type (e.g., \"NVIDIA L4\", \"NVIDIA A100\").",
"type": "string"
},
"memory_in_bytes": {
"description": "GPU memory in bytes.",
"type": "number"
},
"enabled": {
"description": "Whether GPU vector indexing is enabled on this node.",
"type": "boolean"
},
"index_build_count": {
"description": "Number of GPU index builds performed on this node.",
"type": "number"
}
},
"required": [
"type",
"memory_in_bytes",
"enabled",
"index_build_count"
]
},
"xpack.usage.HealthStatistics": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"invocations": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Invocations"
}
]
}
},
"required": [
"invocations"
]
}
]
},
"xpack.usage.Invocations": {
"type": "object",
"properties": {
"total": {
"type": "number"
}
},
"required": [
"total"
]
},
"xpack.usage.Ilm": {
"type": "object",
"properties": {
"policy_count": {
"type": "number"
},
"policy_stats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/xpack.usage.IlmPolicyStatistics"
}
}
},
"required": [
"policy_count",
"policy_stats"
]
},
"xpack.usage.IlmPolicyStatistics": {
"type": "object",
"properties": {
"indices_managed": {
"type": "number"
},
"phases": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Phases"
}
]
}
},
"required": [
"indices_managed",
"phases"
]
},
"xpack.usage.Phases": {
"type": "object",
"properties": {
"cold": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Phase"
}
]
},
"delete": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Phase"
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Phase"
}
]
},
"hot": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Phase"
}
]
},
"warm": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Phase"
}
]
}
}
},
"xpack.usage.Phase": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
}
},
"min_age": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
}
},
"required": [
"actions",
"min_age"
]
},
"xpack.usage.MachineLearning": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"datafeeds": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.Datafeed"
}
},
"jobs": {
"description": "Job usage statistics. The `_all` entry is always present and gathers statistics for all jobs.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.JobUsage"
}
},
"node_count": {
"type": "number"
},
"data_frame_analytics_jobs": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobs"
}
]
},
"inference": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlInference"
}
]
}
},
"required": [
"datafeeds",
"jobs",
"node_count",
"data_frame_analytics_jobs",
"inference"
]
}
]
},
"xpack.usage.Datafeed": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"required": [
"count"
]
},
"xpack.usage.JobUsage": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"created_by": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"detectors": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
},
"forecasts": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlJobForecasts"
}
]
},
"model_size": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
}
},
"required": [
"count",
"created_by",
"detectors",
"forecasts",
"model_size"
]
},
"xpack.usage.MlJobForecasts": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"forecasted_jobs": {
"type": "number"
}
},
"required": [
"total",
"forecasted_jobs"
]
},
"xpack.usage.MlDataFrameAnalyticsJobs": {
"type": "object",
"properties": {
"memory_usage": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsMemory"
}
]
},
"_all": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsCount"
}
]
},
"analysis_counts": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsAnalysis"
}
]
},
"stopped": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsCount"
}
]
}
},
"required": [
"_all"
]
},
"xpack.usage.MlDataFrameAnalyticsJobsMemory": {
"type": "object",
"properties": {
"peak_usage_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
}
},
"required": [
"peak_usage_bytes"
]
},
"xpack.usage.MlDataFrameAnalyticsJobsCount": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"required": [
"count"
]
},
"xpack.usage.MlDataFrameAnalyticsJobsAnalysis": {
"type": "object",
"properties": {
"classification": {
"type": "number"
},
"outlier_detection": {
"type": "number"
},
"regression": {
"type": "number"
}
}
},
"xpack.usage.MlInference": {
"type": "object",
"properties": {
"ingest_processors": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessor"
}
},
"trained_models": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlInferenceTrainedModels"
}
]
},
"deployments": {
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlInferenceDeployments"
}
]
}
},
"required": [
"ingest_processors",
"trained_models"
]
},
"xpack.usage.MlInferenceIngestProcessor": {
"type": "object",
"properties": {
"num_docs_processed": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount"
}
]
},
"pipelines": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlCounter"
}
]
},
"num_failures": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount"
}
]
},
"time_ms": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount"
}
]
}
},
"required": [
"num_docs_processed",
"pipelines",
"num_failures",
"time_ms"
]
},
"xpack.usage.MlInferenceIngestProcessorCount": {
"type": "object",
"properties": {
"max": {
"type": "number"
},
"sum": {
"type": "number"
},
"min": {
"type": "number"
}
},
"required": [
"max",
"sum",
"min"
]
},
"xpack.usage.MlCounter": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"required": [
"count"
]
},
"xpack.usage.MlInferenceTrainedModels": {
"type": "object",
"properties": {
"estimated_operations": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
},
"estimated_heap_memory_usage_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
},
"count": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlInferenceTrainedModelsCount"
}
]
},
"_all": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlCounter"
}
]
},
"model_size_bytes": {
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
}
},
"required": [
"_all"
]
},
"xpack.usage.MlInferenceTrainedModelsCount": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"prepackaged": {
"type": "number"
},
"other": {
"type": "number"
},
"pass_through": {
"type": "number"
},
"regression": {
"type": "number"
},
"classification": {
"type": "number"
},
"ner": {
"type": "number"
},
"text_embedding": {
"type": "number"
}
},
"required": [
"total",
"prepackaged",
"other"
]
},
"xpack.usage.MlInferenceDeployments": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"inference_counts": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
},
"model_sizes_bytes": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobStatistics"
}
]
},
"time_ms": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.MlInferenceDeploymentsTimeMs"
}
]
}
},
"required": [
"count",
"inference_counts",
"model_sizes_bytes",
"time_ms"
]
},
"xpack.usage.MlInferenceDeploymentsTimeMs": {
"type": "object",
"properties": {
"avg": {
"type": "number"
}
},
"required": [
"avg"
]
},
"xpack.usage.Monitoring": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"collection_enabled": {
"type": "boolean"
},
"enabled_exporters": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"collection_enabled",
"enabled_exporters"
]
}
]
},
"xpack.usage.RuntimeFieldTypes": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"field_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/xpack.usage.RuntimeFieldsType"
}
}
},
"required": [
"field_types"
]
}
]
},
"xpack.usage.RuntimeFieldsType": {
"type": "object",
"properties": {
"chars_max": {
"type": "number"
},
"chars_total": {
"type": "number"
},
"count": {
"type": "number"
},
"doc_max": {
"type": "number"
},
"doc_total": {
"type": "number"
},
"index_count": {
"type": "number"
},
"lang": {
"type": "array",
"items": {
"type": "string"
}
},
"lines_max": {
"type": "number"
},
"lines_total": {
"type": "number"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"scriptless_count": {
"type": "number"
},
"shadowed_count": {
"type": "number"
},
"source_max": {
"type": "number"
},
"source_total": {
"type": "number"
}
},
"required": [
"chars_max",
"chars_total",
"count",
"doc_max",
"doc_total",
"index_count",
"lang",
"lines_max",
"lines_total",
"name",
"scriptless_count",
"shadowed_count",
"source_max",
"source_total"
]
},
"xpack.usage.SearchableSnapshots": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"indices_count": {
"type": "number"
},
"full_copy_indices_count": {
"type": "number"
},
"shared_cache_indices_count": {
"type": "number"
}
},
"required": [
"indices_count"
]
}
]
},
"xpack.usage.Security": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"api_key_service": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.FeatureToggle"
}
]
},
"anonymous": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.FeatureToggle"
}
]
},
"audit": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Audit"
}
]
},
"fips_140": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.FeatureToggle"
}
]
},
"ipfilter": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.IpFilter"
}
]
},
"realms": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.Realm"
}
},
"role_mapping": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.RoleMapping"
}
},
"roles": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.SecurityRoles"
}
]
},
"ssl": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Ssl"
}
]
},
"system_key": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.FeatureToggle"
}
]
},
"token_service": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.FeatureToggle"
}
]
},
"operator_privileges": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
}
]
}
},
"required": [
"api_key_service",
"anonymous",
"audit",
"fips_140",
"ipfilter",
"realms",
"role_mapping",
"roles",
"ssl",
"token_service",
"operator_privileges"
]
}
]
},
"xpack.usage.FeatureToggle": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"xpack.usage.Audit": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.FeatureToggle"
},
{
"type": "object",
"properties": {
"outputs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"xpack.usage.IpFilter": {
"type": "object",
"properties": {
"http": {
"type": "boolean"
},
"transport": {
"type": "boolean"
}
},
"required": [
"http",
"transport"
]
},
"xpack.usage.Realm": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"name": {
"type": "array",
"items": {
"type": "string"
}
},
"order": {
"type": "array",
"items": {
"type": "number"
}
},
"size": {
"type": "array",
"items": {
"type": "number"
}
},
"cache": {
"type": "array",
"items": {
"$ref": "#/components/schemas/xpack.usage.RealmCache"
}
},
"has_authorization_realms": {
"type": "array",
"items": {
"type": "boolean"
}
},
"has_default_username_pattern": {
"type": "array",
"items": {
"type": "boolean"
}
},
"has_truststore": {
"type": "array",
"items": {
"type": "boolean"
}
},
"is_authentication_delegated": {
"type": "array",
"items": {
"type": "boolean"
}
}
}
}
]
},
"xpack.usage.RealmCache": {
"type": "object",
"properties": {
"size": {
"type": "number"
}
},
"required": [
"size"
]
},
"xpack.usage.RoleMapping": {
"type": "object",
"properties": {
"enabled": {
"type": "number"
},
"size": {
"type": "number"
}
},
"required": [
"enabled",
"size"
]
},
"xpack.usage.SecurityRoles": {
"type": "object",
"properties": {
"native": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.SecurityRolesNative"
}
]
},
"dls": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.SecurityRolesDls"
}
]
},
"file": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.SecurityRolesFile"
}
]
}
},
"required": [
"native",
"dls",
"file"
]
},
"xpack.usage.SecurityRolesNative": {
"type": "object",
"properties": {
"dls": {
"type": "boolean"
},
"fls": {
"type": "boolean"
},
"size": {
"type": "number"
}
},
"required": [
"dls",
"fls",
"size"
]
},
"xpack.usage.SecurityRolesFile": {
"type": "object",
"properties": {
"dls": {
"type": "boolean"
},
"fls": {
"type": "boolean"
},
"size": {
"type": "number"
}
},
"required": [
"dls",
"fls",
"size"
]
},
"xpack.usage.Ssl": {
"type": "object",
"properties": {
"http": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.FeatureToggle"
}
]
},
"transport": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.FeatureToggle"
}
]
}
},
"required": [
"http",
"transport"
]
},
"xpack.usage.Slm": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"policy_count": {
"type": "number"
},
"policy_stats": {
"allOf": [
{
"$ref": "#/components/schemas/slm._types.Statistics"
}
]
}
}
}
]
},
"xpack.usage.Sql": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"features": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"queries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/xpack.usage.Query"
}
}
},
"required": [
"features",
"queries"
]
}
]
},
"xpack.usage.Vector": {
"allOf": [
{
"$ref": "#/components/schemas/xpack.usage.Base"
},
{
"type": "object",
"properties": {
"dense_vector_dims_avg_count": {
"type": "number"
},
"dense_vector_fields_count": {
"type": "number"
},
"sparse_vector_fields_count": {
"type": "number"
}
},
"required": [
"dense_vector_dims_avg_count",
"dense_vector_fields_count"
]
}
]
}
},
"responses": {
"async_search.submit-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/async_search._types.AsyncSearchDocumentResponseBase"
},
"examples": {
"AsyncSearchSubmitResponseExample1": {
"description": "A successful response when performing search asynchronously.",
"value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : true,\n \"is_running\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"response\" : {\n \"took\" : 1122,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 0,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 3,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 157483,\n \"relation\" : \"gte\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n }\n }\n}"
}
}
}
}
},
"bulk-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"description": "If `true`, one or more of the operations in the bulk request did not complete successfully.",
"type": "boolean"
},
"items": {
"description": "The result of each operation in the bulk request, in the order they were submitted.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.bulk.ResponseItem"
},
"minProperties": 1,
"maxProperties": 1
}
},
"took": {
"description": "The length of time, in milliseconds, it took to process the bulk request.",
"type": "number"
},
"ingest_took": {
"type": "number"
}
},
"required": [
"errors",
"items",
"took"
]
},
"examples": {
"BulkResponseExample1": {
"summary": "Multiple successful operations",
"value": "{\n \"took\": 30,\n \"errors\": false,\n \"items\": [\n {\n \"index\": {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"status\": 201,\n \"_seq_no\" : 0,\n \"_primary_term\": 1\n }\n },\n {\n \"delete\": {\n \"_index\": \"test\",\n \"_id\": \"2\",\n \"_version\": 1,\n \"result\": \"not_found\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"status\": 404,\n \"_seq_no\" : 1,\n \"_primary_term\" : 2\n }\n },\n {\n \"create\": {\n \"_index\": \"test\",\n \"_id\": \"3\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"status\": 201,\n \"_seq_no\" : 2,\n \"_primary_term\" : 3\n }\n },\n {\n \"update\": {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"_version\": 2,\n \"result\": \"updated\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"status\": 200,\n \"_seq_no\" : 3,\n \"_primary_term\" : 4\n }\n }\n ]\n}"
},
"BulkResponseExample2": {
"summary": "Failed actions",
"description": "If you run `POST /_bulk` with operations that update non-existent documents, the operations cannot complete successfully. The API returns a response with an `errors` property value `true`. The response also includes an error object for any failed operations. The error object contains additional information about the failure, such as the error type and reason.\n",
"value": "{\n \"took\": 486,\n \"errors\": true,\n \"items\": [\n {\n \"update\": {\n \"_index\": \"index1\",\n \"_id\": \"5\",\n \"status\": 404,\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[5]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"update\": {\n \"_index\": \"index1\",\n \"_id\": \"6\",\n \"status\": 404,\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[6]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"create\": {\n \"_index\": \"index1\",\n \"_id\": \"7\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"status\": 201\n }\n }\n ]\n}"
},
"BulkResponseExample3": {
"summary": "Filter for failed operations",
"description": "An example response from `POST /_bulk?filter_path=items.*.error`, which returns only information about failed operations.\n",
"value": "{\n \"items\": [\n {\n \"update\": {\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[5]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"update\": {\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[6]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n }\n ]\n}"
}
}
}
}
},
"cat.aliases-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.\n",
"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]"
}
}
}
}
},
"cat.allocation-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.\n",
"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]"
}
}
}
}
},
"cat.circuit_breaker-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.\n",
"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]"
}
}
}
}
},
"cat.component_templates-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`.\n",
"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]"
}
}
}
}
},
"cat.count-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.\n",
"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.\n",
"value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]"
}
}
}
}
},
"cat.fielddata-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.\n",
"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`.\n",
"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]"
}
}
}
}
},
"cat.indices-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`.\n",
"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]"
}
}
}
}
},
"cat.ml_data_frame_analytics-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]"
}
}
}
}
},
"cat.ml_datafeeds-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]"
}
}
}
}
},
"cat.ml_jobs-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]"
}
}
}
}
},
"cat.ml_trained_models-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]"
}
}
}
}
},
"cat.recovery-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.\n",
"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.\n",
"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.\n",
"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]"
}
}
}
}
},
"cat.segments-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`.\n",
"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]"
}
}
}
}
},
"cat.shards-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`.\n",
"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-`.\n",
"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.\n",
"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.\n",
"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.\n",
"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]"
}
}
}
}
},
"cat.snapshots-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`.\n",
"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]"
}
}
}
}
},
"cat.templates-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`.\n",
"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]"
}
}
}
}
},
"cat.thread_pool-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`.\n",
"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.\n",
"value": "[\n {\n \"id\": \"0EWUhXeBQtaVGlexUeVwMg\",\n \"name\": \"generic\",\n \"active\": \"0\",\n \"rejected\": \"0\",\n \"completed\": \"70\"\n }\n]"
}
}
}
}
},
"cat.transforms-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]"
}
}
}
}
},
"ccr.get_auto_follow_pattern-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"patterns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ccr.get_auto_follow_pattern.AutoFollowPattern"
}
}
},
"required": [
"patterns"
]
},
"examples": {
"GetAutoFollowPatternResponseExample1": {
"description": "A successful response from `GET /_ccr/auto_follow/my_auto_follow_pattern`, which gets auto-follow patterns.",
"value": "{\n \"patterns\": [\n {\n \"name\": \"my_auto_follow_pattern\",\n \"pattern\": {\n \"active\": true,\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"leader_index_001\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\"\n }\n }\n ]\n}"
}
}
}
}
},
"clear_scroll-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"succeeded": {
"description": "If `true`, the request succeeded.\nThis does not indicate whether any scrolling search requests were cleared.",
"type": "boolean"
},
"num_freed": {
"description": "The number of scrolling search requests cleared.",
"type": "number"
}
},
"required": [
"succeeded",
"num_freed"
]
}
}
}
},
"cluster.allocation_explain-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"allocate_explanation": {
"type": "string"
},
"allocation_delay": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"allocation_delay_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"can_allocate": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.Decision"
}
]
},
"can_move_to_other_node": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.Decision"
}
]
},
"can_rebalance_cluster": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.Decision"
}
]
},
"can_rebalance_cluster_decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.allocation_explain.AllocationDecision"
}
},
"can_rebalance_to_other_node": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.Decision"
}
]
},
"can_remain_decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.allocation_explain.AllocationDecision"
}
},
"can_remain_on_current_node": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.Decision"
}
]
},
"cluster_info": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.ClusterInfo"
}
]
},
"configured_delay": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"configured_delay_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"current_node": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.CurrentNode"
}
]
},
"current_state": {
"type": "string"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"move_explanation": {
"type": "string"
},
"node_allocation_decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster.allocation_explain.NodeAllocationExplanation"
}
},
"primary": {
"type": "boolean"
},
"rebalance_explanation": {
"type": "string"
},
"remaining_delay": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"remaining_delay_in_millis": {
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"shard": {
"type": "number"
},
"unassigned_info": {
"allOf": [
{
"$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformation"
}
]
},
"note": {
"x-state": "Generally available; Added in 7.14.0",
"type": "string"
}
},
"required": [
"current_state",
"index",
"primary",
"shard"
]
},
"examples": {
"ClusterAllocationExplainResponseExample1": {
"summary": "Conflicting settings",
"description": "An example of an allocation explanation for an unassigned primary shard. In this example, a newly created index has an index setting that requires that it only be allocated to a node named `nonexistent_node`, which does not exist, so the index is unable to allocate.\n",
"value": "{\n \"index\" : \"my-index-000001\",\n \"shard\" : 0,\n \"primary\" : true,\n \"current_state\" : \"unassigned\",\n \"unassigned_info\" : {\n \"reason\" : \"INDEX_CREATED\",\n \"at\" : \"2017-01-04T18:08:16.600Z\",\n \"last_allocation_status\" : \"no\"\n },\n \"can_allocate\" : \"no\",\n \"allocate_explanation\" : \"Elasticsearch isn't allowed to allocate this shard to any of the nodes in the cluster. Choose a node to which you expect this shard to be allocated, find this node in the node-by-node explanation, and address the reasons which prevent Elasticsearch from allocating this shard there.\",\n \"node_allocation_decisions\" : [\n {\n \"node_id\" : \"8qt2rY-pT6KNZB3-hGfLnw\",\n \"node_name\" : \"node-0\",\n \"transport_address\" : \"127.0.0.1:9401\",\n \"roles\" : [\"data\", \"data_cold\", \"data_content\", \"data_frozen\", \"data_hot\", \"data_warm\", \"ingest\", \"master\", \"ml\", \"remote_cluster_client\", \"transform\"],\n \"node_attributes\" : {},\n \"node_decision\" : \"no\",\n \"weight_ranking\" : 1,\n \"deciders\" : [\n {\n \"decider\" : \"filter\",\n \"decision\" : \"NO\",\n \"explanation\" : \"node does not match index setting [index.routing.allocation.include] filters [_name:\\\"nonexistent_node\\\"]\"\n }\n ]\n }\n ]\n}"
},
"ClusterAllocationExplainResponseExample2": {
"summary": "Maximum retries",
"description": "An example of an allocation explanation for an unassigned primary shard that has reached the maximum number of allocation retry attempts. After the maximum number of retries is reached, Elasticsearch stops attempting to allocate the shard in order to prevent infinite retries which may impact cluster performance.\n",
"value": "{\n \"index\" : \"my-index-000001\",\n \"shard\" : 0,\n \"primary\" : true,\n \"current_state\" : \"unassigned\",\n \"unassigned_info\" : {\n \"at\" : \"2017-01-04T18:03:28.464Z\",\n \"failed shard on node [mEKjwwzLT1yJVb8UxT6anw]: failed recovery, failure RecoveryFailedException\",\n \"reason\": \"ALLOCATION_FAILED\",\n \"failed_allocation_attempts\": 5,\n \"last_allocation_status\": \"no\",\n },\n \"can_allocate\": \"no\",\n \"allocate_explanation\": \"cannot allocate because allocation is not permitted to any of the nodes\",\n \"node_allocation_decisions\" : [\n {\n \"node_id\" : \"3sULLVJrRneSg0EfBB-2Ew\",\n \"node_name\" : \"node_t0\",\n \"transport_address\" : \"127.0.0.1:9400\",\n \"roles\" : [\"data_content\", \"data_hot\"],\n \"node_decision\" : \"no\",\n \"store\" : {\n \"matching_size\" : \"4.2kb\",\n \"matching_size_in_bytes\" : 4325\n },\n \"deciders\" : [\n {\n \"decider\": \"max_retry\",\n \"decision\" : \"NO\",\n \"explanation\": \"shard has exceeded the maximum number of retries [5] on failed allocation attempts - manually call [POST /_cluster/reroute?retry_failed] to retry, [unassigned_info[[reason=ALLOCATION_FAILED], at[2024-07-30T21:04:12.166Z], failed_attempts[5], failed_nodes[[mEKjwwzLT1yJVb8UxT6anw]], delayed=false, details[failed shard on node [mEKjwwzLT1yJVb8UxT6anw]: failed recovery, failure RecoveryFailedException], allocation_status[deciders_no]]]\"\n }\n ]\n }\n ]\n}"
}
}
}
}
},
"cluster.get_component_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"component_templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cluster._types.ComponentTemplate"
}
}
},
"required": [
"component_templates"
]
},
"examples": {
"GetComponentTemplateResponseExample1": {
"description": "A successful response for retrieving information about a component template.",
"value": "{\n \"component_templates\" : [\n {\n \"name\" : \"my-component-template\",\n \"component_template\" : {\n \"version\" : 1,\n \"_meta\" : {\n \"description\" : \"my custom component template\"\n },\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_shards\" : \"1\"\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n }\n },\n \"created_date\" : \"2024-01-01T12:00:00.000Z\",\n \"created_date_millis\" : 1704110400000,\n \"modified_date\" : \"2025-01-01T12:00:00.000Z\",\n \"modified_date_millis\" : 1735732800000\n }\n }\n ]\n}"
}
}
}
}
},
"cluster.health-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cluster.health.HealthResponseBody"
},
"examples": {
"ClusterHealthResponseExample1": {
"description": "A successful response from `GET _cluster/health`. It is the health status of a quiet single node cluster with a single index with one shard and one replica.\n",
"value": "{\n \"cluster_name\" : \"testcluster\",\n \"status\" : \"yellow\",\n \"timed_out\" : false,\n \"number_of_nodes\" : 1,\n \"number_of_data_nodes\" : 1,\n \"active_primary_shards\" : 1,\n \"active_shards\" : 1,\n \"relocating_shards\" : 0,\n \"initializing_shards\" : 0,\n \"unassigned_shards\" : 1,\n \"delayed_unassigned_shards\": 0,\n \"number_of_pending_tasks\" : 0,\n \"number_of_in_flight_fetch\": 0,\n \"task_max_waiting_in_queue_millis\": 0,\n \"active_shards_percent_as_number\": 50.0\n}"
}
}
}
}
},
"cluster.put_component_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"cluster.state-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"cluster.stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cluster.stats.StatsResponseBase"
}
}
}
},
"connector.put-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Result"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
}
},
"required": [
"result",
"id"
]
},
"examples": {
"ConnectorPutResponseExample1": {
"value": "{\n \"result\": \"created\",\n \"id\": \"my-connector\"\n}"
}
}
}
}
},
"count-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
}
},
"required": [
"count",
"_shards"
]
},
"examples": {
"CountResponseExample1": {
"description": "A successful response from `GET /my-index-000001/_count?q=user:kimchy`.",
"value": "{\n \"count\": 1,\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"skipped\": 0,\n \"failed\": 0\n }\n}"
}
}
}
}
},
"create-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.WriteResponseBase"
},
"examples": {
"CreateResponseExample1": {
"description": "A successful response from `PUT my-index-000001/_create/1` which indexes a document.",
"value": "{\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"_seq_no\": 0,\n \"_primary_term\": 1\n}"
}
}
}
}
},
"enrich.get_policy-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"policies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/enrich._types.Summary"
}
}
},
"required": [
"policies"
]
}
}
}
},
"eql.search-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/eql._types.EqlSearchResponseBase"
},
"examples": {
"EqlSearchResponseExample2": {
"summary": "A successful response for performing search with an EQL query.",
"description": "",
"value": "{\n \"is_partial\": false,\n \"is_running\": false,\n \"took\": 6,\n \"timed_out\": false,\n \"hits\": {\n \"total\": {\n \"value\": 1,\n \"relation\": \"eq\"\n },\n \"sequences\": [\n {\n \"join_keys\": [\n 2012\n ],\n \"events\": [\n {\n \"_index\": \".ds-my-data-stream-2099.12.07-000001\",\n \"_id\": \"AtOJ4UjUBAAx3XR5kcCM\",\n \"_source\": {\n \"@timestamp\": \"2099-12-06T11:04:07.000Z\",\n \"event\": {\n \"category\": \"file\",\n \"id\": \"dGCHwoeS\",\n \"sequence\": 2\n },\n \"file\": {\n \"accessed\": \"2099-12-07T11:07:08.000Z\",\n \"name\": \"cmd.exe\",\n \"path\": \"C:\\\\Windows\\\\System32\\\\cmd.exe\",\n \"type\": \"file\",\n \"size\": 16384\n },\n \"process\": {\n \"pid\": 2012,\n \"name\": \"cmd.exe\",\n \"executable\": \"C:\\\\Windows\\\\System32\\\\cmd.exe\"\n }\n }\n },\n {\n \"_index\": \".ds-my-data-stream-2099.12.07-000001\",\n \"_id\": \"OQmfCaduce8zoHT93o4H\",\n \"_source\": {\n \"@timestamp\": \"2099-12-07T11:07:09.000Z\",\n \"event\": {\n \"category\": \"process\",\n \"id\": \"aR3NWVOs\",\n \"sequence\": 4\n },\n \"process\": {\n \"pid\": 2012,\n \"name\": \"regsvr32.exe\",\n \"command_line\": \"regsvr32.exe /s /u /i:https://...RegSvr32.sct scrobj.dll\",\n \"executable\": \"C:\\\\Windows\\\\System32\\\\regsvr32.exe\"\n }\n }\n }\n ]\n }\n ]\n }\n}"
}
}
}
}
},
"esql.get_view-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/components/schemas/esql._types.ESQLView"
}
}
},
"required": [
"views"
]
}
}
}
},
"explain-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"matched": {
"type": "boolean"
},
"explanation": {
"allOf": [
{
"$ref": "#/components/schemas/_global.explain.ExplanationDetail"
}
]
},
"get": {
"allOf": [
{
"$ref": "#/components/schemas/_types.InlineGet"
}
]
}
},
"required": [
"_index",
"_id",
"matched"
]
},
"examples": {
"ExplainResponseExample1": {
"description": "A successful response from `GET /my-index-000001/_explain/0`.",
"value": "{\n \"_index\":\"my-index-000001\",\n \"_id\":\"0\",\n \"matched\":true,\n \"explanation\":{\n \"value\":1.6943598,\n \"description\":\"weight(message:elasticsearch in 0) [PerFieldSimilarity], result of:\",\n \"details\":[\n {\n \"value\":1.6943598,\n \"description\":\"score(freq=1.0), computed as boost * idf * tf from:\",\n \"details\":[\n {\n \"value\":2.2,\n \"description\":\"boost\",\n \"details\":[]\n },\n {\n \"value\":1.3862944,\n \"description\":\"idf, computed as log(1 + (N - n + 0.5) / (n + 0.5)) from:\",\n \"details\":[\n {\n \"value\":1,\n \"description\":\"n, number of documents containing term\",\n \"details\":[]\n },\n {\n \"value\":5,\n \"description\":\"N, total number of documents with field\",\n \"details\":[]\n }\n ]\n },\n {\n \"value\":0.5555556,\n \"description\":\"tf, computed as freq / (freq + k1 * (1 - b + b * dl / avgdl)) from:\",\n \"details\":[\n {\n \"value\":1.0,\n \"description\":\"freq, occurrences of term within document\",\n \"details\":[]\n },\n {\n \"value\":1.2,\n \"description\":\"k1, term saturation parameter\",\n \"details\":[]\n },\n {\n \"value\":0.75,\n \"description\":\"b, length normalization parameter\",\n \"details\":[]\n },\n {\n \"value\":3.0,\n \"description\":\"dl, length of field\",\n \"details\":[]\n },\n {\n \"value\":5.4,\n \"description\":\"avgdl, average length of field\",\n \"details\":[]\n }\n ]\n }\n ]\n }\n ]\n }\n}"
}
}
}
}
},
"field_caps-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"indices": {
"description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.field_caps.FieldCapability"
}
}
}
},
"required": [
"indices",
"fields"
]
},
"examples": {
"FieldCapabilitiesResponseExample1": {
"summary": "Get two fields",
"description": "A successful response from `GET _field_caps?fields=rating,title`. The field `rating` is defined as a long in `index1` and `index2` and as a `keyword` in `index3` and `index4`. The field `rating` is not aggregatable in `index1`. The field `rating` is not searchable in `index4`. The field `title` is defined as text in all indices.\n",
"value": "{\n \"indices\": [ \"index1\", \"index2\", \"index3\", \"index4\", \"index5\" ],\n \"fields\": {\n \"rating\": { \n \"long\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false,\n \"indices\": [ \"index1\", \"index2\" ],\n \"non_aggregatable_indices\": [ \"index1\" ] \n },\n \"keyword\": {\n \"metadata_field\": false,\n \"searchable\": false,\n \"aggregatable\": true,\n \"indices\": [ \"index3\", \"index4\" ],\n \"non_searchable_indices\": [ \"index4\" ] \n }\n },\n \"title\": { \n \"text\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false\n }\n }\n }\n}"
},
"FieldCapabilitiesResponseExample2": {
"summary": "Get unmapped fields",
"description": "A successful response from `GET _field_caps?fields=rating,title&include_unmapped`. The response contains an entry for each field that is present in some indices but not all. For example, the `rating` and `title` fields are unmapped in `index5`.\n",
"value": "{\n \"indices\": [ \"index1\", \"index2\", \"index3\", \"index4\", \"index5\" ],\n \"fields\": {\n \"rating\": { \n \"long\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false,\n \"indices\": [ \"index1\", \"index2\" ],\n \"non_aggregatable_indices\": [ \"index1\" ] \n },\n \"keyword\": {\n \"metadata_field\": false,\n \"searchable\": false,\n \"aggregatable\": true,\n \"indices\": [ \"index3\", \"index4\" ],\n \"non_searchable_indices\": [ \"index4\" ] \n }\n },\n \"title\": { \n \"text\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false\n }\n }\n }\n}"
}
}
}
}
},
"fleet.msearch-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.msearch.ResponseItem"
}
}
},
"required": [
"docs"
]
}
}
}
},
"fleet.search-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"took": {
"type": "number"
},
"timed_out": {
"type": "boolean"
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"hits": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HitsMetadata"
}
]
},
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.Aggregate"
}
},
"_clusters": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ClusterStatistics"
}
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"max_score": {
"type": "number"
},
"num_reduce_phases": {
"type": "number"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Profile"
}
]
},
"pit_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_scroll_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScrollId"
}
]
},
"suggest": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Suggest"
}
}
},
"terminated_early": {
"type": "boolean"
}
},
"required": [
"took",
"timed_out",
"_shards",
"hits"
]
}
}
}
},
"graph.explore-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/graph._types.Connection"
}
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.ShardFailure"
}
},
"timed_out": {
"type": "boolean"
},
"took": {
"type": "number"
},
"vertices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/graph._types.Vertex"
}
}
},
"required": [
"connections",
"failures",
"timed_out",
"took",
"vertices"
]
}
}
}
},
"health_report-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cluster_name": {
"type": "string"
},
"indicators": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.Indicators"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/_global.health_report.IndicatorHealthStatus"
}
]
}
},
"required": [
"cluster_name",
"indicators"
]
}
}
}
},
"ilm.get_lifecycle-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ilm.get_lifecycle.Lifecycle"
}
},
"examples": {
"GetLifecycleResponseExample1": {
"description": "A successful response when retrieving a lifecycle policy.",
"value": "{\n \"my_policy\": {\n \"version\": 1,\n \"modified_date\": 82392349,\n \"policy\": {\n \"phases\": {\n \"warm\": {\n \"min_age\": \"10d\",\n \"actions\": {\n \"forcemerge\": {\n \"max_num_segments\": 1\n }\n }\n },\n \"delete\": {\n \"min_age\": \"30d\",\n \"actions\": {\n \"delete\": {\n \"delete_searchable_snapshot\": true\n }\n }\n }\n }\n },\n \"in_use_by\" : {\n \"indices\" : [],\n \"data_streams\" : [],\n \"composable_templates\" : []\n }\n }\n}"
}
}
}
}
},
"index-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.WriteResponseBase"
},
"examples": {
"IndexResponseExample1": {
"summary": "Automate document IDs",
"description": "A successful response from `POST my-index-000001/_doc/`, which contains an automated document ID.",
"value": "{\n \"_shards\": {\n \"total\": 2,\n \"failed\": 0,\n \"successful\": 2\n },\n \"_index\": \"my-index-000001\",\n \"_id\": \"W0tpsmIBdwcYyG50zbta\",\n \"_version\": 1,\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"result\": \"created\"\n}"
},
"IndexResponseExample2": {
"summary": "Define document IDs",
"description": "A successful response from `PUT my-index-000001/_doc/1`.",
"value": "{\n \"_shards\": {\n \"total\": 2,\n \"failed\": 0,\n \"successful\": 2\n },\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"result\": \"created\"\n}"
}
}
}
}
},
"indices.analyze-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detail": {
"allOf": [
{
"$ref": "#/components/schemas/indices.analyze.AnalyzeDetail"
}
]
},
"tokens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.analyze.AnalyzeToken"
}
}
}
},
"examples": {
"indicesAnalyzeResponseExample7": {
"description": "A successful response for an analysis with `explain` set to `true`.",
"value": "{\n \"detail\": {\n \"custom_analyzer\": true,\n \"charfilters\": [],\n \"tokenizer\": {\n \"name\": \"standard\",\n \"tokens\": [\n {\n \"token\": \"detailed\",\n \"start_offset\": 0,\n \"end_offset\": 8,\n \"type\": \"\",\n \"position\": 0\n },\n {\n \"token\": \"output\",\n \"start_offset\": 9,\n \"end_offset\": 15,\n \"type\": \"\",\n \"position\": 1\n }\n ]\n },\n \"tokenfilters\": [\n {\n \"name\": \"snowball\",\n \"tokens\": [\n {\n \"token\": \"detail\",\n \"start_offset\": 0,\n \"end_offset\": 8,\n \"type\": \"\",\n \"position\": 0,\n \"keyword\": false\n },\n {\n \"token\": \"output\",\n \"start_offset\": 9,\n \"end_offset\": 15,\n \"type\": \"\",\n \"position\": 1,\n \"keyword\": false\n }\n ]\n }\n ]\n }\n}"
}
}
}
}
},
"indices.clear_cache-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.ShardsOperationResponseBase"
}
}
}
},
"indices.clone-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledged": {
"type": "boolean"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shards_acknowledged": {
"type": "boolean"
}
},
"required": [
"acknowledged",
"index",
"shards_acknowledged"
]
}
}
}
},
"indices.create_from-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledged": {
"type": "boolean"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shards_acknowledged": {
"type": "boolean"
}
},
"required": [
"acknowledged",
"index",
"shards_acknowledged"
]
}
}
}
},
"indices.data_streams_stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_shards": {
"description": "Contains information about shards that attempted to execute the request.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"backing_indices": {
"description": "Total number of backing indices for the selected data streams.",
"type": "number"
},
"data_stream_count": {
"description": "Total number of selected data streams.",
"type": "number"
},
"data_streams": {
"description": "Contains statistics for the selected data streams.",
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.data_streams_stats.DataStreamsStatsItem"
}
},
"total_store_sizes": {
"description": "Total size of all shards for the selected data streams.\nThis property is included only if the `human` query parameter is `true`",
"allOf": [
{
"$ref": "#/components/schemas/_types.ByteSize"
}
]
},
"total_store_size_bytes": {
"description": "Total size, in bytes, of all shards for the selected data streams.",
"type": "number"
}
},
"required": [
"_shards",
"backing_indices",
"data_stream_count",
"data_streams",
"total_store_size_bytes"
]
},
"examples": {
"indicesDataStreamStatsResponseExample1": {
"description": "A successful response for retrieving statistics for a data stream.",
"value": "{\n \"_shards\": {\n \"total\": 10,\n \"successful\": 5,\n \"failed\": 0\n },\n \"data_stream_count\": 2,\n \"backing_indices\": 5,\n \"total_store_size\": \"7kb\",\n \"total_store_size_bytes\": 7268,\n \"data_streams\": [\n {\n \"data_stream\": \"my-data-stream\",\n \"backing_indices\": 3,\n \"store_size\": \"3.7kb\",\n \"store_size_bytes\": 3772,\n \"maximum_timestamp\": 1607512028000\n },\n {\n \"data_stream\": \"my-data-stream-two\",\n \"backing_indices\": 2,\n \"store_size\": \"3.4kb\",\n \"store_size_bytes\": 3496,\n \"maximum_timestamp\": 1607425567000\n }\n ]\n}"
}
}
}
}
},
"indices.delete_alias-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/indices.delete_alias.IndicesAliasesResponseBody"
}
}
}
},
"indices.exists_alias-200": {
"description": "",
"content": {
"application/json": {}
}
},
"indices.flush-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.ShardsOperationResponseBase"
}
}
}
},
"indices.forcemerge-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/indices.forcemerge._types.ForceMergeResponseBody"
}
}
}
},
"indices.get_alias-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.get_alias._types.IndexAliases"
}
}
}
}
},
"indices.get_data_stream-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data_streams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices._types.DataStream"
}
}
},
"required": [
"data_streams"
]
},
"examples": {
"indicesGetDataStreamResponseExample1": {
"description": "A successful response for retrieving information about a data stream.",
"value": "{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream\",\n \"timestamp_field\": {\n \"name\": \"@timestamp\"\n },\n \"indices\": [\n {\n \"index_name\": \".ds-my-data-stream-2099.03.07-000001\",\n \"index_uuid\": \"xCEhwsp8Tey0-FLNFYVwSg\",\n \"prefer_ilm\": true,\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"managed_by\": \"Index Lifecycle Management\"\n },\n {\n \"index_name\": \".ds-my-data-stream-2099.03.08-000002\",\n \"index_uuid\": \"PA_JquKGSiKcAKBA8DJ5gw\",\n \"prefer_ilm\": true,\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"managed_by\": \"Index Lifecycle Management\"\n }\n ],\n \"generation\": 2,\n \"_meta\": {\n \"my-meta-field\": \"foo\"\n },\n \"status\": \"GREEN\",\n \"next_generation_managed_by\": \"Index Lifecycle Management\",\n \"prefer_ilm\": true,\n \"template\": \"my-index-template\",\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"hidden\": false,\n \"system\": false,\n \"allow_custom_routing\": false,\n \"replicated\": false,\n \"rollover_on_write\": false\n },\n {\n \"name\": \"my-data-stream-two\",\n \"timestamp_field\": {\n \"name\": \"@timestamp\"\n },\n \"indices\": [\n {\n \"index_name\": \".ds-my-data-stream-two-2099.03.08-000001\",\n \"index_uuid\": \"3liBu2SYS5axasRt6fUIpA\",\n \"prefer_ilm\": true,\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"managed_by\": \"Index Lifecycle Management\"\n }\n ],\n \"generation\": 1,\n \"_meta\": {\n \"my-meta-field\": \"foo\"\n },\n \"status\": \"YELLOW\",\n \"next_generation_managed_by\": \"Index Lifecycle Management\",\n \"prefer_ilm\": true,\n \"template\": \"my-index-template\",\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"hidden\": false,\n \"system\": false,\n \"allow_custom_routing\": false,\n \"replicated\": false,\n \"rollover_on_write\": false\n }\n ]\n}"
}
}
}
}
},
"indices.get_field_mapping-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.get_field_mapping.TypeFieldMappings"
}
},
"examples": {
"indicesGetFieldMappingResponseExample1": {
"summary": "A single field mapping",
"description": "A sucessful response from `GET publications/_mapping/field/title`, which returns the mapping of a field called `title`.\n",
"value": "{\n \"publications\": {\n \"mappings\": {\n \"title\": {\n \"full_name\": \"title\",\n \"mapping\": {\n \"title\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}"
},
"indicesGetFieldMappingResponseExample2": {
"summary": "Multiple field mappings",
"description": "A successful response from `GET publications/_mapping/field/author.id,abstract,name`. The get field mapping API also supports wildcard notation.\n",
"value": "{\n \"publications\": {\n \"mappings\": {\n \"author.id\": {\n \"full_name\": \"author.id\",\n \"mapping\": {\n \"id\": {\n \"type\": \"text\"\n }\n }\n },\n \"abstract\": {\n \"full_name\": \"abstract\",\n \"mapping\": {\n \"abstract\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}"
},
"indicesGetFieldMappingResponseExample3": {
"summary": "Wildcards",
"description": "A successful response from `GET publications/_mapping/field/a*`.\n",
"value": "{\n \"publications\": {\n \"mappings\": {\n \"author.name\": {\n \"full_name\": \"author.name\",\n \"mapping\": {\n \"name\": {\n \"type\": \"text\"\n }\n }\n },\n \"abstract\": {\n \"full_name\": \"abstract\",\n \"mapping\": {\n \"abstract\": {\n \"type\": \"text\"\n }\n }\n },\n \"author.id\": {\n \"full_name\": \"author.id\",\n \"mapping\": {\n \"id\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}"
}
}
}
}
},
"indices.get_index_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index_templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.get_index_template.IndexTemplateItem"
}
}
},
"required": [
"index_templates"
]
},
"examples": {
"GetIndexTemplateResponseExample1": {
"description": "A successful response for retrieving information about an index template.",
"value": "{\n \"index_templates\" : [\n {\n \"name\" : \"my-index-template\",\n \"index_template\" : {\n \"index_patterns\" : [ \"logs-*\" ],\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_shards\" : \"1\",\n \"number_of_replicas\" : \"1\"\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n }\n },\n \"composed_of\" : [ \"my-component-template\" ],\n \"priority\" : 200,\n \"version\" : 1,\n \"_meta\" : {\n \"description\" : \"my custom index template\"\n },\n \"created_date\" : \"2024-01-01T12:00:00.000Z\",\n \"created_date_millis\" : 1704110400000,\n \"modified_date\" : \"2025-01-01T12:00:00.000Z\",\n \"modified_date_millis\" : 1735732800000\n }\n }\n ]\n}"
}
}
}
}
},
"indices.get_mapping-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.get_mapping.IndexMappingRecord"
}
}
}
}
},
"indices.get_settings-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.IndexState"
}
}
}
}
},
"indices.get_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.TemplateMapping"
}
}
}
}
},
"indices.put_alias-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"indices.put_index_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"indices.put_mapping-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.IndicesResponseBase"
}
}
}
},
"indices.put_settings-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"indices.put_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"indices.recovery-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.recovery.RecoveryStatus"
}
},
"examples": {
"indicesRecoveryResponseExample1": {
"summary": "Get segment information",
"description": "A successful response from `GET /_recovery?human`, which gets information about ongoing and completed shard recoveries for all data streams and indices in a cluster. This example includes information about a single index recovering a single shard. The source of the recovery is a snapshot repository and the target of the recovery is the `my_es_node` node. The response also includes the number and percentage of files and bytes recovered.\n",
"value": "{\n \"index1\" : {\n \"shards\" : [ {\n \"id\" : 0,\n \"type\" : \"SNAPSHOT\",\n \"stage\" : \"INDEX\",\n \"primary\" : true,\n \"start_time\" : \"2014-02-24T12:15:59.716\",\n \"start_time_in_millis\": 1393244159716,\n \"stop_time\" : \"0s\",\n \"stop_time_in_millis\" : 0,\n \"total_time\" : \"2.9m\",\n \"total_time_in_millis\" : 175576,\n \"source\" : {\n \"repository\" : \"my_repository\",\n \"snapshot\" : \"my_snapshot\",\n \"index\" : \"index1\",\n \"version\" : \"{version}\",\n \"restoreUUID\": \"PDh1ZAOaRbiGIVtCvZOMww\"\n },\n \"target\" : {\n \"id\" : \"ryqJ5lO5S4-lSFbGntkEkg\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"index\" : {\n \"size\" : {\n \"total\" : \"75.4mb\",\n \"total_in_bytes\" : 79063092,\n \"reused\" : \"0b\",\n \"reused_in_bytes\" : 0,\n \"recovered\" : \"65.7mb\",\n \"recovered_in_bytes\" : 68891939,\n \"recovered_from_snapshot\" : \"0b\",\n \"recovered_from_snapshot_in_bytes\" : 0,\n \"percent\" : \"87.1%\"\n },\n \"files\" : {\n \"total\" : 73,\n \"reused\" : 0,\n \"recovered\" : 69,\n \"percent\" : \"94.5%\"\n },\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0,\n \"source_throttle_time\" : \"0s\",\n \"source_throttle_time_in_millis\" : 0,\n \"target_throttle_time\" : \"0s\",\n \"target_throttle_time_in_millis\" : 0\n },\n \"translog\" : {\n \"recovered\" : 0,\n \"total\" : 0,\n \"percent\" : \"100.0%\",\n \"total_on_start\" : 0,\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0\n },\n \"verify_index\" : {\n \"check_index_time\" : \"0s\",\n \"check_index_time_in_millis\" : 0,\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0\n }\n } ]\n }\n}"
},
"indicesRecoveryResponseExample2": {
"summary": "Get detailed recovery information",
"description": "A successful response from `GET _recovery?human&detailed=true`. The response includes a listing of any physical files recovered and their sizes. The response also includes timings in milliseconds of the various stages of recovery: index retrieval, translog replay, and index start time. This response indicates the recovery is done.\n",
"value": "{\n \"index1\" : {\n \"shards\" : [ {\n \"id\" : 0,\n \"type\" : \"EXISTING_STORE\",\n \"stage\" : \"DONE\",\n \"primary\" : true,\n \"start_time\" : \"2014-02-24T12:38:06.349\",\n \"start_time_in_millis\" : \"1393245486349\",\n \"stop_time\" : \"2014-02-24T12:38:08.464\",\n \"stop_time_in_millis\" : \"1393245488464\",\n \"total_time\" : \"2.1s\",\n \"total_time_in_millis\" : 2115,\n \"source\" : {\n \"id\" : \"RGMdRc-yQWWKIBM4DGvwqQ\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"target\" : {\n \"id\" : \"RGMdRc-yQWWKIBM4DGvwqQ\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"index\" : {\n \"size\" : {\n \"total\" : \"24.7mb\",\n \"total_in_bytes\" : 26001617,\n \"reused\" : \"24.7mb\",\n \"reused_in_bytes\" : 26001617,\n \"recovered\" : \"0b\",\n \"recovered_in_bytes\" : 0,\n \"recovered_from_snapshot\" : \"0b\",\n \"recovered_from_snapshot_in_bytes\" : 0,\n \"percent\" : \"100.0%\"\n },\n \"files\" : {\n \"total\" : 26,\n \"reused\" : 26,\n \"recovered\" : 0,\n \"percent\" : \"100.0%\",\n \"details\" : [ {\n \"name\" : \"segments.gen\",\n \"length\" : 20,\n \"recovered\" : 20\n }, {\n \"name\" : \"_0.cfs\",\n \"length\" : 135306,\n \"recovered\" : 135306,\n \"recovered_from_snapshot\": 0\n }, {\n \"name\" : \"segments_2\",\n \"length\" : 251,\n \"recovered\" : 251,\n \"recovered_from_snapshot\": 0\n }\n ]\n },\n \"total_time\" : \"2ms\",\n \"total_time_in_millis\" : 2,\n \"source_throttle_time\" : \"0s\",\n \"source_throttle_time_in_millis\" : 0,\n \"target_throttle_time\" : \"0s\",\n \"target_throttle_time_in_millis\" : 0\n },\n \"translog\" : {\n \"recovered\" : 71,\n \"total\" : 0,\n \"percent\" : \"100.0%\",\n \"total_on_start\" : 0,\n \"total_time\" : \"2.0s\",\n \"total_time_in_millis\" : 2025\n },\n \"verify_index\" : {\n \"check_index_time\" : 0,\n \"check_index_time_in_millis\" : 0,\n \"total_time\" : \"88ms\",\n \"total_time_in_millis\" : 88\n }\n } ]\n }\n}"
}
}
}
}
},
"indices.refresh-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.ShardsOperationResponseBase"
}
}
}
},
"indices.reload_search_analyzers-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult"
},
"examples": {
"ReloadSearchAnalyzersResponseExample1": {
"description": "A successful response when reloading a search analyzer of an index.",
"value": "{\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n}"
}
}
}
}
},
"indices.resolve_cluster-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.resolve_cluster.ResolveClusterInfo"
}
},
"examples": {
"ResolveClusterResponseExample1": {
"summary": "Resolve with wildcards",
"description": "A successful response from `GET /_resolve/cluster/my-index*,clust*:my-index*`. Each cluster has its own response section. The cluster you sent the request to is labelled as \"(local)\".\n",
"value": "{\n \"(local)\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_one\": {\n \"connected\": true,\n \"skip_unavailable\": true,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_two\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n }\n}"
},
"ResolveClusterResponseExample2": {
"summary": "Identify search problems",
"description": "A successful response from `GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s`. This type of request can be used to identify potential problems with your cross-cluster search. Note also that a `timeout` of 5 seconds is sent, which sets the maximum time the query will wait for remote clusters to respond. The local cluster has no index called `not_present`. Searching with `ignore_unavailable=false` would return a \"no such index\" error. The `cluster_one` remote cluster has no indices that match the pattern `my-index*`. There may be no indices that match the pattern or the index could be closed. The `cluster_two` remote cluster is not connected (the attempt to connect failed). Since this cluster is marked as `skip_unavailable=false`, you should probably exclude this cluster from the search by adding `-cluster_two:*` to the search index expression. For `cluster_three`, the error message indicates that this remote cluster did not respond within the 5-second timeout window specified, so it is also marked as not connected. The `oldcluster` remote cluster shows that it has matching indices, but no version information is included. This indicates that the cluster version predates the introduction of the `_resolve/cluster` API, so you may want to exclude it from your cross-cluster search.\n",
"value": "{\n \"(local)\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"error\": \"no such index [not_present]\"\n },\n \"cluster_one\": {\n \"connected\": true,\n \"skip_unavailable\": true,\n \"matching_indices\": false,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_two\": {\n \"connected\": false,\n \"skip_unavailable\": false\n },\n \"cluster_three\": {\n \"connected\": false,\n \"skip_unavailable\": false,\n \"error\": \"Request timed out before receiving a response from the remote cluster\"\n },\n \"oldcluster\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true\n }\n}"
}
}
}
}
},
"indices.resolve_index-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"indices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.resolve_index.ResolveIndexItem"
}
},
"aliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.resolve_index.ResolveIndexAliasItem"
}
},
"data_streams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.resolve_index.ResolveIndexDataStreamsItem"
}
}
},
"required": [
"indices",
"aliases",
"data_streams"
]
},
"examples": {
"ResolveIndexResponseExample1": {
"description": "A successful response from `GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all`.",
"value": "{\n \"indices\": [\n {\n \"name\": \"foo_closed\",\n \"attributes\": [\n \"closed\"\n ],\n \"mode\": \"standard\"\n },\n {\n \"name\": \"freeze-index\",\n \"aliases\": [\n \"f-alias\"\n ],\n \"attributes\": [\n \"open\"\n ]\n },\n {\n \"name\": \"remoteCluster1:bar-01\",\n \"attributes\": [\n \"open\"\n ]\n }\n ],\n \"aliases\": [\n {\n \"name\": \"f-alias\",\n \"indices\": [\n \"freeze-index\",\n \"my-index-000001\"\n ]\n }\n ],\n \"data_streams\": [\n {\n \"name\": \"foo\",\n \"backing_indices\": [\n \".ds-foo-2099.03.07-000001\"\n ],\n \"timestamp_field\": \"@timestamp\"\n }\n ]\n}"
}
}
}
}
},
"indices.rollover-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledged": {
"type": "boolean"
},
"conditions": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"dry_run": {
"type": "boolean"
},
"new_index": {
"type": "string"
},
"old_index": {
"type": "string"
},
"rolled_over": {
"type": "boolean"
},
"shards_acknowledged": {
"type": "boolean"
}
},
"required": [
"acknowledged",
"conditions",
"dry_run",
"new_index",
"old_index",
"rolled_over",
"shards_acknowledged"
]
},
"examples": {
"indicesRolloverResponseExample1": {
"description": "An abbreviated response from `GET /_segments`.\n",
"value": "{\n \"_shards\": {},\n \"indices\": {\n \"test\": {\n \"shards\": {\n \"0\": [\n {\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": true,\n \"node\": \"zDC_RorJQCao9xf9pg3Fvw\"\n },\n \"num_committed_segments\": 0,\n \"num_search_segments\": 1,\n \"segments\": {\n \"_0\": {\n \"generation\": 0,\n \"num_docs\": 1,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 3800,\n \"committed\": false,\n \"search\": true,\n \"version\": \"7.0.0\",\n \"compound\": true,\n \"attributes\": {}\n }\n }\n }\n ]\n }\n }\n }\n}"
}
}
}
}
},
"indices.segments-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"indices": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.segments.IndexSegment"
}
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
}
},
"required": [
"indices",
"_shards"
]
},
"examples": {
"indicesSegmentsResponseExample1": {
"description": "A response describing information about index segments.",
"value": "{\n \"_shards\": {\n \"total\": 2,\n \"successful\": 2,\n \"failed\": 0\n },\n \"indices\": {\n \"kibana_sample_data_ecommerce\": {\n \"shards\": {\n \"0\": [\n {\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": false,\n \"node\": \"zZg9NuPhQPKO3LMRkMo2iw\"\n },\n \"num_committed_segments\": 4,\n \"num_search_segments\": 4,\n \"segments\": {\n \"_0\": {\n \"generation\": 0,\n \"num_docs\": 500,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 524718,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_1\": {\n \"generation\": 1,\n \"num_docs\": 500,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 526100,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_2\": {\n \"generation\": 2,\n \"num_docs\": 2000,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 1846181,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_3\": {\n \"generation\": 3,\n \"num_docs\": 1675,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 1572960,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n }\n }\n },\n {\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": true,\n \"node\": \"sp27SQiNTQWKpBKoRcnfQQ\"\n },\n \"num_committed_segments\": 5,\n \"num_search_segments\": 5,\n \"segments\": {\n \"_0\": {\n \"generation\": 0,\n \"num_docs\": 187,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 227245,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_1\": {\n \"generation\": 1,\n \"num_docs\": 253,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 297549,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_2\": {\n \"generation\": 2,\n \"num_docs\": 560,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 580918,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_3\": {\n \"generation\": 3,\n \"num_docs\": 1603,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 1506385,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_4\": {\n \"generation\": 4,\n \"num_docs\": 2072,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 1913051,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n }\n }\n }\n ]\n }\n }\n }\n}"
}
}
}
}
},
"indices.shard_stores-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"indices": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.shard_stores.IndicesShardStores"
}
}
},
"required": [
"indices"
]
},
"examples": {
"indicesShardStoresResponseExample1": {
"description": "An abbreviated response from `GET /_shard_stores?status=green`.\n",
"value": "{\n \"indices\": {\n \"my-index-000001\": {\n \"shards\": {\n \"0\": {\n \"stores\": [\n {\n \"sPa3OgxLSYGvQ4oPs-Tajw\": {\n \"name\": \"node_t0\",\n \"ephemeral_id\": \"9NlXRFGCT1m8tkvYCMK-8A\",\n \"transport_address\": \"local[1]\",\n \"external_id\": \"node_t0\",\n \"attributes\": {},\n \"roles\": [],\n \"version\": \"8.10.0\",\n \"min_index_version\": 7000099,\n \"max_index_version\": 8100099\n },\n \"allocation_id\": \"2iNySv_OQVePRX-yaRH_lQ\",\n \"allocation\": \"primary\",\n \"store_exception\": {}\n }\n ]\n }\n }\n }\n }\n}"
}
}
}
}
},
"indices.shrink-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledged": {
"type": "boolean"
},
"shards_acknowledged": {
"type": "boolean"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"acknowledged",
"shards_acknowledged",
"index"
]
}
}
}
},
"indices.simulate_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"overlapping": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.simulate_template.Overlapping"
}
},
"template": {
"allOf": [
{
"$ref": "#/components/schemas/indices.simulate_template.Template"
}
]
}
},
"required": [
"template"
]
},
"examples": {
"indicesSimulateTemplateResponseExample2": {
"description": "A successful response from `POST /_index_template/_simulate` with a template configuration in the request body. The response shows any overlapping templates with a lower priority.\n",
"value": "{\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_replicas\" : \"1\",\n \"routing\" : {\n \"allocation\" : {\n \"include\" : {\n \"_tier_preference\" : \"data_content\"\n }\n }\n }\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n }\n }\n },\n \"aliases\" : { }\n },\n \"overlapping\" : [\n {\n \"name\" : \"final-template\",\n \"index_patterns\" : [\n \"my-index-*\"\n ]\n }\n ]\n}"
}
}
}
}
},
"indices.split-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledged": {
"type": "boolean"
},
"shards_acknowledged": {
"type": "boolean"
},
"index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
}
},
"required": [
"acknowledged",
"shards_acknowledged",
"index"
]
}
}
}
},
"indices.stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"indices": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices.stats.IndicesStats"
}
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"_all": {
"allOf": [
{
"$ref": "#/components/schemas/indices.stats.IndicesStats"
}
]
}
},
"required": [
"_shards",
"_all"
]
}
}
}
},
"indices.validate_query-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"explanations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.validate_query.IndicesValidationExplanation"
}
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"valid": {
"type": "boolean"
},
"error": {
"type": "string"
}
},
"required": [
"valid"
]
}
}
}
},
"inference.delete-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inference._types.DeleteInferenceEndpointResult"
}
}
}
},
"inference.get-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"endpoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inference._types.InferenceEndpointInfo"
}
}
},
"required": [
"endpoints"
]
}
}
}
},
"inference.inference-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inference._types.InferenceResult"
}
}
}
},
"inference.put-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inference._types.InferenceEndpointInfo"
}
}
}
},
"inference.update-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inference._types.InferenceEndpointInfo"
}
}
}
},
"ingest.get_geoip_database-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"databases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest.get_geoip_database.DatabaseConfigurationMetadata"
}
}
},
"required": [
"databases"
]
}
}
}
},
"ingest.get_ip_location_database-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"databases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest.get_ip_location_database.DatabaseConfigurationMetadata"
}
}
},
"required": [
"databases"
]
}
}
}
},
"ingest.get_pipeline-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ingest._types.Pipeline"
}
},
"examples": {
"GetPipelineResponseExample1": {
"description": "A successful response for retrieving information about an ingest pipeline.",
"value": "{\n \"my-pipeline-id\" : {\n \"description\" : \"describe pipeline\",\n \"version\" : 123,\n \"processors\" : [\n {\n \"set\" : {\n \"field\" : \"foo\",\n \"value\" : \"bar\"\n }\n }\n ],\n \"created_date\" : \"2024-01-01T12:00:00.000Z\",\n \"created_date_millis\" : 1704110400000,\n \"modified_date\" : \"2025-01-01T12:00:00.000Z\",\n \"modified_date_millis\" : 1735732800000\n }\n}"
}
}
}
}
},
"ingest.simulate-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.SimulateDocumentResult"
}
}
},
"required": [
"docs"
]
},
"examples": {
"SimulatePipelineResponseExample1": {
"description": "A successful response for running an ingest pipeline against a set of provided documents.",
"value": "{\n \"docs\": [\n {\n \"doc\": {\n \"_id\": \"id\",\n \"_index\": \"index\",\n \"_version\": \"-3\",\n \"_source\": {\n \"field2\": \"_value\",\n \"foo\": \"bar\"\n },\n \"_ingest\": {\n \"timestamp\": \"2017-05-04T22:30:03.187Z\"\n }\n }\n },\n {\n \"doc\": {\n \"_id\": \"id\",\n \"_index\": \"index\",\n \"_version\": \"-3\",\n \"_source\": {\n \"field2\": \"_value\",\n \"foo\": \"rab\"\n },\n \"_ingest\": {\n \"timestamp\": \"2017-05-04T22:30:03.188Z\"\n }\n }\n }\n ]\n}"
}
}
}
}
},
"license.post-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"acknowledge": {
"allOf": [
{
"$ref": "#/components/schemas/license.post.Acknowledgement"
}
]
},
"acknowledged": {
"type": "boolean"
},
"license_status": {
"allOf": [
{
"$ref": "#/components/schemas/license._types.LicenseStatus"
}
]
}
},
"required": [
"acknowledged",
"license_status"
]
},
"examples": {
"PostLicenseResponseExample1": {
"description": "If you update to a basic license and you previously had a license with more features, you receive this type of response. You must re-submit the API request and set the `acknowledge` parameter to `true`.",
"value": "{\n \"acknowledged\": false,\n \"license_status\": \"valid\",\n \"acknowledge\": {\n \"message\": \"\\\"\\\"\\\"This license update requires acknowledgement. To acknowledge the license, please read the following messages and update the license again, this time with the \\\"acknowledge=true\\\" parameter:\\\"\\\"\\\"\",\n \"watcher\": [\n \"Watcher will be disabled\"\n ],\n \"logstash\": [\n \"Logstash will no longer poll for centrally-managed pipelines\"\n ],\n \"security\": [\n \"The following X-Pack security functionality will be disabled ...\"\n ]\n }\n}"
}
}
}
}
},
"logstash.get_pipeline-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/logstash._types.Pipeline"
}
},
"examples": {
"LogstashGetPipelineResponseExample1": {
"description": "A successful response from `GET _logstash/pipeline/my_pipeline`.\n",
"value": "{\n \"my_pipeline\": {\n \"description\": \"Sample pipeline for illustration purposes\",\n \"last_modified\": \"2021-01-02T02:50:51.250Z\",\n \"pipeline_metadata\": {\n \"type\": \"logstash_pipeline\",\n \"version\": \"1\"\n },\n \"username\": \"elastic\",\n \"pipeline\": \"input {}\\\\n filter { grok {} }\\\\n output {}\",\n \"pipeline_settings\": {\n \"pipeline.workers\": 1,\n \"pipeline.batch.size\": 125,\n \"pipeline.batch.delay\": 50,\n \"queue.type\": \"memory\",\n \"queue.max_bytes\": \"1gb\",\n \"queue.checkpoint.writes\": 1024\n }\n }\n}"
}
}
}
}
},
"mget-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"description": "The response includes a docs array that contains the documents in the order specified in the request.\nThe structure of the returned documents is similar to that returned by the get API.\nIf there is a failure getting a particular document, the error is included in place of the document.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.mget.ResponseItem"
}
}
},
"required": [
"docs"
]
}
}
}
},
"migration.deprecations-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cluster_settings": {
"description": "Cluster-level deprecation warnings.",
"type": "array",
"items": {
"$ref": "#/components/schemas/migration.deprecations.Deprecation"
}
},
"index_settings": {
"description": "Index warnings are sectioned off per index and can be filtered using an index-pattern in the query.\nThis section includes warnings for the backing indices of data streams specified in the request path.",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/migration.deprecations.Deprecation"
}
}
},
"data_streams": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/migration.deprecations.Deprecation"
}
}
},
"node_settings": {
"description": "Node-level deprecation warnings.\nSince only a subset of your nodes might incorporate these settings, it is important to read the details section for more information about which nodes are affected.",
"type": "array",
"items": {
"$ref": "#/components/schemas/migration.deprecations.Deprecation"
}
},
"ml_settings": {
"description": "Machine learning-related deprecation warnings.",
"type": "array",
"items": {
"$ref": "#/components/schemas/migration.deprecations.Deprecation"
}
},
"templates": {
"description": "Template warnings are sectioned off per template and include deprecations for both component templates and\nindex templates.",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/migration.deprecations.Deprecation"
}
}
},
"ilm_policies": {
"description": "ILM policy warnings are sectioned off per policy.",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/migration.deprecations.Deprecation"
}
}
}
},
"required": [
"cluster_settings",
"index_settings",
"data_streams",
"node_settings",
"ml_settings",
"templates",
"ilm_policies"
]
},
"examples": {
"DeprecationInfoResponseExample1": {
"description": "An abbreviated response from `GET /_migration/deprecations`.\n",
"value": "{\n \"cluster_settings\": [\n {\n \"level\": \"critical\",\n \"message\": \"Cluster name cannot contain ':'\",\n \"url\": \"https://www.elastic.co/guide/en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name\",\n \"details\": \"This cluster is named [mycompany:logging], which contains the illegal character ':'.\"\n }\n ],\n \"node_settings\": [],\n \"index_settings\": {\n \"logs:apache\": [\n {\n \"level\": \"warning\",\n \"message\": \"Index name cannot contain ':'\",\n \"url\": \"https://www.elastic.co/guide/en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name\",\n \"details\": \"This index is named [logs:apache], which contains the illegal character ':'.\"\n }\n ]\n },\n \"ml_settings\": []\n}"
}
}
}
}
},
"ml.delete_expired_data-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean"
}
},
"required": [
"deleted"
]
},
"examples": {
"MlDeleteExpiredDataResponseExample1": {
"description": "A successful response when deleting expired and unused anomaly detection data.",
"value": "{\n \"deleted\": true\n}"
}
}
}
}
},
"ml.delete_forecast-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"MlDeleteForecastResponseExample1": {
"description": "A successful response when deleting a forecast from an anomaly detection job.",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
},
"ml.explain_data_frame_analytics-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"field_selection": {
"description": "An array of objects that explain selection for each field, sorted by the field names.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsFieldSelection"
}
},
"memory_estimation": {
"description": "An array of objects that explain selection for each field, sorted by the field names.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsMemoryEstimation"
}
]
}
},
"required": [
"field_selection",
"memory_estimation"
]
},
"examples": {
"MlExplainDataFrameAnalyticsResponseExample1": {
"description": "A succesful response for explaining a data frame analytics job configuration.",
"value": "{\n \"field_selection\": [\n {\n \"field\": \"number_of_bedrooms\",\n \"mappings_types\": [\n \"integer\"\n ],\n \"is_included\": true,\n \"is_required\": false,\n \"feature_type\": \"numerical\"\n },\n {\n \"field\": \"postcode\",\n \"mappings_types\": [\n \"text\"\n ],\n \"is_included\": false,\n \"is_required\": false,\n \"reason\": \"[postcode.keyword] is preferred because it is aggregatable\"\n },\n {\n \"field\": \"postcode.keyword\",\n \"mappings_types\": [\n \"keyword\"\n ],\n \"is_included\": true,\n \"is_required\": false,\n \"feature_type\": \"categorical\"\n },\n {\n \"field\": \"price\",\n \"mappings_types\": [\n \"float\"\n ],\n \"is_included\": true,\n \"is_required\": true,\n \"feature_type\": \"numerical\"\n }\n ],\n \"memory_estimation\": {\n \"expected_memory_without_disk\": \"128MB\",\n \"expected_memory_with_disk\": \"32MB\"\n }\n}"
}
}
}
}
},
"ml.get_buckets-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"buckets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.BucketSummary"
}
},
"count": {
"type": "number"
}
},
"required": [
"buckets",
"count"
]
}
}
}
},
"ml.get_calendars-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"calendars": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml.get_calendars.Calendar"
}
},
"count": {
"type": "number"
}
},
"required": [
"calendars",
"count"
]
}
}
}
},
"ml.get_categories-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Category"
}
},
"count": {
"type": "number"
}
},
"required": [
"categories",
"count"
]
}
}
}
},
"ml.get_data_frame_analytics-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"data_frame_analytics": {
"description": "An array of data frame analytics job resources, which are sorted by the id value in ascending order.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsSummary"
}
}
},
"required": [
"count",
"data_frame_analytics"
]
}
}
}
},
"ml.get_data_frame_analytics_stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"data_frame_analytics": {
"description": "An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DataframeAnalytics"
}
}
},
"required": [
"count",
"data_frame_analytics"
]
}
}
}
},
"ml.get_datafeed_stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"datafeeds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.DatafeedStats"
}
}
},
"required": [
"count",
"datafeeds"
]
}
}
}
},
"ml.get_datafeeds-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"datafeeds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Datafeed"
}
}
},
"required": [
"count",
"datafeeds"
]
}
}
}
},
"ml.get_filters-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Filter"
}
}
},
"required": [
"count",
"filters"
]
}
}
}
},
"ml.get_influencers-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"influencers": {
"description": "Array of influencer objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Influencer"
}
}
},
"required": [
"count",
"influencers"
]
}
}
}
},
"ml.get_job_stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.JobStats"
}
}
},
"required": [
"count",
"jobs"
]
}
}
}
},
"ml.get_jobs-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Job"
}
}
},
"required": [
"count",
"jobs"
]
}
}
}
},
"ml.get_memory_stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_nodes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
},
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ml.get_memory_stats.Memory"
}
}
},
"required": [
"_nodes",
"cluster_name",
"nodes"
]
}
}
}
},
"ml.get_model_snapshots-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"model_snapshots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.ModelSnapshot"
}
}
},
"required": [
"count",
"model_snapshots"
]
}
}
}
},
"ml.get_overall_buckets-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"overall_buckets": {
"description": "Array of overall bucket objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.OverallBucket"
}
}
},
"required": [
"count",
"overall_buckets"
]
}
}
}
},
"ml.get_records-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.Anomaly"
}
}
},
"required": [
"count",
"records"
]
}
}
}
},
"ml.get_trained_models-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"trained_model_configs": {
"description": "An array of trained model resources, which are sorted by the model_id value in ascending order.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TrainedModelConfig"
}
}
},
"required": [
"count",
"trained_model_configs"
]
}
}
}
},
"ml.get_trained_models_stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"description": "The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter.",
"type": "number"
},
"trained_model_stats": {
"description": "An array of trained model statistics, which are sorted by the model_id value in ascending order.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ml._types.TrainedModelStats"
}
}
},
"required": [
"count",
"trained_model_stats"
]
}
}
}
},
"ml.preview_data_frame_analytics-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"feature_values": {
"description": "An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"required": [
"feature_values"
]
}
}
}
},
"ml.preview_datafeed-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"msearch-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_global.msearch.MultiSearchResult"
}
}
}
},
"msearch_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_global.msearch.MultiSearchResult"
}
}
}
},
"mtermvectors-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.mtermvectors.TermVectorsResult"
}
}
},
"required": [
"docs"
]
}
}
}
},
"nodes.hot_threads-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"nodes.info-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nodes.info.ResponseBase"
},
"examples": {
"nodesInfoResponseExample1": {
"description": "An abbreviated response when requesting cluster nodes information.",
"value": "{\n \"_nodes\": {},\n \"cluster_name\": \"elasticsearch\",\n \"nodes\": {\n \"USpTGYaBSIKbgSUJR2Z9lg\": {\n \"name\": \"node-0\",\n \"transport_address\": \"192.168.17:9300\",\n \"host\": \"node-0.elastic.co\",\n \"ip\": \"192.168.17\",\n \"version\": \"{version}\",\n \"transport_version\": 100000298,\n \"index_version\": 100000074,\n \"component_versions\": {\n \"ml_config_version\": 100000162,\n \"transform_config_version\": 100000096\n },\n \"build_flavor\": \"default\",\n \"build_type\": \"{build_type}\",\n \"build_hash\": \"587409e\",\n \"roles\": [\n \"master\",\n \"data\",\n \"ingest\"\n ],\n \"attributes\": {},\n \"plugins\": [\n {\n \"name\": \"analysis-icu\",\n \"version\": \"{version}\",\n \"description\": \"The ICU Analysis plugin integrates Lucene ICU\n module into elasticsearch, adding ICU relates analysis components.\",\n \"classname\":\n \"org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin\",\n \"has_native_controller\": false\n }\n ],\n \"modules\": [\n {\n \"name\": \"lang-painless\",\n \"version\": \"{version}\",\n \"description\": \"An easy, safe and fast scripting language for\n Elasticsearch\",\n \"classname\": \"org.elasticsearch.painless.PainlessPlugin\",\n \"has_native_controller\": false\n }\n ]\n }\n }\n}"
}
}
}
}
},
"nodes.reload_secure_settings-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nodes.reload_secure_settings.ResponseBase"
},
"examples": {
"ReloadSecureSettingsResponseExample1": {
"description": "A successful response when reloading keystore on nodes in your cluster.",
"value": "{\n \"_nodes\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"cluster_name\": \"my_cluster\",\n \"nodes\": {\n \"pQHNt5rXTTWNvUgOrdynKg\": {\n \"name\": \"node-0\",\n \"secure_setting_names\": [\n \"keystore.seed\",\n \"xpack.security.transport.ssl.keystore.secure_password\",\n \"xpack.security.transport.ssl.truststore.secure_password\"\n ],\n \"keystore_path\": \"/etc/elasticsearch/elasticsearch.keystore\",\n \"keystore_digest\": \"031757c262a50abe1b7e017230cdbab99c1be9fbd7116ff504b27a8787158f46\",\n \"keystore_last_modified_time\": \"2025-12-09T22:06:00.408Z\"\n }\n }\n}"
}
}
}
}
},
"nodes.stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nodes.stats.ResponseBase"
}
}
}
},
"nodes.usage-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nodes.usage.ResponseBase"
}
}
}
},
"put_script-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"rank_eval-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"metric_score": {
"description": "The overall evaluation quality calculated by the defined metric",
"type": "number"
},
"details": {
"description": "The details section contains one entry for every query in the original requests section, keyed by the search request id",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricDetail"
}
},
"failures": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"metric_score",
"details",
"failures"
]
}
}
}
},
"render_search_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"template_output": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"template_output"
]
}
}
}
},
"rollup.get_jobs-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/rollup.get_jobs.RollupJob"
}
}
},
"required": [
"jobs"
]
},
"examples": {
"GetRollupJobResponseExample1": {
"description": "A successful response from `GET _rollup/job/sensor`.",
"value": "{\n \"jobs\": [\n {\n \"config\": {\n \"id\": \"sensor\",\n \"index_pattern\": \"sensor-*\",\n \"rollup_index\": \"sensor_rollup\",\n \"cron\": \"*/30 * * * * ?\",\n \"groups\": {\n \"date_histogram\": {\n \"fixed_interval\": \"1h\",\n \"delay\": \"7d\",\n \"field\": \"timestamp\",\n \"time_zone\": \"UTC\"\n },\n \"terms\": {\n \"fields\": [\n \"node\"\n ]\n }\n },\n \"metrics\": [\n {\n \"field\": \"temperature\",\n \"metrics\": [\n \"min\",\n \"max\",\n \"sum\"\n ]\n },\n {\n \"field\": \"voltage\",\n \"metrics\": [\n \"avg\"\n ]\n }\n ],\n \"timeout\": \"20s\",\n \"page_size\": 1000\n },\n \"status\": {\n \"job_state\": \"stopped\"\n },\n \"stats\": {\n \"pages_processed\": 0,\n \"documents_processed\": 0,\n \"rollups_indexed\": 0,\n \"trigger_count\": 0,\n \"index_failures\": 0,\n \"index_time_in_ms\": 0,\n \"index_total\": 0,\n \"search_failures\": 0,\n \"search_time_in_ms\": 0,\n \"search_total\": 0,\n \"processing_time_in_ms\": 0,\n \"processing_total\": 0\n }\n }\n ]\n}"
}
}
}
}
},
"rollup.get_rollup_caps-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/rollup.get_rollup_caps.RollupCapabilities"
}
},
"examples": {
"GetRollupCapabilitiesResponseExample1": {
"description": "A successful response from `GET _rollup/data/sensor-*` for a rollup job that targets the index pattern `sensor-*`. The response contains the rollup job ID, the index that holds the rolled data, and the index pattern that the job was targeting. It also shows a list of fields that contain data eligible for rollup searches. For example, you can use a `min`, `max`, or `sum` aggregation on the `temperature` field, but only a `date_histogram` on `timestamp`.\n",
"value": "{\n \"sensor-*\" : {\n \"rollup_jobs\" : [\n {\n \"job_id\" : \"sensor\",\n \"rollup_index\" : \"sensor_rollup\",\n \"index_pattern\" : \"sensor-*\",\n \"fields\" : {\n \"node\" : [\n {\n \"agg\" : \"terms\"\n }\n ],\n \"temperature\" : [\n {\n \"agg\" : \"min\"\n },\n {\n \"agg\" : \"max\"\n },\n {\n \"agg\" : \"sum\"\n }\n ],\n \"timestamp\" : [\n {\n \"agg\" : \"date_histogram\",\n \"time_zone\" : \"UTC\",\n \"fixed_interval\" : \"1h\",\n \"delay\": \"7d\"\n }\n ],\n \"voltage\" : [\n {\n \"agg\" : \"avg\"\n }\n ]\n }\n }\n ]\n }\n}"
}
}
}
}
},
"rollup.rollup_search-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"took": {
"type": "number"
},
"timed_out": {
"type": "boolean"
},
"terminated_early": {
"type": "boolean"
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"hits": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HitsMetadata"
}
]
},
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.Aggregate"
}
}
},
"required": [
"took",
"timed_out",
"_shards",
"hits"
]
},
"examples": {
"RollupSearchResponseExample1": {
"description": "An abbreviated response from `GET /sensor_rollup/_rollup_search` with a `max` aggregation on a `temperature` field. The response provides some metadata about the request (`took`, `_shards`), the search hits (which is always empty for rollup searches), and the aggregation response.\n",
"value": "{\n \"took\" : 102,\n \"timed_out\" : false,\n \"terminated_early\" : false,\n \"_shards\" : {} ,\n \"hits\" : {\n \"total\" : {\n \"value\": 0,\n \"relation\": \"eq\"\n },\n \"max_score\" : 0.0,\n \"hits\" : [ ]\n },\n \"aggregations\" : {\n \"max_temperature\" : {\n \"value\" : 202.0\n }\n }\n}"
}
}
}
}
},
"scripts_painless_execute-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "object"
}
},
"required": [
"result"
]
},
"examples": {
"ExecutePainlessScriptResponseExample1": {
"summary": "Test context",
"description": "A successful response from `POST /_scripts/painless/_execute` with a `painless_test` context.",
"value": "{\n \"result\": \"0.1\"\n}"
},
"ExecutePainlessScriptResponseExample2": {
"summary": "Filter context",
"description": "A successful response from `POST /_scripts/painless/_execute` with a `filter` context.",
"value": "{\n \"result\": true\n}"
},
"ExecutePainlessScriptResponseExample3": {
"summary": "Score context",
"description": "A successful response from `POST /_scripts/painless/_execute` with a `score` context.",
"value": "{\n \"result\": 0.8\n}"
}
}
}
}
},
"scroll-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_global.search.ResponseBody"
}
}
}
},
"search-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_global.search.ResponseBody"
},
"examples": {
"SearchResponseExample1": {
"description": "An abbreviated response from `GET /my-index-000001/_search?from=40&size=20` with a simple term query.\n",
"value": "{\n \"took\": 5,\n \"timed_out\": false,\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"hits\": {\n \"total\": {\n \"value\": 20,\n \"relation\": \"eq\"\n },\n \"max_score\": 1.3862942,\n \"hits\": [\n {\n \"_index\": \"my-index-000001\",\n \"_id\": \"0\",\n \"_score\": 1.3862942,\n \"_source\": {\n \"@timestamp\": \"2099-11-15T14:12:12\",\n \"http\": {\n \"request\": {\n \"method\": \"get\"\n },\n \"response\": {\n \"status_code\": 200,\n \"bytes\": 1070000\n },\n \"version\": \"1.1\"\n },\n \"source\": {\n \"ip\": \"127.0.0.1\"\n },\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n }\n }\n ]\n }\n}"
}
}
}
}
},
"search_application.get_behavioral_analytics-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/search_application._types.AnalyticsCollection"
}
},
"examples": {
"BehavioralAnalyticsGetResponseExample1": {
"description": "A successful response from `GET _application/analytics/my*`",
"value": "{\n \"my_analytics_collection\": {\n \"event_data_stream\": {\n \"name\": \"behavioral_analytics-events-my_analytics_collection\"\n }\n },\n \"my_analytics_collection2\": {\n \"event_data_stream\": {\n \"name\": \"behavioral_analytics-events-my_analytics_collection2\"\n }\n }\n}"
}
}
}
}
},
"search_application.search-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_global.search.ResponseBody"
}
}
}
},
"search_mvt-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.MapboxVectorTiles"
},
"examples": {
"SearchMvtResponseExample1": {
"description": "A successful response from `GET museums/_mvt/location/13/4207/2692`. It returns results as a binary vector tile. When decoded into JSON, the tile contains the following data.\n",
"value": "{\n \"hits\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3208,\n 3864\n ]\n },\n \"properties\": {\n \"_id\": \"1\",\n \"_index\": \"museums\",\n \"name\": \"NEMO Science Museum\",\n \"price\": 1750\n },\n \"type\": 1\n },\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3429,\n 3496\n ]\n },\n \"properties\": {\n \"_id\": \"3\",\n \"_index\": \"museums\",\n \"name\": \"Nederlands Scheepvaartmuseum\",\n \"price\": 1650\n },\n \"type\": 1\n },\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3429,\n 3496\n ]\n },\n \"properties\": {\n \"_id\": \"4\",\n \"_index\": \"museums\",\n \"name\": \"Amsterdam Centre for Architecture\",\n \"price\": 0\n },\n \"type\": 1\n }\n ]\n },\n \"aggs\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 3072,\n 3072\n ],\n [\n 4096,\n 3072\n ],\n [\n 4096,\n 4096\n ],\n [\n 3072,\n 4096\n ],\n [\n 3072,\n 3072\n ]\n ]\n ]\n },\n \"properties\": {\n \"_count\": 3,\n \"max_price.value\": 1750.0,\n \"min_price.value\": 0.0,\n \"avg_price.value\": 1133.3333333333333\n },\n \"type\": 3\n }\n ]\n },\n \"meta\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 0,\n 0\n ],\n [\n 4096,\n 0\n ],\n [\n 4096,\n 4096\n ],\n [\n 0,\n 4096\n ],\n [\n 0,\n 0\n ]\n ]\n ]\n },\n \"properties\": {\n \"_shards.failed\": 0,\n \"_shards.skipped\": 0,\n \"_shards.successful\": 1,\n \"_shards.total\": 1,\n \"aggregations._count.avg\": 3.0,\n \"aggregations._count.count\": 1,\n \"aggregations._count.max\": 3.0,\n \"aggregations._count.min\": 3.0,\n \"aggregations._count.sum\": 3.0,\n \"aggregations.avg_price.avg\": 1133.3333333333333,\n \"aggregations.avg_price.count\": 1,\n \"aggregations.avg_price.max\": 1133.3333333333333,\n \"aggregations.avg_price.min\": 1133.3333333333333,\n \"aggregations.avg_price.sum\": 1133.3333333333333,\n \"aggregations.max_price.avg\": 1750.0,\n \"aggregations.max_price.count\": 1,\n \"aggregations.max_price.max\": 1750.0,\n \"aggregations.max_price.min\": 1750.0,\n \"aggregations.max_price.sum\": 1750.0,\n \"aggregations.min_price.avg\": 0.0,\n \"aggregations.min_price.count\": 1,\n \"aggregations.min_price.max\": 0.0,\n \"aggregations.min_price.min\": 0.0,\n \"aggregations.min_price.sum\": 0.0,\n \"hits.max_score\": 0.0,\n \"hits.total.relation\": \"eq\",\n \"hits.total.value\": 3,\n \"timed_out\": false,\n \"took\": 2\n },\n \"type\": 3\n }\n ]\n }\n}"
}
}
}
}
},
"search_shards-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.search_shards.SearchShardsNodeAttributes"
}
},
"shards": {
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.NodeShard"
}
}
},
"indices": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.search_shards.ShardStoreIndex"
}
}
},
"required": [
"nodes",
"shards",
"indices"
]
},
"examples": {
"SearchShardsResponseExample1": {
"description": "An abbreviated response from `GET /my-index-000001/_search_shards`.",
"value": "{\n \"nodes\": {},\n \"indices\": {\n \"my-index-000001\": { }\n },\n \"shards\": [\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 0,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"0TvkCyF7TAmM1wHP4a42-A\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ],\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 1,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"fMju3hd1QHWmWrIgFnI4Ww\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ],\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 2,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"Nwl0wbMBTHCWjEEbGYGapg\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ],\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 3,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"bU_KLGJISbW0RejwnwDPKw\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ],\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 4,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"DMs7_giNSwmdqVukF7UydA\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ]\n ]\n }"
}
}
}
}
},
"search_template-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"took": {
"type": "number"
},
"timed_out": {
"type": "boolean"
},
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"hits": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.HitsMetadata"
}
]
},
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.Aggregate"
}
},
"_clusters": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ClusterStatistics"
}
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"max_score": {
"type": "number"
},
"num_reduce_phases": {
"type": "number"
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Profile"
}
]
},
"pit_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_scroll_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ScrollId"
}
]
},
"suggest": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Suggest"
}
}
},
"terminated_early": {
"type": "boolean"
}
},
"required": [
"took",
"timed_out",
"_shards",
"hits"
]
}
}
}
},
"searchable_snapshots.cache_stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nodes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/searchable_snapshots.cache_stats.Node"
}
}
},
"required": [
"nodes"
]
},
"examples": {
"CacheStatsResponseExample1": {
"description": "A successful response from `GET /_searchable_snapshots/cache/stats`.",
"value": "{\n \"nodes\" : {\n \"eerrtBMtQEisohZzxBLUSw\" : {\n \"shared_cache\" : {\n \"reads\" : 6051, // The number of cache region read operations. If reads > writes, the difference represents requests successfully served from the cache without accessing the snapshot repository.\n \"bytes_read_in_bytes\" : 5448829,\n \"writes\" : 37, // The number of cache region write operations. If reads == writes, every request required fetching data from the snapshot repository into the cache.\n \"bytes_written_in_bytes\" : 1208320,\n \"evictions\" : 5, // The number of cache region evictions. A low eviction count indicates the cache is effectively serving requests. Use this metric to evaluate cache sizing.\n \"num_regions\" : 65536,\n \"size_in_bytes\" : 1099511627776,\n \"region_size_in_bytes\" : 16777216 // The size of each cache region. A region is a contiguous byte range stored on local disk.\n }\n }\n }\n}"
}
}
}
}
},
"searchable_snapshots.clear_cache-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"searchable_snapshots.stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"stats": {
"type": "object"
},
"total": {
"type": "object"
}
},
"required": [
"stats",
"total"
]
}
}
}
},
"security.change_password-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"security.clone_api_key-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"api_key": {
"description": "The generated API key value for the cloned key.",
"type": "string"
},
"expiration": {
"description": "Expiration in milliseconds for the API key.",
"type": "number"
},
"id": {
"description": "The unique ID of the cloned API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"name": {
"description": "The name of the cloned API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"encoded": {
"description": "API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).",
"type": "string"
}
},
"required": [
"api_key",
"id",
"name",
"encoded"
]
}
}
}
},
"security.create_api_key-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"api_key": {
"description": "Generated API key.",
"type": "string"
},
"expiration": {
"description": "Expiration in milliseconds for the API key.",
"type": "number"
},
"id": {
"description": "Unique ID for this API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"name": {
"description": "Specifies the name for this API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"encoded": {
"description": "API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).",
"x-state": "Generally available; Added in 7.16.0",
"type": "string"
}
},
"required": [
"api_key",
"id",
"name",
"encoded"
]
},
"examples": {
"SecurityCreateApiKeyResponseExample1": {
"description": "A successful response from `POST /_security/api_key`.",
"value": "{\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\", \n \"name\": \"my-api-key\",\n \"expiration\": 1544068612110, \n \"api_key\": \"ui2lp2axTNmsyakw9tvNnw\", \n \"encoded\": \"VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw==\" \n}"
}
}
}
}
},
"security.create_service_token-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"created": {
"type": "boolean"
},
"token": {
"allOf": [
{
"$ref": "#/components/schemas/security.create_service_token.Token"
}
]
}
},
"required": [
"created",
"token"
]
},
"examples": {
"CreateServiceTokenRequestExample1": {
"description": "A successful response from `POST /_security/service/elastic/fleet-server/credential/token/token1`. The response includes the service account token, its name, and its secret value as a bearer token.\n",
"value": "{\n \"created\": true,\n \"token\": {\n \"name\": \"token1\",\n \"value\": \"AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ\" \n }\n}"
}
}
}
}
},
"security.disable_user-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"security.disable_user_profile-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"security.enable_user-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"security.enable_user_profile-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"security.get_privileges-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.put_privileges.Actions"
}
}
},
"examples": {
"SecurityGetPrivilegesResponseExample1": {
"description": "A successful response from `GET /_security/privilege/myapp/read`. The response contains information about the `read` privilege for the `app01` application.\n",
"value": "{\n \"myapp\": {\n \"read\": {\n \"application\": \"myapp\",\n \"name\": \"read\",\n \"actions\": [\n \"data:read/*\",\n \"action:login\"\n ],\n \"metadata\": {\n \"description\": \"Read access to myapp\"\n }\n }\n }\n}"
}
}
}
}
},
"security.get_role-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.get_role.Role"
}
},
"examples": {
"SecurityGetRoleResponseExample1": {
"description": "A successful response from `GET /_security/role/my_admin_role`. The response contains information about the `my_admin_role` role in the native realm.\n",
"value": "{\n \"my_admin_role\": {\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\" : [ \"all\" ],\n \"indices\" : [\n {\n \"names\" : [ \"index1\", \"index2\" ],\n \"privileges\" : [ \"all\" ],\n \"allow_restricted_indices\" : false,\n \"field_security\" : {\n \"grant\" : [ \"title\", \"body\" ]}\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ \"other_user\" ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n}"
}
}
}
}
},
"security.get_role_mapping-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleMapping"
}
},
"examples": {
"SecurityGetRoleMappingResponseExample1": {
"description": "A successful response from `GET /_security/role_mapping/mapping1`.",
"value": "{\n \"mapping1\": {\n \"enabled\": true,\n \"roles\": [\n \"user\"\n ],\n \"rules\": {\n \"field\": {\n \"username\": \"*\"\n }\n },\n \"metadata\": {}\n }\n}"
}
}
}
}
},
"security.get_service_accounts-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.get_service_accounts.RoleDescriptorWrapper"
}
},
"examples": {
"GetServiceAccountsResponseExample1": {
"description": "A successful response from `GET /_security/service/elastic/fleet-server`. The response contains information about the `elastic/fleet-server` service account.\n",
"value": "{\n \"elastic/fleet-server\": {\n \"role_descriptor\": {\n \"cluster\": [\n \"monitor\",\n \"manage_own_api_key\",\n \"read_fleet_secrets\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"logs-*\",\n \"metrics-*\",\n \"traces-*\",\n \".logs-endpoint.diagnostic.collection-*\",\n \".logs-endpoint.action.responses-*\",\n \".logs-endpoint.heartbeat-*\"\n ],\n \"privileges\": [\n \"write\",\n \"create_index\",\n \"auto_configure\"\n ],\n \"allow_restricted_indices\": false\n },\n {\n \"names\": [\n \"profiling-*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\"\n ],\n \"allow_restricted_indices\": false\n },\n {\n \"names\": [\n \"traces-apm.sampled-*\"\n ],\n \"privileges\": [\n \"read\",\n \"monitor\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": false\n },\n {\n \"names\": [\n \".fleet-secrets*\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-actions*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-agents*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-artifacts*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-enrollment-api-keys*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-policies*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-policies-leader*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-servers*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-fileds*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \"synthetics-*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"create_index\",\n \"auto_configure\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [\n {\n \"application\": \"kibana-*\",\n \"privileges\": [\n \"reserved_fleet-setup\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [],\n \"metadata\": {},\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n}"
}
}
}
}
},
"security.get_user-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.User"
}
},
"examples": {
"SecurityGetUserResponseExample1": {
"description": "A successful response from `GET /_security/user/jacknich?with_profile_uid=true`. It includes the user `profile_uid` as part of the response.\n",
"value": "{\n \"jacknich\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\",\n \"metadata\": { \"intelligence\" : 7 },\n \"enabled\": true,\n \"profile_uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n }\n}"
}
}
}
}
},
"security.has_privileges-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"application": {
"allOf": [
{
"$ref": "#/components/schemas/security.has_privileges.ApplicationsPrivileges"
}
]
},
"cluster": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"has_all_requested": {
"type": "boolean"
},
"index": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.has_privileges.Privileges"
}
},
"username": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
}
},
"required": [
"application",
"cluster",
"has_all_requested",
"index",
"username"
]
},
"examples": {
"SecurityHasPrivilegesResponseExample1": {
"description": "A successful response from `GET /_security/user/_has_privileges`, which lists the privileges for the `rdeniro` user.",
"value": "{\n \"username\": \"rdeniro\",\n \"has_all_requested\" : false,\n \"cluster\" : {\n \"monitor\" : true,\n \"manage\" : false\n },\n \"index\" : {\n \"suppliers\" : {\n \"read\" : true\n },\n \"products\" : {\n \"read\" : true\n },\n \"inventory\" : {\n \"read\" : true,\n \"write\" : false\n }\n },\n \"application\" : {\n \"inventory_manager\" : {\n \"product/1852563\" : {\n \"read\": false,\n \"data:write/inventory\": false\n }\n }\n }\n}"
}
}
}
}
},
"security.has_privileges_user_profile-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_privilege_uids": {
"description": "The subset of the requested profile IDs of the users that\nhave all the requested privileges.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.UserProfileId"
}
},
"errors": {
"description": "The subset of the requested profile IDs for which an error\nwas encountered. It does not include the missing profile IDs\nor the profile IDs of the users that do not have all the\nrequested privileges. This field is absent if empty.",
"allOf": [
{
"$ref": "#/components/schemas/security.has_privileges_user_profile.HasPrivilegesUserProfileErrors"
}
]
}
},
"required": [
"has_privilege_uids"
]
},
"examples": {
"HasPrivilegesUserProfileResponseExample1": {
"description": "A response from `POST /_security/profile/_has_privileges` that indicates only one of the three users has all the privileges and one of them is not found.\n",
"value": "{\n \"has_privilege_uids\": [\"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\"],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"u_does-not-exist_0\": {\n \"type\": \"resource_not_found_exception\",\n \"reason\": \"profile document not found\"\n }\n }\n }\n}"
}
}
}
}
},
"security.put_privileges-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.CreatedStatus"
}
}
},
"examples": {
"SecurityPutPrivilegesResponseExample1": {
"description": "A successful response from `PUT /_security/privilege`.",
"value": "{\n \"myapp\": {\n \"read\": {\n \"created\": true \n }\n }\n}"
},
"SecurityPutPrivilegesResponseExample2": {
"description": "A successful response from `PUT /_security/privilege`. The `created` property indicates whether the privileges have been created or updated.\n",
"value": "{\n \"app02\": {\n \"all\": {\n \"created\": true\n }\n },\n \"app01\": {\n \"read\": {\n \"created\": true\n },\n \"write\": {\n \"created\": true\n }\n }\n}"
}
}
}
}
},
"security.put_role-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"role": {
"description": "When an existing role is updated, `created` is set to `false`.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.CreatedStatus"
}
]
}
},
"required": [
"role"
]
},
"examples": {
"SecurityPutRoleResponseExample1": {
"description": "A successful response from `POST /_security/role/my_admin_role`.",
"value": "{\n \"role\": {\n \"created\": true \n }\n}"
}
}
}
}
},
"security.put_role_mapping-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"created": {
"type": "boolean"
},
"role_mapping": {
"allOf": [
{
"$ref": "#/components/schemas/security._types.CreatedStatus"
}
]
}
},
"required": [
"role_mapping"
]
},
"examples": {
"SecurityPutRoleMappingResponseExample1": {
"description": "A successful response from `POST /_security/role_mapping/mapping1`.",
"value": "{\n \"role_mapping\" : {\n \"created\" : true \n }\n}"
}
}
}
}
},
"security.put_user-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"created": {
"description": "A successful call returns a JSON structure that shows whether the user has been created or updated.\nWhen an existing user is updated, `created` is set to `false`.",
"type": "boolean"
}
},
"required": [
"created"
]
},
"examples": {
"SecurityPutUserResponseExample1": {
"description": "A successful response from `POST /_security/user/jacknich`. When an existing user is updated, `created` is set to `false`.\n",
"value": "{\n \"created\": true \n}"
}
}
}
}
},
"security.query_api_keys-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"description": "The total number of API keys found.",
"type": "number"
},
"count": {
"description": "The number of API keys returned in the response.",
"type": "number"
},
"api_keys": {
"description": "A list of API key information.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ApiKey"
}
},
"aggregations": {
"description": "The aggregations result, if requested.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.query_api_keys.ApiKeyAggregate"
}
}
},
"required": [
"total",
"count",
"api_keys"
]
},
"examples": {
"QueryApiKeysResponseExample1": {
"summary": "Query API keys by ID",
"description": "A successful response from `GET /_security/_query/api_key?with_limited_by=true`. The `limited_by` details are the owner user's permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key's effective permissions are an intersection of its assigned privileges and the owner user's permissions.\n",
"value": "{\n \"api_keys\": [\n {\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\",\n \"name\": \"application-key-1\",\n \"creation\": 1548550550158,\n \"expiration\": 1548551550158,\n \"invalidated\": false,\n \"username\": \"myuser\",\n \"realm\": \"native1\",\n \"realm_type\": \"native\",\n \"metadata\": {\n \"application\": \"my-application\"\n },\n \"role_descriptors\": { },\n \"limited_by\": [ \n {\n \"role-power-user\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n ]\n }\n ]\n}"
},
"QueryApiKeysResponseExample2": {
"summary": "Query API keys with pagination",
"description": "An abbreviated response from `GET /_security/_query/api_key` that contains a list of matched API keys along with their sort values. The first sort value is creation time, which is displayed in `date_time` format. The second sort value is the API key name.\n",
"value": "{\n \"total\": 100,\n \"count\": 10,\n \"api_keys\": [\n {\n \"id\": \"CLXgVnsBOGkf8IyjcXU7\",\n \"name\": \"app1-key-79\",\n \"creation\": 1629250154811,\n \"invalidated\": false,\n \"username\": \"org-admin-user\",\n \"realm\": \"native1\",\n \"metadata\": {\n \"environment\": \"production\"\n },\n \"role_descriptors\": { },\n \"_sort\": [\n \"2021-08-18T01:29:14.811Z\", \n \"app1-key-79\" \n ]\n },\n {\n \"id\": \"BrXgVnsBOGkf8IyjbXVB\",\n \"name\": \"app1-key-78\",\n \"creation\": 1629250153794,\n \"invalidated\": false,\n \"username\": \"org-admin-user\",\n \"realm\": \"native1\",\n \"metadata\": {\n \"environment\": \"production\"\n },\n \"role_descriptors\": { },\n \"_sort\": [\n \"2021-08-18T01:29:13.794Z\",\n \"app1-key-78\"\n ]\n }\n ]\n}"
},
"QueryApiKeysResponseExample3": {
"summary": "Query all API keys",
"description": "A successful response from `GET /_security/_query/api_key`. It includes the role descriptors that are assigned to each API key when it was created or last updated. Note that an API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of the owner user's permissions. An empty role descriptors object means the API key inherits the owner user's permissions.\n",
"value": "{\n \"total\": 3,\n \"count\": 3,\n \"api_keys\": [ \n {\n \"id\": \"nkvrGXsB8w290t56q3Rg\",\n \"name\": \"my-api-key-1\",\n \"creation\": 1628227480421,\n \"expiration\": 1629091480421,\n \"invalidated\": false,\n \"username\": \"elastic\",\n \"realm\": \"reserved\",\n \"realm_type\": \"reserved\",\n \"metadata\": {\n \"letter\": \"a\"\n },\n \"role_descriptors\": { \n \"role-a\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n },\n {\n \"id\": \"oEvrGXsB8w290t5683TI\",\n \"name\": \"my-api-key-2\",\n \"creation\": 1628227498953,\n \"expiration\": 1628313898953,\n \"invalidated\": false,\n \"username\": \"elastic\",\n \"realm\": \"reserved\",\n \"metadata\": {\n \"letter\": \"b\"\n },\n \"role_descriptors\": { } \n }\n ]\n}"
}
}
}
}
},
"security.query_role-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"description": "The total number of roles found.",
"type": "number"
},
"count": {
"description": "The number of roles returned in the response.",
"type": "number"
},
"roles": {
"description": "A list of roles that match the query.\nThe returned role format is an extension of the role definition format.\nIt adds the `transient_metadata.enabled` and the `_sort` fields.\n`transient_metadata.enabled` is set to `false` in case the role is automatically disabled, for example when the role grants privileges that are not allowed by the installed license.\n`_sort` is present when the search query sorts on some field.\nIt contains the array of values that have been used for sorting.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security.query_role.QueryRole"
}
}
},
"required": [
"total",
"count",
"roles"
]
},
"examples": {
"QueryRolesResponseExample1": {
"summary": "Query roles by name",
"description": "A successful response from `POST /_security/_query/role`. It returns a JSON structure that contains the information retrieved for one or more roles.\n",
"value": "{\n \"total\": 2,\n \"count\": 2,\n \"roles\": [ \n {\n \"name\" : \"my_admin_role\",\n \"cluster\" : [\n \"all\"\n ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [\n \"other_user\"\n ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants full access to all management features within the cluster.\",\n \"_sort\" : [\n \"my_admin_role\"\n ]\n },\n {\n \"name\" : \"my_user_role\",\n \"cluster\" : [ ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants user access to some indicies.\",\n \"_sort\" : [\n \"my_user_role\"\n ]\n }\n ]\n}"
},
"QueryRolesResponseExample2": {
"summary": "Query roles by description",
"description": "A successful response from `POST /_security/_query/role`.\n",
"value": "{\n \"total\": 2,\n \"count\": 1,\n \"roles\": [\n {\n \"name\" : \"my_user_role\",\n \"cluster\" : [ ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants user access to some indicies.\"\n }\n ]\n}"
}
}
}
}
},
"security.query_user-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"description": "The total number of users found.",
"type": "number"
},
"count": {
"description": "The number of users returned in the response.",
"type": "number"
},
"users": {
"description": "A list of users that match the query.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security.query_user.QueryUser"
}
}
},
"required": [
"total",
"count",
"users"
]
},
"examples": {
"SecurityQueryUserResponseExample1": {
"summary": "Query users by role prefix",
"description": "A successful response from `POST /_security/_query/user?with_profile_uid=true` that contains users that have roles that are prefixed with `other`. It also includes the user `profile_uid` in the response.\n",
"value": "{\n \"total\": 1,\n \"count\": 1,\n \"users\": [\n {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\",\n \"other_role1\"\n ],\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true,\n \"profile_uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n }\n ]\n}"
},
"SecurityQueryUserResponseExample2": {
"summary": "Query users with multiple conditions",
"description": "A successful response from `POST /_security/_query/user` that uses a `bool` query to issue complex logical conditions and uses `from`, `size`, and `sort` to help paginate the result. The sort value is `username`.\n",
"value": "{\n \"total\": 5,\n \"count\": 2,\n \"users\": [\n {\n \"username\": \"ray\",\n \"roles\": [\n \"other_role3\"\n ],\n \"full_name\": \"Ray Nicholson\",\n \"email\": \"rayn@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true,\n \"_sort\": [\n \"ray\" \n ]\n },\n {\n \"username\": \"lorraine\",\n \"roles\": [\n \"other_role3\"\n ],\n \"full_name\": \"Lorraine Nicholson\",\n \"email\": \"lorraine@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true,\n \"_sort\": [\n \"lorraine\"\n ]\n }\n ]\n}"
},
"SecurityQueryUserResponseExample3": {
"summary": "Query all users",
"description": "A successful response from `GET /_security/_query/user`, which lists all users. It returns a JSON structure that contains the information retrieved from one or more users.\n",
"value": "{\n \"total\": 2,\n \"count\": 2,\n \"users\": [ \n {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\",\n \"other_role1\"\n ],\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true\n },\n {\n \"username\": \"sandrakn\",\n \"roles\": [\n \"admin\",\n \"other_role1\"\n ],\n \"full_name\": \"Sandra Knight\",\n \"email\": \"sandrakn@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true\n }\n ]\n}"
}
}
}
}
},
"security.suggest_user_profiles-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"description": "Metadata about the number of matching profiles.",
"allOf": [
{
"$ref": "#/components/schemas/security.suggest_user_profiles.TotalUserProfiles"
}
]
},
"took": {
"description": "The number of milliseconds it took Elasticsearch to run the request.",
"type": "number"
},
"profiles": {
"description": "A list of profile documents, ordered by relevance, that match the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.UserProfile"
}
}
},
"required": [
"total",
"took",
"profiles"
]
},
"examples": {
"SuggestUserProfilesResponseExample1": {
"description": "A successful response from `GET /_security/saml/metadata/saml1`. It contains the SAML metadata that was generated for the SAML realm as an XML string.\n",
"value": "{\n \"metadata\" : \"\"\n}"
}
}
}
}
},
"security.update_user_profile_data-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
},
"examples": {
"UpdateUserProfileDataResponseExample1": {
"description": "A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged.\n",
"value": "{\n \"acknowledged\": true\n}"
}
}
}
}
},
"simulate.ingest-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/simulate.ingest.SimulateIngestDocumentResult"
}
}
},
"required": [
"docs"
]
},
"examples": {
"SimulateIngestResponseExample1": {
"summary": "Use an existing pipeline definition",
"description": "A successful response when the simulation uses pipeline definitions that are already in the system.",
"value": "{\n \"docs\": [\n {\n \"doc\": null,\n \"_id\": 123,\n \"_index\": \"my-index\",\n \"_version\": -3,\n \"_source\": {\n \"field1\": \"value1\",\n \"field2\": \"value2\",\n \"foo\": \"bar\"\n },\n \"executed_pipelines\": [\n \"my-pipeline\",\n \"my-final-pipeline\"\n ]\n },\n {\n \"doc\": null,\n \"_id\": 456,\n \"_index\": \"my-index\",\n \"_version\": \"-3,\",\n \"_source\": {\n \"field1\": \"value1\",\n \"field2\": \"value2\",\n \"foo\": \"rab\"\n },\n \"executed_pipelines\": [\n \"my-pipeline\",\n \"my-final-pipeline\"\n ]\n }\n ]\n}"
},
"SimulateIngestResponseExample2": {
"summary": "Use pipeline substitutions",
"description": "A successful response when the simulation uses pipeline substitutions.",
"value": "{\n \"docs\": [\n {\n \"doc\": null,\n \"_id\": 123,\n \"_index\": \"my-index\",\n \"_version\": -3,\n \"_source\": {\n \"field2\": \"value2\",\n \"foo\": \"BAR\"\n },\n \"executed_pipelines\": [\n \"my-pipeline\",\n \"my-final-pipeline\"\n ]\n },\n {\n \"doc\": null,\n \"_id\": 456,\n \"_index\": \"my-index\",\n \"_version\": -3,\n \"_source\": {\n \"field2\": \"value2\",\n \"foo\": \"RAB\"\n },\n \"executed_pipelines\": [\n \"my-pipeline\",\n \"my-final-pipeline\"\n ]\n }\n ]\n}"
},
"SimulateIngestResponseExample3": {
"summary": "Use pipeline substitutions",
"description": "A successful response when the simulation uses pipeline substitutions.",
"value": "{\n \"docs\": [\n {\n \"doc\": {\n \"_id\": \"123\",\n \"_index\": \"my-index\",\n \"_version\": -3,\n \"_source\": {\n \"foo\": \"foo\"\n },\n \"executed_pipelines\": [],\n \"effective_mapping\": {\n \"_doc\": {\n \"properties\": {\n \"foo\": {\n \"type\": \"keyword\"\n }\n }\n }\n }\n }\n },\n {\n \"doc\": {\n \"_id\": \"456\",\n \"_index\": \"my-index\",\n \"_version\": -3,\n \"_source\": {\n \"bar\": \"rab\"\n },\n \"executed_pipelines\": [],\n \"effective_mapping\": {\n \"_doc\": {\n \"properties\": {\n \"bar\": {\n \"type\": \"keyword\"\n }\n }\n }\n }\n }\n }\n ]\n}"
}
}
}
}
},
"slm.get_lifecycle-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/slm._types.SnapshotLifecycle"
}
},
"examples": {
"GetSnapshotLifecycleResponseExample1": {
"description": "A successful response from `GET _slm/policy/daily-snapshots?human`.",
"value": "{\n \"daily-snapshots\": {\n \"version\": 1,\n \"modified_date\": \"2099-05-06T01:30:00.000Z\",\n \"modified_date_millis\": 4081757400000,\n \"policy\" : {\n \"schedule\": \"0 30 1 * * ?\",\n \"name\": \"\",\n \"repository\": \"my_repository\",\n \"config\": {\n \"indices\": [\"data-*\", \"important\"],\n \"ignore_unavailable\": false,\n \"include_global_state\": false\n },\n \"retention\": {\n \"expire_after\": \"30d\",\n \"min_count\": 5,\n \"max_count\": 50\n }\n },\n \"stats\": {\n \"policy\": \"daily-snapshots\",\n \"snapshots_taken\": 0,\n \"snapshots_failed\": 0,\n \"snapshots_deleted\": 0,\n \"snapshot_deletion_failures\": 0\n },\n \"next_execution\": \"2099-05-07T01:30:00.000Z\",\n \"next_execution_millis\": 4081843800000\n }\n}"
}
}
}
}
},
"snapshot.create-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"accepted": {
"description": "Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`",
"x-state": "Generally available; Added in 7.15.0",
"type": "boolean"
},
"snapshot": {
"description": "Snapshot information. Present when the request had `wait_for_completion` set to `true`",
"allOf": [
{
"$ref": "#/components/schemas/snapshot._types.SnapshotInfo"
}
]
}
}
},
"examples": {
"SnapshotCreateResponseExample1": {
"description": "A successful response from `PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true`.",
"value": "{\n \"snapshot\": {\n \"snapshot\": \"snapshot_2\",\n \"uuid\": \"vdRctLCxSketdKb54xw67g\",\n \"repository\": \"my_repository\",\n \"version_id\": ,\n \"version\": ,\n \"indices\": [],\n \"data_streams\": [],\n \"feature_states\": [],\n \"include_global_state\": false,\n \"metadata\": {\n \"taken_by\": \"user123\",\n \"taken_because\": \"backup before upgrading\"\n },\n \"state\": \"SUCCESS\",\n \"start_time\": \"2020-06-25T14:00:28.850Z\",\n \"start_time_in_millis\": 1593093628850,\n \"end_time\": \"2020-06-25T14:00:28.850Z\",\n \"end_time_in_millis\": 1593094752018,\n \"duration_in_millis\": 0,\n \"failures\": [],\n \"shards\": {\n \"total\": 0,\n \"failed\": 0,\n \"successful\": 0\n }\n }\n}"
}
}
}
}
},
"snapshot.create_repository-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
}
}
}
},
"snapshot.get_repository-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/snapshot._types.Repository"
}
},
"examples": {
"SnapshotGetRepositoryResponseExample1": {
"description": "A successful response from `GET /_snapshot/my_repository`.",
"value": "{\n \"my_repository\" : {\n \"type\" : \"fs\",\n \"uuid\" : \"0JLknrXbSUiVPuLakHjBrQ\",\n \"settings\" : {\n \"location\" : \"my_backup_location\"\n }\n }\n}"
}
}
}
}
},
"snapshot.status-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"snapshots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snapshot._types.Status"
}
}
},
"required": [
"snapshots"
]
},
"examples": {
"SnapshotStatusResponseExample1": {
"summary": "All shard stats present",
"description": "A successful response from `GET _snapshot/my_repository/snapshot_2/_status`. The response contains detailed status information for `snapshot_2` in the `my_repository` repository.\n",
"value": "{\n \"snapshots\" : [\n {\n \"snapshot\" : \"snapshot_2\",\n \"repository\" : \"my_repository\",\n \"uuid\" : \"lNeQD1SvTQCqqJUMQSwmGg\",\n \"state\" : \"SUCCESS\",\n \"include_global_state\" : false,\n \"shards_stats\" : {\n \"initializing\" : 0,\n \"started\" : 0,\n \"finalizing\" : 0,\n \"done\" : 1,\n \"failed\" : 0,\n \"total\" : 1\n },\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 3,\n \"size_in_bytes\" : 5969\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 6024\n },\n \"start_time_in_millis\" : 1594829326691,\n \"time_in_millis\" : 205\n },\n \"indices\" : {\n \"index_1\" : {\n \"shards_stats\" : {\n \"initializing\" : 0,\n \"started\" : 0,\n \"finalizing\" : 0,\n \"done\" : 1,\n \"failed\" : 0,\n \"total\" : 1\n },\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 3,\n \"size_in_bytes\" : 5969\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 6024\n },\n \"start_time_in_millis\" : 1594829326896,\n \"time_in_millis\" : 0\n },\n \"shards\" : {\n \"0\" : {\n \"stage\" : \"DONE\",\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 3,\n \"size_in_bytes\" : 5969\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 6024\n },\n \"start_time_in_millis\" : 1594829326896,\n \"time_in_millis\" : 0\n }\n }\n }\n }\n }\n }\n ]\n}"
},
"SnapshotStatusResponseExample2": {
"summary": "Missing shard stats",
"description": "A successful response from `GET _snapshot/my_repository/snapshot_2/_status`. Note that in this example the stats for `index-2` shard `0` are missing, with explanatory details provided in the `description` field.\n",
"value": "{\n \"snapshots\" : [\n {\n \"snapshot\" : \"snapshot_2\",\n \"repository\" : \"my_repository\",\n \"uuid\" : \"lNeQD1SvTQCqqJUMQSwmGg\",\n \"state\" : \"STARTED\",\n \"include_global_state\" : true,\n \"shards_stats\" : {\n \"initializing\" : 0,\n \"started\" : 1,\n \"finalizing\" : 0,\n \"done\" : 1,\n \"failed\" : 0,\n \"total\" : 2\n },\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 5412\n },\n \"processed\" : {\n \"file_count\" : 2,\n \"size_in_bytes\" : 658\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 5412\n },\n \"start_time_in_millis\" : 1750452674327,\n \"time_in_millis\" : 189\n },\n \"indices\" : {\n \"index-1\" : {\n \"shards_stats\" : {\n \"initializing\" : 0,\n \"started\" : 1,\n \"finalizing\" : 0,\n \"done\" : 0,\n \"failed\" : 0,\n \"total\" : 1\n },\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 5412\n },\n \"processed\" : {\n \"file_count\" : 2,\n \"size_in_bytes\" : 658\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 5412\n },\n \"start_time_in_millis\" : 1750452674379,\n \"time_in_millis\" : 0\n },\n \"shards\" : {\n \"0\" : {\n \"stage\" : \"STARTED\",\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 5412\n },\n \"processed\" : {\n \"file_count\" : 2,\n \"size_in_bytes\" : 658\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 5412\n },\n \"start_time_in_millis\" : 1750452674379,\n \"time_in_millis\" : 0\n },\n \"node\" : \"VJzy6aKJSVKwcfjIFBPXxw\"\n }\n }\n },\n \"index-2\" : {\n \"shards_stats\" : {\n \"initializing\" : 0,\n \"started\" : 0,\n \"finalizing\" : 0,\n \"done\" : 1,\n \"failed\" : 0,\n \"total\" : 1\n },\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 0,\n \"size_in_bytes\" : 0\n },\n \"total\" : {\n \"file_count\" : 0,\n \"size_in_bytes\" : 0\n },\n \"start_time_in_millis\" : 0,\n \"time_in_millis\" : 0\n },\n \"shards\" : {\n \"0\" : {\n \"stage\" : \"DONE\",\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : -1,\n \"size_in_bytes\" : -1\n },\n \"total\" : {\n \"file_count\" : -1,\n \"size_in_bytes\" : -1\n },\n \"start_time_in_millis\" : 0,\n \"time_in_millis\" : 0\n },\n \"description\" : \"Snapshot shard stats missing from a currently running snapshot due to a node leaving the cluster after completing the shard snapshot; retry once the snapshot has completed to load all shard stats from the repository.\"\n }\n }\n }\n }\n }\n ]\n}"
}
}
}
}
},
"sql.query-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"columns": {
"description": "Column headings for the search results. Each object is a column.",
"type": "array",
"items": {
"$ref": "#/components/schemas/sql._types.Column"
}
},
"cursor": {
"description": "The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header.",
"type": "string"
},
"id": {
"description": "The identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"is_running": {
"description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.",
"type": "boolean"
},
"is_partial": {
"description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.",
"type": "boolean"
},
"rows": {
"description": "The values for the search results.",
"type": "array",
"items": {
"$ref": "#/components/schemas/sql._types.Row"
}
}
},
"required": [
"rows"
]
}
}
}
},
"sql.translate-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"size": {
"type": "number"
},
"_source": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"query": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"track_total_hits": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.TrackHits"
}
]
}
}
}
}
}
},
"tasks.cancel-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasks._types.TaskListResponseBase"
}
}
}
},
"terms_enum-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_shards": {
"allOf": [
{
"$ref": "#/components/schemas/_types.ShardStatistics"
}
]
},
"terms": {
"type": "array",
"items": {
"type": "string"
}
},
"complete": {
"description": "If `false`, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.",
"type": "boolean"
}
},
"required": [
"_shards",
"terms",
"complete"
]
},
"examples": {
"TermsEnumResponseExample1": {
"description": "A successful response from `POST stackoverflow/_terms_enum`.",
"value": "{\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"terms\": [\n \"kibana\"\n ],\n \"complete\" : true\n}"
}
}
}
}
},
"termvectors-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"found": {
"type": "boolean"
},
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_index": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"term_vectors": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_global.termvectors.TermVector"
}
},
"took": {
"type": "number"
},
"_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"found",
"_index",
"took",
"_version"
]
},
"examples": {
"TermVectorsResponseExample1": {
"summary": "Return stored term vectors",
"description": "A successful response from `GET /my-index-000001/_termvectors/1`.",
"value": "{\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"found\": true,\n \"took\": 6,\n \"term_vectors\": {\n \"text\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 4,\n \"doc_count\": 2,\n \"sum_ttf\": 6\n },\n \"terms\": {\n \"test\": {\n \"doc_freq\": 2,\n \"ttf\": 4,\n \"term_freq\": 3,\n \"tokens\": [\n {\n \"position\": 0,\n \"start_offset\": 0,\n \"end_offset\": 4,\n \"payload\": \"d29yZA==\"\n },\n {\n \"position\": 1,\n \"start_offset\": 5,\n \"end_offset\": 9,\n \"payload\": \"d29yZA==\"\n },\n {\n \"position\": 2,\n \"start_offset\": 10,\n \"end_offset\": 14,\n \"payload\": \"d29yZA==\"\n }\n ]\n }\n }\n }\n }\n}"
},
"TermVectorsResponseExample2": {
"summary": "Per-field analyzer",
"description": "A successful response from `GET /my-index-000001/_termvectors` with `per_field_analyzer` in the request body.",
"value": "{\n \"_index\": \"my-index-000001\",\n \"_version\": 0,\n \"found\": true,\n \"took\": 6,\n \"term_vectors\": {\n \"fullname\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 2,\n \"doc_count\": 4,\n \"sum_ttf\": 4\n },\n \"terms\": {\n \"John Doe\": {\n \"term_freq\": 1,\n \"tokens\": [\n {\n \"position\": 0,\n \"start_offset\": 0,\n \"end_offset\": 8\n }\n ]\n }\n }\n }\n }\n}"
},
"TermVectorsResponseExample3": {
"summary": "Terms filtering",
"description": "A successful response from `GET /my-index-000001/_termvectors` with a `filter` in the request body.",
"value": "{\n \"_index\": \"imdb\",\n \"_version\": 0,\n \"found\": true,\n \"term_vectors\": {\n \"plot\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 3384269,\n \"doc_count\": 176214,\n \"sum_ttf\": 3753460\n },\n \"terms\": {\n \"armored\": {\n \"doc_freq\": 27,\n \"ttf\": 27,\n \"term_freq\": 1,\n \"score\": 9.74725\n },\n \"industrialist\": {\n \"doc_freq\": 88,\n \"ttf\": 88,\n \"term_freq\": 1,\n \"score\": 8.590818\n },\n \"stark\": {\n \"doc_freq\": 44,\n \"ttf\": 47,\n \"term_freq\": 1,\n \"score\": 9.272792\n }\n }\n }\n }\n}"
}
}
}
}
},
"text_structure.find_message_structure-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"charset": {
"type": "string"
},
"ecs_compatibility": {
"allOf": [
{
"$ref": "#/components/schemas/text_structure._types.EcsCompatibilityType"
}
]
},
"field_stats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/text_structure._types.FieldStat"
}
},
"format": {
"allOf": [
{
"$ref": "#/components/schemas/text_structure._types.FormatType"
}
]
},
"grok_pattern": {
"allOf": [
{
"$ref": "#/components/schemas/_types.GrokPattern"
}
]
},
"java_timestamp_formats": {
"type": "array",
"items": {
"type": "string"
}
},
"joda_timestamp_formats": {
"type": "array",
"items": {
"type": "string"
}
},
"ingest_pipeline": {
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.PipelineConfig"
}
]
},
"mappings": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"multiline_start_pattern": {
"type": "string"
},
"need_client_timezone": {
"type": "boolean"
},
"num_lines_analyzed": {
"type": "number"
},
"num_messages_analyzed": {
"type": "number"
},
"sample_start": {
"type": "string"
},
"timestamp_field": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
}
},
"required": [
"charset",
"field_stats",
"format",
"ingest_pipeline",
"mappings",
"need_client_timezone",
"num_lines_analyzed",
"num_messages_analyzed",
"sample_start"
]
},
"examples": {
"FindMessageStructureResponseExample1": {
"description": "A successful response from `POST _text_structure/find_message_structure`.",
"value": "{\n \"num_lines_analyzed\" : 22,\n \"num_messages_analyzed\" : 22,\n \"sample_start\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\\n[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\\n\",\n \"charset\" : \"UTF-8\",\n \"format\" : \"semi_structured_text\",\n \"multiline_start_pattern\" : \"^\\\\[\\\\b\\\\d{4}-\\\\d{2}-\\\\d{2}[T ]\\\\d{2}:\\\\d{2}\",\n \"grok_pattern\" : \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"timestamp\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"loglevel\" : {\n \"type\" : \"keyword\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"grok\" : {\n \"field\" : \"message\",\n \"patterns\" : [\n \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\"\n ],\n \"ecs_compatibility\" : \"disabled\"\n }\n },\n {\n \"date\" : {\n \"field\" : \"timestamp\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n },\n {\n \"remove\" : {\n \"field\" : \"timestamp\"\n }\n }\n ]\n },\n \"field_stats\" : {\n \"loglevel\" : {\n \"count\" : 22,\n \"cardinality\" : 1,\n \"top_hits\" : [\n {\n \"value\" : \"INFO\",\n \"count\" : 22\n }\n ]\n },\n \"message\" : {\n \"count\" : 22,\n \"cardinality\" : 22,\n \"top_hits\" : [\n {\n \"value\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"count\" : 1\n }\n ]\n },\n \"timestamp\" : {\n \"count\" : 22,\n \"cardinality\" : 14,\n \"earliest\" : \"2024-03-05T10:52:36,256\",\n \"latest\" : \"2024-03-05T10:52:49,199\",\n \"top_hits\" : [\n {\n \"value\" : \"2024-03-05T10:52:41,044\",\n \"count\" : 6\n },\n {\n \"value\" : \"2024-03-05T10:52:41,043\",\n \"count\" : 3\n },\n {\n \"value\" : \"2024-03-05T10:52:41,059\",\n \"count\" : 2\n },\n {\n \"value\" : \"2024-03-05T10:52:36,256\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,038\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,042\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:43,291\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:46,098\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,227\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,259\",\n \"count\" : 1\n }\n ]\n }\n }\n}"
}
}
}
}
},
"text_structure.test_grok_pattern-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"matches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/text_structure.test_grok_pattern.MatchedText"
}
}
},
"required": [
"matches"
]
},
"examples": {
"TestGrokPatternResponseExample1": {
"description": "A successful response from `GET _text_structure/test_grok_pattern`.",
"value": "{\n \"matches\": [\n {\n \"matched\": true,\n \"fields\": {\n \"first_name\": [\n {\n \"match\": \"John\",\n \"offset\": 6,\n \"length\": 4\n }\n ],\n \"last_name\": [\n {\n \"match\": \"Doe\",\n \"offset\": 11,\n \"length\": 3\n }\n ]\n }\n },\n {\n \"matched\": false\n }\n ]\n}"
}
}
}
}
},
"transform.get_transform-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"transforms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transform.get_transform.TransformSummary"
}
}
},
"required": [
"count",
"transforms"
]
},
"examples": {
"GetTransformResponseExample1": {
"description": "A successful response that contains configuration information for a transform.",
"value": "{\n \"count\": 1,\n \"transforms\": [\n {\n \"id\": \"ecommerce_transform1\",\n \"authorization\": {\n \"roles\": [\n \"superuser\"\n ]\n },\n \"version\": \"8.4.0\",\n \"create_time\": 1656023416565,\n \"source\": {\n \"index\": [\n \"kibana_sample_data_ecommerce\"\n ],\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\"\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"settings\": {},\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n }\n ]\n}"
}
}
}
}
},
"transform.preview_transform-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"generated_dest_index": {
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexState"
}
]
},
"preview": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"generated_dest_index",
"preview"
]
},
"examples": {
"PreviewTransformResponseExample1": {
"description": "An abbreviated response from `POST _transform/_preview` that contains a preview a transform that uses the pivot method.",
"value": "{\n \"preview\": [\n {\n \"max_price\": 171,\n \"customer_id\": \"10\"\n },\n {\n \"max_price\": 233,\n \"customer_id\": \"11\"\n },\n {\n \"max_price\": 200,\n \"customer_id\": \"12\"\n },\n {\n \"max_price\": 301,\n \"customer_id\": \"13\"\n },\n {\n \"max_price\": 176,\n \"customer_id\": \"14\"\n },\n {\n \"max_price\": 2250,\n \"customer_id\": \"15\"\n },\n {\n \"max_price\": 170,\n \"customer_id\": \"16\"\n },\n {\n \"max_price\": 243,\n \"customer_id\": \"17\"\n },\n {\n \"max_price\": 154,\n \"customer_id\": \"18\"\n },\n {\n \"max_price\": 393,\n \"customer_id\": \"19\"\n },\n {\n \"max_price\": 165,\n \"customer_id\": \"20\"\n },\n {\n \"max_price\": 115,\n \"customer_id\": \"21\"\n },\n {\n \"max_price\": 192,\n \"customer_id\": \"22\"\n },\n {\n \"max_price\": 169,\n \"customer_id\": \"23\"\n },\n {\n \"max_price\": 230,\n \"customer_id\": \"24\"\n },\n {\n \"max_price\": 278,\n \"customer_id\": \"25\"\n },\n {\n \"max_price\": 200,\n \"customer_id\": \"26\"\n },\n {\n \"max_price\": 344,\n \"customer_id\": \"27\"\n },\n {\n \"max_price\": 175,\n \"customer_id\": \"28\"\n },\n {\n \"max_price\": 177,\n \"customer_id\": \"29\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"30\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"31\"\n },\n {\n \"max_price\": 205,\n \"customer_id\": \"32\"\n },\n {\n \"max_price\": 215,\n \"customer_id\": \"33\"\n },\n {\n \"max_price\": 270,\n \"customer_id\": \"34\"\n },\n {\n \"max_price\": 184,\n \"customer_id\": \"36\"\n },\n {\n \"max_price\": 222,\n \"customer_id\": \"37\"\n },\n {\n \"max_price\": 370,\n \"customer_id\": \"38\"\n },\n {\n \"max_price\": 240,\n \"customer_id\": \"39\"\n },\n {\n \"max_price\": 230,\n \"customer_id\": \"4\"\n },\n {\n \"max_price\": 229,\n \"customer_id\": \"41\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"42\"\n },\n {\n \"max_price\": 150,\n \"customer_id\": \"43\"\n },\n {\n \"max_price\": 175,\n \"customer_id\": \"44\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"45\"\n },\n {\n \"max_price\": 150,\n \"customer_id\": \"46\"\n },\n {\n \"max_price\": 310,\n \"customer_id\": \"48\"\n },\n {\n \"max_price\": 223,\n \"customer_id\": \"49\"\n },\n {\n \"max_price\": 283,\n \"customer_id\": \"5\"\n },\n {\n \"max_price\": 185,\n \"customer_id\": \"50\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"51\"\n },\n {\n \"max_price\": 333,\n \"customer_id\": \"52\"\n },\n {\n \"max_price\": 165,\n \"customer_id\": \"6\"\n },\n {\n \"max_price\": 144,\n \"customer_id\": \"7\"\n },\n {\n \"max_price\": 198,\n \"customer_id\": \"8\"\n },\n {\n \"max_price\": 210,\n \"customer_id\": \"9\"\n }\n ],\n \"generated_dest_index\": {\n \"mappings\": {\n \"_meta\": {\n \"_transform\": {\n \"transform\": \"transform-preview\",\n \"version\": {\n \"created\": \"10.0.0\"\n },\n \"creation_date_in_millis\": 1712948905889\n },\n \"created_by\": \"transform\"\n },\n \"properties\": {\n \"max_price\": {\n \"type\": \"half_float\"\n },\n \"customer_id\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"settings\": {\n \"index\": {\n \"number_of_shards\": \"1\",\n \"auto_expand_replicas\": \"0-1\"\n }\n },\n \"aliases\": {}\n }\n}"
}
}
}
}
},
"watcher.ack_watch-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.WatchStatus"
}
]
}
},
"required": [
"status"
]
},
"examples": {
"WatcherAckWatchResponseExample1": {
"description": "A successful response from `POST _watcher/watch/my_watch/_ack`.",
"value": "{\n \"status\": {\n \"state\": {\n \"active\": true,\n \"timestamp\": \"2015-05-26T18:04:27.723Z\"\n },\n \"last_checked\": \"2015-05-26T18:04:27.753Z\",\n \"last_met_condition\": \"2015-05-26T18:04:27.763Z\",\n \"actions\": {\n \"test_index\": {\n \"ack\" : {\n \"timestamp\": \"2015-05-26T18:04:27.713Z\",\n \"state\": \"acked\"\n },\n \"last_execution\" : {\n \"timestamp\": \"2015-05-25T18:04:27.733Z\",\n \"successful\": true\n },\n \"last_successful_execution\" : {\n \"timestamp\": \"2015-05-25T18:04:27.773Z\",\n \"successful\": true\n }\n }\n },\n \"execution_state\": \"executed\",\n \"version\": 2\n }\n}"
}
}
}
}
},
"watcher.activate_watch-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActivationStatus"
}
]
}
},
"required": [
"status"
]
}
}
}
},
"watcher.deactivate_watch-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ActivationStatus"
}
]
}
},
"required": [
"status"
]
}
}
}
},
"watcher.execute_watch-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_id": {
"description": "The watch record identifier as it would be stored in the `.watcher-history` index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"watch_record": {
"description": "The watch record document as it would be stored in the `.watcher-history` index.",
"allOf": [
{
"$ref": "#/components/schemas/watcher.execute_watch.WatchRecord"
}
]
}
},
"required": [
"_id",
"watch_record"
]
},
"examples": {
"WatcherExecuteWatchResponseExample1": {
"description": "A successful response from `POST _watcher/watch/my_watch/_execute`.\n",
"value": "{\n \"_id\": \"my_watch_0-2015-06-02T23:17:55.124Z\", \n \"watch_record\": { \n \"@timestamp\": \"2015-06-02T23:17:55.124Z\",\n \"watch_id\": \"my_watch\",\n \"node\": \"my_node\",\n \"messages\": [],\n \"trigger_event\": {\n \"type\": \"manual\",\n \"triggered_time\": \"2015-06-02T23:17:55.124Z\",\n \"manual\": {\n \"schedule\": {\n \"scheduled_time\": \"2015-06-02T23:17:55.124Z\"\n }\n }\n },\n \"state\": \"executed\",\n \"status\": {\n \"version\": 1,\n \"execution_state\": \"executed\",\n \"state\": {\n \"active\": true,\n \"timestamp\": \"2015-06-02T23:17:55.111Z\"\n },\n \"last_checked\": \"2015-06-02T23:17:55.124Z\",\n \"last_met_condition\": \"2015-06-02T23:17:55.124Z\",\n \"actions\": {\n \"test_index\": {\n \"ack\": {\n \"timestamp\": \"2015-06-02T23:17:55.124Z\",\n \"state\": \"ackable\"\n },\n \"last_execution\": {\n \"timestamp\": \"2015-06-02T23:17:55.124Z\",\n \"successful\": true\n },\n \"last_successful_execution\": {\n \"timestamp\": \"2015-06-02T23:17:55.124Z\",\n \"successful\": true\n }\n }\n }\n },\n \"input\": {\n \"simple\": {\n \"payload\": {\n \"send\": \"yes\"\n }\n }\n },\n \"condition\": {\n \"always\": {}\n },\n \"result\": { \n \"execution_time\": \"2015-06-02T23:17:55.124Z\",\n \"execution_duration\": 12608,\n \"input\": {\n \"type\": \"simple\",\n \"payload\": {\n \"foo\": \"bar\"\n },\n \"status\": \"success\"\n },\n \"condition\": {\n \"type\": \"always\",\n \"met\": true,\n \"status\": \"success\"\n },\n \"actions\": [\n {\n \"id\": \"test_index\",\n \"index\": {\n \"response\": {\n \"index\": \"test\",\n \"version\": 1,\n \"created\": true,\n \"result\": \"created\",\n \"id\": \"AVSHKzPa9zx62AzUzFXY\"\n }\n },\n \"status\": \"success\",\n \"type\": \"index\"\n }\n ]\n },\n \"user\": \"test_admin\" \n }\n}"
}
}
}
}
},
"watcher.put_watch-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"created": {
"type": "boolean"
},
"_id": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"_primary_term": {
"type": "number"
},
"_seq_no": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SequenceNumber"
}
]
},
"_version": {
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
},
"required": [
"created",
"_id",
"_primary_term",
"_seq_no",
"_version"
]
}
}
}
},
"watcher.query_watches-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"description": "The total number of watches found.",
"type": "number"
},
"watches": {
"description": "A list of watches based on the `from`, `size`, or `search_after` request body parameters.",
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher._types.QueryWatch"
}
}
},
"required": [
"count",
"watches"
]
},
"examples": {
"WatcherQueryWatchesResponseExample1": {
"description": "A successful response from `GET /_watcher/_query/watches`.",
"value": "{\n \"count\": 1,\n \"watches\": [\n {\n \"_id\": \"my_watch\",\n \"watch\": {\n \"trigger\": {\n \"schedule\": {\n \"hourly\": {\n \"minute\": [\n 0,\n 5\n ]\n }\n }\n },\n \"input\": {\n \"simple\": {\n \"payload\": {\n \"send\": \"yes\"\n }\n }\n },\n \"condition\": {\n \"always\": {}\n },\n \"actions\": {\n \"test_index\": {\n \"index\": {\n \"index\": \"test\"\n }\n }\n }\n },\n \"status\": {\n \"state\": {\n \"active\": true,\n \"timestamp\": \"2015-05-26T18:21:08.630Z\"\n },\n \"actions\": {\n \"test_index\": {\n \"ack\": {\n \"timestamp\": \"2015-05-26T18:21:08.630Z\",\n \"state\": \"awaits_successful_execution\"\n }\n }\n },\n \"version\": -1\n },\n \"_seq_no\": 0,\n \"_primary_term\": 1\n }\n ]\n}"
}
}
}
}
},
"watcher.stats-200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_nodes": {
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeStatistics"
}
]
},
"cluster_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"manually_stopped": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher.stats.WatcherNodeStats"
}
}
},
"required": [
"_nodes",
"cluster_name",
"manually_stopped",
"stats"
]
},
"examples": {
"WatcherStatsResponseExample1": {
"summary": "Basic metrics",
"description": "A successful response from `GET _watcher/stats`.",
"value": "{\n \"watcher_state\": \"started\", \n \"watch_count\": 1, \n \"execution_thread_pool\": {\n \"size\": 1000, \n \"max_size\": 1 \n }\n}"
},
"WatcherStatsResponseExample2": {
"summary": "Current watch metrics",
"description": "A successful response from `GET _watcher/stats?metric=current_watches`.",
"value": "{\n \"watcher_state\": \"started\",\n \"watch_count\": 2,\n \"execution_thread_pool\": {\n \"queue_size\": 1000,\n \"max_size\": 20\n },\n \"current_watches\": [ \n {\n \"watch_id\": \"slow_condition\", \n \"watch_record_id\": \"slow_condition_3-2015-05-13T07:42:32.179Z\", \n \"triggered_time\": \"2015-05-12T11:53:51.800Z\", \n \"execution_time\": \"2015-05-13T07:42:32.179Z\", \n \"execution_phase\": \"condition\" \n }\n ]\n}"
},
"WatcherStatsResponseExample3": {
"summary": "Queued watch metrics",
"description": "An abbreviated response from `GET _watcher/stats/queued_watches`.",
"value": "{\n \"watcher_state\": \"started\",\n \"watch_count\": 10,\n \"execution_thread_pool\": {\n \"queue_size\": 1000,\n \"max_size\": 20\n },\n \"queued_watches\": [ \n {\n \"watch_id\": \"slow_condition4\", \n \"watch_record_id\": \"slow_condition4_223-2015-05-21T11:59:59.811Z\", \n \"triggered_time\": \"2015-05-21T11:59:59.811Z\", \n \"execution_time\": \"2015-05-21T11:59:59.811Z\" \n }\n ]\n}"
}
}
}
}
}
},
"parameters": {
"async_search.submit-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"async_search.submit-wait_for_completion_timeout": {
"in": "query",
"name": "wait_for_completion_timeout",
"description": "Blocks and waits until the search is completed up to a certain timeout.\nWhen the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"async_search.submit-keep_alive": {
"in": "query",
"name": "keep_alive",
"description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"async_search.submit-keep_on_completion": {
"in": "query",
"name": "keep_on_completion",
"description": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-allow_partial_search_results": {
"in": "query",
"name": "allow_partial_search_results",
"description": "Indicate if an error should be returned if there is a partial search failure or timeout",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-analyzer": {
"in": "query",
"name": "analyzer",
"description": "The analyzer to use for the query string",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"async_search.submit-analyze_wildcard": {
"in": "query",
"name": "analyze_wildcard",
"description": "Specify whether wildcard and prefix queries should be analyzed",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-batched_reduce_size": {
"in": "query",
"name": "batched_reduce_size",
"description": "Affects how often partial results become available, which happens whenever shard results are reduced.\nA partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"async_search.submit-ccs_minimize_roundtrips": {
"in": "query",
"name": "ccs_minimize_roundtrips",
"description": "The default value is the only supported value.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-default_operator": {
"in": "query",
"name": "default_operator",
"description": "The default operator for query string query (AND or OR)",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.query_dsl.Operator"
},
"style": "form"
},
"async_search.submit-df": {
"in": "query",
"name": "df",
"description": "The field to use as default where no field prefix is given in the query string",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"async_search.submit-docvalue_fields": {
"in": "query",
"name": "docvalue_fields",
"description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"async_search.submit-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both\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"
},
"async_search.submit-explain": {
"in": "query",
"name": "explain",
"description": "Specify whether to return detailed information about score computation as part of a hit",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-ignore_throttled": {
"in": "query",
"name": "ignore_throttled",
"description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-lenient": {
"in": "query",
"name": "lenient",
"description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-max_concurrent_shard_requests": {
"in": "query",
"name": "max_concurrent_shard_requests",
"description": "The number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"async_search.submit-preference": {
"in": "query",
"name": "preference",
"description": "Specify the node or shard the operation should be performed on",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"async_search.submit-request_cache": {
"in": "query",
"name": "request_cache",
"description": "Specify if request cache should be used for this request or not, defaults to true",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-routing": {
"in": "query",
"name": "routing",
"description": "A comma-separated list of specific routing values",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"async_search.submit-search_type": {
"in": "query",
"name": "search_type",
"description": "Search operation type\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
"async_search.submit-stats": {
"in": "query",
"name": "stats",
"description": "Specific 'tag' of the request for logging and statistical purposes",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
"async_search.submit-stored_fields": {
"in": "query",
"name": "stored_fields",
"description": "A comma-separated list of stored fields to return as part of a hit",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"async_search.submit-suggest_field": {
"in": "query",
"name": "suggest_field",
"description": "Specifies which field to use for suggestions.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
"async_search.submit-suggest_mode": {
"in": "query",
"name": "suggest_mode",
"description": "Specify suggest mode\n\nSupported values include:\n - `missing`: Only generate suggestions for terms that are not in the shard.\n - `popular`: Only suggest terms that occur in more docs on the shard than the original term.\n - `always`: Suggest any matching suggestions based on terms in the suggest text.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SuggestMode"
},
"style": "form"
},
"async_search.submit-suggest_size": {
"in": "query",
"name": "suggest_size",
"description": "How many suggestions to return in response",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"async_search.submit-suggest_text": {
"in": "query",
"name": "suggest_text",
"description": "The source text for which the suggestions should be returned.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"async_search.submit-terminate_after": {
"in": "query",
"name": "terminate_after",
"description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"async_search.submit-timeout": {
"in": "query",
"name": "timeout",
"description": "Explicit operation timeout",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"async_search.submit-track_total_hits": {
"in": "query",
"name": "track_total_hits",
"description": "Indicate if the number of documents that match the query should be tracked.\nA number can also be specified, to accurately track the total hit count up to the number.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.TrackHits"
},
"style": "form"
},
"async_search.submit-track_scores": {
"in": "query",
"name": "track_scores",
"description": "Whether to calculate and return scores even if they are not used for sorting",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-version": {
"in": "query",
"name": "version",
"description": "Specify whether to return document version as part of a hit",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-_source": {
"in": "query",
"name": "_source",
"description": "True or false to return the _source field or not, or a list of fields to return",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
},
"style": "form"
},
"async_search.submit-_source_excludes": {
"in": "query",
"name": "_source_excludes",
"description": "A list of fields to exclude from the returned _source field",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"async_search.submit-_source_includes": {
"in": "query",
"name": "_source_includes",
"description": "A list of fields to extract and return from the _source field",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"async_search.submit-seq_no_primary_term": {
"in": "query",
"name": "seq_no_primary_term",
"description": "Specify whether to return sequence number and primary term of the last modification of each hit",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"async_search.submit-q": {
"in": "query",
"name": "q",
"description": "Query in the Lucene query string syntax",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"async_search.submit-size": {
"in": "query",
"name": "size",
"description": "Number of hits to return",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"async_search.submit-from": {
"in": "query",
"name": "from",
"description": "Starting offset",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"async_search.submit-sort": {
"in": "query",
"name": "sort",
"description": "A comma-separated list of : pairs",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"bulk-index": {
"in": "path",
"name": "index",
"description": "The name of the data stream, index, or index alias to perform bulk actions on.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"bulk-include_source_on_error": {
"in": "query",
"name": "include_source_on_error",
"description": "True or false if to include the document source in the error message in case of parsing errors.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"bulk-list_executed_pipelines": {
"in": "query",
"name": "list_executed_pipelines",
"description": "If `true`, the response will include the ingest pipelines that were run for each index or create.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"bulk-pipeline": {
"in": "query",
"name": "pipeline",
"description": "The pipeline identifier to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"bulk-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, wait for a refresh to make this operation visible to search.\nIf `false`, do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"bulk-routing": {
"in": "query",
"name": "routing",
"description": "A custom value that is used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"bulk-_source": {
"in": "query",
"name": "_source",
"description": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
},
"style": "form"
},
"bulk-_source_excludes": {
"in": "query",
"name": "_source_excludes",
"description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"bulk-_source_includes": {
"in": "query",
"name": "_source_includes",
"description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"bulk-timeout": {
"in": "query",
"name": "timeout",
"description": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.\nThe default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"bulk-wait_for_active_shards": {
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default is `1`, which waits for each primary shard to be active.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
"bulk-require_alias": {
"in": "query",
"name": "require_alias",
"description": "If `true`, the request's actions must target an index alias.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"bulk-require_data_stream": {
"in": "query",
"name": "require_data_stream",
"description": "If `true`, the request's actions must target a data stream (existing or to be created).",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.aliases-name": {
"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"
},
"cat.aliases-h": {
"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"
},
"cat.aliases-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.aliases-expand_wildcards": {
"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"
},
"cat.aliases-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicated that the request should never timeout, you can set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"cat.allocation-node_id": {
"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"
},
"cat.allocation-h": {
"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"
},
"cat.allocation-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.allocation-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.allocation-master_timeout": {
"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"
},
"cat.circuit_breaker-circuit_breaker_patterns": {
"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"
},
"cat.circuit_breaker-h": {
"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"
},
"cat.circuit_breaker-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.circuit_breaker-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.circuit_breaker-master_timeout": {
"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"
},
"cat.component_templates-name": {
"in": "path",
"name": "name",
"description": "The name of the component template.\nIt accepts wildcard expressions.\nIf it is omitted, all component templates are returned.",
"required": true,
"deprecated": false,
"schema": {
"type": "string"
},
"style": "simple"
},
"cat.component_templates-h": {
"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"
},
"cat.component_templates-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.component_templates-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.component_templates-master_timeout": {
"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"
},
"cat.count-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nIt supports wildcards (`*`).\nTo 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"
},
"cat.count-h": {
"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"
},
"cat.count-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.fielddata-fields": {
"in": "path",
"name": "fields",
"description": "Comma-separated list of fields used to limit returned information.\nTo retrieve all fields, omit this parameter.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "simple"
},
"cat.fielddata-fields_": {
"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"
},
"cat.fielddata-h": {
"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"
},
"cat.fielddata-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.indices-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports 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"
},
"cat.indices-expand_wildcards": {
"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"
},
"cat.indices-health": {
"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"
},
"cat.indices-include_unloaded_segments": {
"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"
},
"cat.indices-pri": {
"in": "query",
"name": "pri",
"description": "If true, the response only includes information from primary shards.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.indices-master_timeout": {
"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"
},
"cat.indices-h": {
"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"
},
"cat.indices-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.ml_data_frame_analytics-id": {
"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"
},
"cat.ml_data_frame_analytics-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Whether to ignore if a wildcard expression matches no configs.\n(This includes `_all` string or when no configs have been specified.)",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.ml_data_frame_analytics-h": {
"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"
},
"cat.ml_data_frame_analytics-s": {
"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"
},
"cat.ml_datafeeds-datafeed_id": {
"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"
},
"cat.ml_datafeeds-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.ml_datafeeds-h": {
"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"
},
"cat.ml_datafeeds-s": {
"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"
},
"cat.ml_jobs-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"cat.ml_jobs-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no jobs that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty jobs array when there are no matches and the subset of results when there\nare partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial\nmatches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.ml_jobs-h": {
"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"
},
"cat.ml_jobs-s": {
"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"
},
"cat.ml_trained_models-model_id": {
"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"
},
"cat.ml_trained_models-allow_no_match": {
"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.\nIf `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the API returns a 404 status code when there are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.ml_trained_models-h": {
"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"
},
"cat.ml_trained_models-s": {
"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"
},
"cat.ml_trained_models-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of transforms.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"cat.ml_trained_models-size": {
"in": "query",
"name": "size",
"description": "The maximum number of transforms to display.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"cat.recovery-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports 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"
},
"cat.recovery-active_only": {
"in": "query",
"name": "active_only",
"description": "If `true`, the response only includes ongoing shard recoveries.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.recovery-detailed": {
"in": "query",
"name": "detailed",
"description": "If `true`, the response includes detailed information about shard recoveries.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.recovery-index_": {
"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"
},
"cat.recovery-h": {
"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"
},
"cat.recovery-s": {
"in": "query",
"name": "s",
"description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.segments-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"cat.segments-h": {
"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"
},
"cat.segments-s": {
"in": "query",
"name": "s",
"description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.segments-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.segments-master_timeout": {
"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"
},
"cat.segments-expand_wildcards": {
"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"
},
"cat.segments-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.segments-ignore_throttled": {
"in": "query",
"name": "ignore_throttled",
"description": "If true, concrete, expanded or aliased indices are ignored when frozen.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.segments-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.segments-allow_closed": {
"in": "query",
"name": "allow_closed",
"description": "If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour\nof throwing an exception if index pattern matches closed indices",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.shards-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"cat.shards-h": {
"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"
},
"cat.shards-s": {
"in": "query",
"name": "s",
"description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.shards-master_timeout": {
"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"
},
"cat.snapshots-repository": {
"in": "path",
"name": "repository",
"description": "A comma-separated list of snapshot repositories used to limit the request.\nAccepts wildcard expressions.\n`_all` returns all repositories.\nIf any repository fails during the request, Elasticsearch returns an error.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"cat.snapshots-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `true`, the response does not include information from unavailable snapshots.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.snapshots-h": {
"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"
},
"cat.snapshots-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.snapshots-master_timeout": {
"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"
},
"cat.templates-name": {
"in": "path",
"name": "name",
"description": "The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"cat.templates-h": {
"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"
},
"cat.templates-s": {
"in": "query",
"name": "s",
"description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.templates-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.templates-master_timeout": {
"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"
},
"cat.thread_pool-thread_pool_patterns": {
"in": "path",
"name": "thread_pool_patterns",
"description": "A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"cat.thread_pool-h": {
"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"
},
"cat.thread_pool-s": {
"in": "query",
"name": "s",
"description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "form"
},
"cat.thread_pool-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.thread_pool-master_timeout": {
"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"
},
"cat.transforms-transform_id": {
"in": "path",
"name": "transform_id",
"description": "A transform identifier or a wildcard expression.\nIf 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"
},
"cat.transforms-allow_no_match": {
"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.\nIf `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cat.transforms-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of transforms.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"cat.transforms-h": {
"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"
},
"cat.transforms-s": {
"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"
},
"cat.transforms-size": {
"in": "query",
"name": "size",
"description": "The maximum number of transforms to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ccr.get_auto_follow_pattern-name": {
"in": "path",
"name": "name",
"description": "The auto-follow pattern collection that you want to retrieve.\nIf you do not specify a name, the API returns information for all collections.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"ccr.get_auto_follow_pattern-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"clear_scroll-scroll_id": {
"in": "path",
"name": "scroll_id",
"description": "A comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.\nIMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.",
"required": true,
"deprecated": true,
"schema": {
"$ref": "#/components/schemas/_types.ScrollIds"
},
"style": "simple"
},
"cluster.allocation_explain-index": {
"in": "query",
"name": "index",
"description": "The name of the index that you would like an explanation for.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "form"
},
"cluster.allocation_explain-shard": {
"in": "query",
"name": "shard",
"description": "An identifier for the shard that you would like an explanation for.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"cluster.allocation_explain-primary": {
"in": "query",
"name": "primary",
"description": "If true, returns an explanation for the primary shard for the specified shard ID.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cluster.allocation_explain-current_node": {
"in": "query",
"name": "current_node",
"description": "Explain a shard only if it is currently located on the specified node name or node ID.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeId"
},
"style": "form"
},
"cluster.allocation_explain-include_disk_info": {
"in": "query",
"name": "include_disk_info",
"description": "If true, returns information about disk usage and shard sizes.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cluster.allocation_explain-include_yes_decisions": {
"in": "query",
"name": "include_yes_decisions",
"description": "If true, returns YES decisions in explanation.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cluster.allocation_explain-master_timeout": {
"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"
},
"cluster.get_component_template-name": {
"in": "path",
"name": "name",
"description": "Name of component template to retrieve. Wildcard (`*`) expressions are supported.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"cluster.get_component_template-flat_settings": {
"in": "query",
"name": "flat_settings",
"description": "If `true`, returns settings in flat format.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cluster.get_component_template-settings_filter": {
"in": "query",
"name": "settings_filter",
"description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"cluster.get_component_template-include_defaults": {
"in": "query",
"name": "include_defaults",
"description": "Return all default configurations for the component template",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.11.0",
"style": "form"
},
"cluster.get_component_template-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cluster.get_component_template-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"cluster.health-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and index aliases that limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use _all or `*`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"cluster.health-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Expand wildcard expression to concrete indices that are open, closed or both.\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"
},
"cluster.health-level": {
"in": "query",
"name": "level",
"description": "Return health information at a specific level of detail.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Level"
},
"style": "form"
},
"cluster.health-local": {
"in": "query",
"name": "local",
"description": "If true, retrieve information from the local node only.\nIf false, retrieve information from the master node.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"cluster.health-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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"
},
"cluster.health-timeout": {
"in": "query",
"name": "timeout",
"description": "The period to wait for a response.\nIf 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"
},
"cluster.health-wait_for_active_shards": {
"in": "query",
"name": "wait_for_active_shards",
"description": "Wait for the specified number of active shards.\nUse `all` to wait for all shards in the cluster to be active.\nUse `0` to not wait.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
"cluster.health-wait_for_events": {
"in": "query",
"name": "wait_for_events",
"description": "Wait until all currently queued events with the given priority are processed.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForEvents"
},
"style": "form"
},
"cluster.health-wait_for_nodes": {
"in": "query",
"name": "wait_for_nodes",
"description": "Wait until the specified number (N) of nodes is available.\nIt also accepts `>=N`, `<=N`, `>N` and `/_doc/` request format.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"create-index": {
"in": "path",
"name": "index",
"description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn’t match a data stream template, this request creates the index.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"create-include_source_on_error": {
"in": "query",
"name": "include_source_on_error",
"description": "True or false if to include the document source in the error message in case of parsing errors.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"create-pipeline": {
"in": "query",
"name": "pipeline",
"description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"create-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"create-require_alias": {
"in": "query",
"name": "require_alias",
"description": "If `true`, the destination must be an index alias.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"create-require_data_stream": {
"in": "query",
"name": "require_data_stream",
"description": "If `true`, the request's actions must target a data stream (existing or to be created).",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"create-routing": {
"in": "query",
"name": "routing",
"description": "A custom value that is used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"create-timeout": {
"in": "query",
"name": "timeout",
"description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\nElasticsearch waits for at least the specified timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"create-version": {
"in": "query",
"name": "version",
"description": "The explicit version number for concurrency control.\nIt must be a non-negative long number.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionNumber"
},
"style": "form"
},
"create-version_type": {
"in": "query",
"name": "version_type",
"description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionType"
},
"style": "form"
},
"create-wait_for_active_shards": {
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of shard copies that must be active before proceeding with the operation.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
"enrich.get_policy-name": {
"in": "path",
"name": "name",
"description": "Comma-separated list of enrich policy names used to limit the request.\nTo return information for all enrich policies, omit this parameter.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"enrich.get_policy-master_timeout": {
"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"
},
"eql.search-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of index names to scope the operation",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"eql.search-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"eql.search-allow_partial_search_results": {
"in": "query",
"name": "allow_partial_search_results",
"description": "If true, returns partial results if there are shard failures. If false, returns an error with no partial results.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"eql.search-allow_partial_sequence_results": {
"in": "query",
"name": "allow_partial_sequence_results",
"description": "If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.\nThis flag has effect only if allow_partial_search_results is true.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"eql.search-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.\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"
},
"eql.search-ccs_minimize_roundtrips": {
"in": "query",
"name": "ccs_minimize_roundtrips",
"description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"eql.search-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"eql.search-keep_alive": {
"in": "query",
"name": "keep_alive",
"description": "Period for which the search and its results are stored on the cluster.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"eql.search-keep_on_completion": {
"in": "query",
"name": "keep_on_completion",
"description": "If true, the search and its results are stored on the cluster.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"eql.search-wait_for_completion_timeout": {
"in": "query",
"name": "wait_for_completion_timeout",
"description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"esql.get_view-name": {
"in": "path",
"name": "name",
"description": "The comma-separated view names to retrieve.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"explain-id": {
"in": "path",
"name": "id",
"description": "The document identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"explain-index": {
"in": "path",
"name": "index",
"description": "Index names that are used to limit the request.\nOnly a single index name can be provided to this parameter.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"explain-analyzer": {
"in": "query",
"name": "analyzer",
"description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"explain-analyze_wildcard": {
"in": "query",
"name": "analyze_wildcard",
"description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"explain-default_operator": {
"in": "query",
"name": "default_operator",
"description": "The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.query_dsl.Operator"
},
"style": "form"
},
"explain-df": {
"in": "query",
"name": "df",
"description": "The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"explain-lenient": {
"in": "query",
"name": "lenient",
"description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"explain-preference": {
"in": "query",
"name": "preference",
"description": "The node or shard the operation should be performed on.\nIt is random by default.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"explain-routing": {
"in": "query",
"name": "routing",
"description": "A custom value used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"explain-_source": {
"in": "query",
"name": "_source",
"description": "`True` or `false` to return the `_source` field or not or a list of fields to return.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
},
"style": "form"
},
"explain-_source_excludes": {
"in": "query",
"name": "_source_excludes",
"description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"explain-_source_includes": {
"in": "query",
"name": "_source_includes",
"description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"explain-stored_fields": {
"in": "query",
"name": "stored_fields",
"description": "A comma-separated list of stored fields to return in the response.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"explain-q": {
"in": "query",
"name": "q",
"description": "The query in the Lucene query string syntax.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"field_caps-index": {
"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"
},
"field_caps-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"field_caps-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. 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"
},
"field_caps-fields": {
"in": "query",
"name": "fields",
"description": "A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"field_caps-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"field_caps-include_unmapped": {
"in": "query",
"name": "include_unmapped",
"description": "If true, unmapped fields are included in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"field_caps-filters": {
"in": "query",
"name": "filters",
"description": "A comma-separated list of filters to apply to the response.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"x-state": "Generally available; Added in 8.2.0",
"style": "form"
},
"field_caps-types": {
"in": "query",
"name": "types",
"description": "A comma-separated list of field types to include.\nAny fields that do not match one of these types will be excluded from the results.\nIt defaults to empty, meaning that all field types are returned.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"x-state": "Generally available; Added in 8.2.0",
"style": "form"
},
"field_caps-include_empty_fields": {
"in": "query",
"name": "include_empty_fields",
"description": "If false, empty fields are not included in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.13.0",
"style": "form"
},
"fleet.msearch-index": {
"in": "path",
"name": "index",
"description": "A single target to search. If the target is an index alias, it must resolve to a single index.",
"required": true,
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"$ref": "#/components/schemas/_types.IndexAlias"
}
]
},
"style": "simple"
},
"fleet.msearch-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.msearch-ccs_minimize_roundtrips": {
"in": "query",
"name": "ccs_minimize_roundtrips",
"description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.msearch-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\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"
},
"fleet.msearch-ignore_throttled": {
"in": "query",
"name": "ignore_throttled",
"description": "If true, concrete, expanded or aliased indices are ignored when frozen.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.msearch-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.msearch-max_concurrent_searches": {
"in": "query",
"name": "max_concurrent_searches",
"description": "Maximum number of concurrent searches the multi search API can execute.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.msearch-max_concurrent_shard_requests": {
"in": "query",
"name": "max_concurrent_shard_requests",
"description": "Maximum number of concurrent shard requests that each sub-search request executes per node.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.msearch-pre_filter_shard_size": {
"in": "query",
"name": "pre_filter_shard_size",
"description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.msearch-search_type": {
"in": "query",
"name": "search_type",
"description": "Indicates whether global term and document frequencies should be used when scoring returned documents.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
"fleet.msearch-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.msearch-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.msearch-wait_for_checkpoints": {
"in": "query",
"name": "wait_for_checkpoints",
"description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fleet._types.Checkpoint"
}
},
"style": "form"
},
"fleet.msearch-allow_partial_search_results": {
"in": "query",
"name": "allow_partial_search_results",
"description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-index": {
"in": "path",
"name": "index",
"description": "A single target to search. If the target is an index alias, it must resolve to a single index.",
"required": true,
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
},
{
"$ref": "#/components/schemas/_types.IndexAlias"
}
]
},
"style": "simple"
},
"fleet.search-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-analyzer": {
"in": "query",
"name": "analyzer",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"fleet.search-analyze_wildcard": {
"in": "query",
"name": "analyze_wildcard",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-batched_reduce_size": {
"in": "query",
"name": "batched_reduce_size",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.search-ccs_minimize_roundtrips": {
"in": "query",
"name": "ccs_minimize_roundtrips",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-default_operator": {
"in": "query",
"name": "default_operator",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.query_dsl.Operator"
},
"style": "form"
},
"fleet.search-df": {
"in": "query",
"name": "df",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"fleet.search-docvalue_fields": {
"in": "query",
"name": "docvalue_fields",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"fleet.search-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "\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"
},
"fleet.search-explain": {
"in": "query",
"name": "explain",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-ignore_throttled": {
"in": "query",
"name": "ignore_throttled",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-lenient": {
"in": "query",
"name": "lenient",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-max_concurrent_shard_requests": {
"in": "query",
"name": "max_concurrent_shard_requests",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.search-preference": {
"in": "query",
"name": "preference",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"fleet.search-pre_filter_shard_size": {
"in": "query",
"name": "pre_filter_shard_size",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.search-request_cache": {
"in": "query",
"name": "request_cache",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-routing": {
"in": "query",
"name": "routing",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"fleet.search-scroll": {
"in": "query",
"name": "scroll",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"fleet.search-search_type": {
"in": "query",
"name": "search_type",
"description": "\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
"fleet.search-stats": {
"in": "query",
"name": "stats",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
"fleet.search-stored_fields": {
"in": "query",
"name": "stored_fields",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"fleet.search-suggest_field": {
"in": "query",
"name": "suggest_field",
"description": "Specifies which field to use for suggestions.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
"fleet.search-suggest_mode": {
"in": "query",
"name": "suggest_mode",
"description": "\n\nSupported values include:\n - `missing`: Only generate suggestions for terms that are not in the shard.\n - `popular`: Only suggest terms that occur in more docs on the shard than the original term.\n - `always`: Suggest any matching suggestions based on terms in the suggest text.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SuggestMode"
},
"style": "form"
},
"fleet.search-suggest_size": {
"in": "query",
"name": "suggest_size",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.search-suggest_text": {
"in": "query",
"name": "suggest_text",
"description": "The source text for which the suggestions should be returned.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"fleet.search-terminate_after": {
"in": "query",
"name": "terminate_after",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.search-timeout": {
"in": "query",
"name": "timeout",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"fleet.search-track_total_hits": {
"in": "query",
"name": "track_total_hits",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.TrackHits"
},
"style": "form"
},
"fleet.search-track_scores": {
"in": "query",
"name": "track_scores",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-typed_keys": {
"in": "query",
"name": "typed_keys",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-version": {
"in": "query",
"name": "version",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-_source": {
"in": "query",
"name": "_source",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
},
"style": "form"
},
"fleet.search-_source_excludes": {
"in": "query",
"name": "_source_excludes",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"fleet.search-_source_includes": {
"in": "query",
"name": "_source_includes",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"fleet.search-seq_no_primary_term": {
"in": "query",
"name": "seq_no_primary_term",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"fleet.search-q": {
"in": "query",
"name": "q",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"fleet.search-size": {
"in": "query",
"name": "size",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.search-from": {
"in": "query",
"name": "from",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"fleet.search-sort": {
"in": "query",
"name": "sort",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"fleet.search-wait_for_checkpoints": {
"in": "query",
"name": "wait_for_checkpoints",
"description": "A comma separated list of checkpoints. When configured, the search API will only be executed on a shard\nafter the relevant checkpoint has become visible for search. Defaults to an empty list which will cause\nElasticsearch to immediately execute the search.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fleet._types.Checkpoint"
}
},
"style": "form"
},
"fleet.search-allow_partial_search_results": {
"in": "query",
"name": "allow_partial_search_results",
"description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"graph.explore-index": {
"in": "path",
"name": "index",
"description": "Name of the index.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"graph.explore-routing": {
"in": "query",
"name": "routing",
"description": "Custom value used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"graph.explore-timeout": {
"in": "query",
"name": "timeout",
"description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"health_report-feature": {
"in": "path",
"name": "feature",
"description": "A feature of the cluster, as returned by the top-level health report API.",
"required": true,
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "simple"
},
"health_report-timeout": {
"in": "query",
"name": "timeout",
"description": "Explicit operation timeout.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"health_report-verbose": {
"in": "query",
"name": "verbose",
"description": "Opt-in for more information about the health of the system.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"health_report-size": {
"in": "query",
"name": "size",
"description": "Limit the number of affected resources the health report API returns.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ilm.get_lifecycle-policy": {
"in": "path",
"name": "policy",
"description": "Identifier for the policy.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"ilm.get_lifecycle-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. 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"
},
"ilm.get_lifecycle-timeout": {
"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"
},
"index-id": {
"in": "path",
"name": "id",
"description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"index-index": {
"in": "path",
"name": "index",
"description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn't match a data stream template, this request creates the index.\nYou can check for existing targets with the resolve index API.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"index-if_primary_term": {
"in": "query",
"name": "if_primary_term",
"description": "Only perform the operation if the document has this primary term.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"index-if_seq_no": {
"in": "query",
"name": "if_seq_no",
"description": "Only perform the operation if the document has this sequence number.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SequenceNumber"
},
"style": "form"
},
"index-include_source_on_error": {
"in": "query",
"name": "include_source_on_error",
"description": "True or false if to include the document source in the error message in case of parsing errors.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"index-op_type": {
"in": "query",
"name": "op_type",
"description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.\n\nSupported values include:\n - `index`: Overwrite any documents that already exist.\n - `create`: Only index documents that do not already exist.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.OpType"
},
"style": "form"
},
"index-pipeline": {
"in": "query",
"name": "pipeline",
"description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"index-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"index-routing": {
"in": "query",
"name": "routing",
"description": "A custom value that is used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"index-timeout": {
"in": "query",
"name": "timeout",
"description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"index-version": {
"in": "query",
"name": "version",
"description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionNumber"
},
"style": "form"
},
"index-version_type": {
"in": "query",
"name": "version_type",
"description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionType"
},
"style": "form"
},
"index-wait_for_active_shards": {
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of shard copies that must be active before proceeding with the operation.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
"index-require_alias": {
"in": "query",
"name": "require_alias",
"description": "If `true`, the destination must be an index alias.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"index-require_data_stream": {
"in": "query",
"name": "require_data_stream",
"description": "If `true`, the request's actions must target a data stream (existing or to be created).",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.analyze-index": {
"in": "path",
"name": "index",
"description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.analyze-index_": {
"in": "query",
"name": "index",
"description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "form"
},
"indices.clear_cache-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"indices.clear_cache-index_": {
"in": "query",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "form"
},
"indices.clear_cache-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.clear_cache-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.clear_cache-fielddata": {
"in": "query",
"name": "fielddata",
"description": "If `true`, clears the fields cache.\nUse the `fields` parameter to clear the cache of specific fields only.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.clear_cache-fields": {
"in": "query",
"name": "fields",
"description": "Comma-separated list of field names used to limit the `fielddata` parameter.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"indices.clear_cache-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.clear_cache-query": {
"in": "query",
"name": "query",
"description": "If `true`, clears the query cache.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.clear_cache-request": {
"in": "query",
"name": "request",
"description": "If `true`, clears the request cache.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.clone-index": {
"in": "path",
"name": "index",
"description": "Name of the source index to clone.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.clone-target": {
"in": "path",
"name": "target",
"description": "Name of the target index to create.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"indices.clone-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.clone-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"indices.clone-wait_for_active_shards": {
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
"indices.create_from-source": {
"in": "path",
"name": "source",
"description": "The source index or data stream name",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.create_from-dest": {
"in": "path",
"name": "dest",
"description": "The destination index or data stream name",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.data_streams_stats-name": {
"in": "path",
"name": "name",
"description": "Comma-separated list of data streams used to limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams in a cluster, omit this parameter or use `*`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.data_streams_stats-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Type of data stream that wildcard patterns can match.\nSupports 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"
},
"indices.delete_alias-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams or indices used to limit the request.\nSupports wildcards (`*`).",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.delete_alias-name": {
"in": "path",
"name": "name",
"description": "Comma-separated list of aliases to remove.\nSupports wildcards (`*`). To remove all aliases, use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"indices.delete_alias-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.delete_alias-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"indices.exists_alias-name": {
"in": "path",
"name": "name",
"description": "Comma-separated list of aliases to check. Supports wildcards (`*`).",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"indices.exists_alias-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`).\nTo 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"
},
"indices.exists_alias-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.exists_alias-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.exists_alias-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.exists_alias-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.flush-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases to flush.\nSupports wildcards (`*`).\nTo flush all data streams and indices, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.flush-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.flush-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.flush-force": {
"in": "query",
"name": "force",
"description": "If `true`, the request forces a flush even if there are no changes to commit to the index.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.flush-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.flush-wait_if_ongoing": {
"in": "query",
"name": "wait_if_ongoing",
"description": "If `true`, the flush operation blocks until execution when another flush operation is running.\nIf `false`, Elasticsearch returns an error if you request a flush when another flush operation is running.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.forcemerge-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.forcemerge-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.forcemerge-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.\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"
},
"indices.forcemerge-flush": {
"in": "query",
"name": "flush",
"description": "Specify whether the index should be flushed after performing the operation",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.forcemerge-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.forcemerge-max_num_segments": {
"in": "query",
"name": "max_num_segments",
"description": "The number of segments the index should be merged into (default: dynamic)",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"indices.forcemerge-only_expunge_deletes": {
"in": "query",
"name": "only_expunge_deletes",
"description": "Specify whether the operation should only expunge deleted documents",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.forcemerge-wait_for_completion": {
"in": "query",
"name": "wait_for_completion",
"description": "Should the request wait until the force merge is completed",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_alias-name": {
"in": "path",
"name": "name",
"description": "Comma-separated list of aliases to retrieve.\nSupports wildcards (`*`).\nTo retrieve all aliases, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"indices.get_alias-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams or indices used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"indices.get_alias-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_alias-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.get_alias-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_alias-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.get_data_stream-name": {
"in": "path",
"name": "name",
"description": "Comma-separated list of data stream names used to limit the request.\nWildcard (`*`) expressions are supported. If omitted, all data streams are returned.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DataStreamNames"
},
"style": "simple"
},
"indices.get_data_stream-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Type of data stream that wildcard patterns can match.\nSupports 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"
},
"indices.get_data_stream-include_defaults": {
"in": "query",
"name": "include_defaults",
"description": "If true, returns all relevant default configurations for the index template.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.11.0",
"style": "form"
},
"indices.get_data_stream-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. 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"
},
"indices.get_data_stream-verbose": {
"in": "query",
"name": "verbose",
"description": "Whether the maximum timestamp for each data stream should be calculated and returned.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_field_mapping-fields": {
"in": "path",
"name": "fields",
"description": "Comma-separated list or wildcard expression of fields used to limit returned information.\nSupports wildcards (`*`).",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "simple"
},
"indices.get_field_mapping-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"indices.get_field_mapping-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_field_mapping-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.get_field_mapping-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_field_mapping-include_defaults": {
"in": "query",
"name": "include_defaults",
"description": "If `true`, return all default settings in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_index_template-name": {
"in": "path",
"name": "name",
"description": "Name of index template to retrieve. Wildcard (*) expressions are supported.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"indices.get_index_template-local": {
"in": "query",
"name": "local",
"description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_index_template-flat_settings": {
"in": "query",
"name": "flat_settings",
"description": "If true, returns settings in flat format.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_index_template-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. 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"
},
"indices.get_index_template-include_defaults": {
"in": "query",
"name": "include_defaults",
"description": "If true, returns all relevant default configurations for the index template.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.11.0",
"style": "form"
},
"indices.get_mapping-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"indices.get_mapping-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_mapping-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.get_mapping-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_mapping-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request retrieves information from the local node only.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_mapping-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.get_settings-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.get_settings-name": {
"in": "path",
"name": "name",
"description": "Comma-separated list or wildcard expression of settings to retrieve.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"indices.get_settings-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_settings-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.get_settings-flat_settings": {
"in": "query",
"name": "flat_settings",
"description": "If `true`, returns settings in flat format.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_settings-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_settings-include_defaults": {
"in": "query",
"name": "include_defaults",
"description": "If `true`, return all default settings in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_settings-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request retrieves information from the local node only. If\n`false`, information is retrieved from the master node.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_settings-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"indices.get_template-name": {
"in": "path",
"name": "name",
"description": "Comma-separated list of index template names used to limit the request.\nWildcard (`*`) expressions are supported.\nTo return all index templates, omit this parameter or use a value of `_all` or `*`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"indices.get_template-flat_settings": {
"in": "query",
"name": "flat_settings",
"description": "If `true`, returns settings in flat format.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_template-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request retrieves information from the local node only.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.get_template-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.put_alias-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams or indices to add.\nSupports wildcards (`*`).\nWildcard patterns that match both data streams and indices return an error.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.put_alias-name": {
"in": "path",
"name": "name",
"description": "Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"indices.put_alias-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.put_alias-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"indices.put_index_template-name": {
"in": "path",
"name": "name",
"description": "Index or template name",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"indices.put_index_template-create": {
"in": "query",
"name": "create",
"description": "If `true`, this request cannot replace or update existing index templates.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_index_template-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.put_index_template-cause": {
"in": "query",
"name": "cause",
"description": "User defined reason for creating or updating the index template",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"indices.put_mapping-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of index names the mapping should be added to (supports wildcards).\nUse `_all` or omit to add the mapping on all indices.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.put_mapping-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_mapping-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.put_mapping-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_mapping-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.put_mapping-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"indices.put_mapping-write_index_only": {
"in": "query",
"name": "write_index_only",
"description": "If `true`, the mappings are applied only to the current write index for the target.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_settings-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.put_settings-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_settings-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Type of index that wildcard patterns can match. If the request can target\ndata streams, this argument determines whether wildcard expressions match\nhidden data streams. Supports comma-separated values, such as\n`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"
},
"indices.put_settings-flat_settings": {
"in": "query",
"name": "flat_settings",
"description": "If `true`, returns settings in flat format.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_settings-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_settings-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"indices.put_settings-preserve_existing": {
"in": "query",
"name": "preserve_existing",
"description": "If `true`, existing index settings remain unchanged.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_settings-reopen": {
"in": "query",
"name": "reopen",
"description": "Whether to close and reopen the index to apply non-dynamic settings.\nIf set to `true` the indices to which the settings are being applied\nwill be closed temporarily and then reopened in order to apply the changes.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_settings-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"indices.put_template-name": {
"in": "path",
"name": "name",
"description": "The name of the template",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"indices.put_template-create": {
"in": "query",
"name": "create",
"description": "If true, this request cannot replace or update existing index templates.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.put_template-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an error.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"indices.put_template-order": {
"in": "query",
"name": "order",
"description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"indices.put_template-cause": {
"in": "query",
"name": "cause",
"description": "User defined reason for creating or updating the index template",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"indices.recovery-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"indices.recovery-active_only": {
"in": "query",
"name": "active_only",
"description": "If `true`, the response only includes ongoing shard recoveries.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.recovery-detailed": {
"in": "query",
"name": "detailed",
"description": "If `true`, the response includes detailed information about shard recoveries.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.recovery-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.recovery-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.recovery-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.refresh-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"indices.refresh-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.refresh-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.refresh-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.reload_search_analyzers-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of index names to reload analyzers for",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.reload_search_analyzers-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.reload_search_analyzers-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.\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"
},
"indices.reload_search_analyzers-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.reload_search_analyzers-resource": {
"in": "query",
"name": "resource",
"description": "Changed resource to reload analyzers from if applicable",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"indices.resolve_cluster-name": {
"in": "path",
"name": "name",
"description": "A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the ``:`` syntax.\nIndex and cluster exclusions (e.g., `-cluster1:*`) are also supported.\nIf no index expression is specified, information about all remote clusters configured on the local cluster\nis returned without doing any index matching",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"indices.resolve_cluster-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.\nNOTE: This option is only supported when specifying an index expression. You will get an error if you specify index\noptions to the `_resolve/cluster` API endpoint that takes no index expression.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.resolve_cluster-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports comma-separated values, such as `open,hidden`.\nNOTE: This option is only supported when specifying an index expression. You will get an error if you specify index\noptions to the `_resolve/cluster` API endpoint that takes no index expression.\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"
},
"indices.resolve_cluster-ignore_throttled": {
"in": "query",
"name": "ignore_throttled",
"description": "If true, concrete, expanded, or aliased indices are ignored when frozen.\nNOTE: This option is only supported when specifying an index expression. You will get an error if you specify index\noptions to the `_resolve/cluster` API endpoint that takes no index expression.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.resolve_cluster-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.\nNOTE: This option is only supported when specifying an index expression. You will get an error if you specify index\noptions to the `_resolve/cluster` API endpoint that takes no index expression.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.resolve_cluster-timeout": {
"in": "query",
"name": "timeout",
"description": "The maximum time to wait for remote clusters to respond.\nIf a remote cluster does not respond within this timeout period, the API response\nwill show the cluster as not connected and include an error message that the\nrequest timed out.\n\nThe default timeout is unset and the query can take\nas long as the networking layer is configured to wait for remote clusters that are\nnot responding (typically 30 seconds).",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"indices.resolve_index-name": {
"in": "path",
"name": "name",
"description": "Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the ``:`` syntax.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"indices.resolve_index-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.resolve_index-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.resolve_index-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.resolve_index-mode": {
"in": "query",
"name": "mode",
"description": "Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.\n\nSupported values include: `standard`, `time_series`, `logsdb`, `lookup`\n\n",
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/indices._types.IndexMode"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/indices._types.IndexMode"
}
}
]
},
"x-state": "Generally available; Added in 9.2.0",
"style": "form"
},
"indices.rollover-alias": {
"in": "path",
"name": "alias",
"description": "Name of the data stream or index alias to roll over.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexAlias"
},
"style": "simple"
},
"indices.rollover-new_index": {
"in": "path",
"name": "new_index",
"description": "Name of the index to create.\nSupports date math.\nData streams do not support this parameter.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.rollover-dry_run": {
"in": "query",
"name": "dry_run",
"description": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.rollover-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.rollover-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"indices.rollover-wait_for_active_shards": {
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
"indices.rollover-lazy": {
"in": "query",
"name": "lazy",
"description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.\nOnly allowed on data streams.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.segments-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo 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"
},
"indices.segments-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.segments-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.segments-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.shard_stores-index": {
"in": "path",
"name": "index",
"description": "List of data streams, indices, and aliases used to limit the request.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.shard_stores-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.shard_stores-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Type of index that wildcard patterns can match. If the request can target data streams,\nthis argument determines whether wildcard expressions match hidden data streams.\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"
},
"indices.shard_stores-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.shard_stores-status": {
"in": "query",
"name": "status",
"description": "List of shard health statuses used to limit the request.\n\nSupported values include:\n - `green`: The primary shard and all replica shards are assigned.\n - `yellow`: One or more replica shards are unassigned.\n - `red`: The primary shard is unassigned.\n - `all`: Return all shards, regardless of health status.\n\n",
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/indices.shard_stores.ShardStoreStatus"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/indices.shard_stores.ShardStoreStatus"
}
}
]
},
"style": "form"
},
"indices.shrink-index": {
"in": "path",
"name": "index",
"description": "Name of the source index to shrink.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.shrink-target": {
"in": "path",
"name": "target",
"description": "Name of the target index to create.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.shrink-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.shrink-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"indices.shrink-wait_for_active_shards": {
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
"indices.simulate_template-name": {
"in": "path",
"name": "name",
"description": "Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit\nthis parameter and specify the template configuration in the request body.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"indices.simulate_template-create": {
"in": "query",
"name": "create",
"description": "If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.simulate_template-cause": {
"in": "query",
"name": "cause",
"description": "User defined reason for dry-run creating the new template for simulation purposes",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"indices.simulate_template-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. 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"
},
"indices.simulate_template-include_defaults": {
"in": "query",
"name": "include_defaults",
"description": "If true, returns all relevant default configurations for the index template.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.11.0",
"style": "form"
},
"indices.split-index": {
"in": "path",
"name": "index",
"description": "Name of the source index to split.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.split-target": {
"in": "path",
"name": "target",
"description": "Name of the target index to create.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"indices.split-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"indices.split-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"indices.split-wait_for_active_shards": {
"in": "query",
"name": "wait_for_active_shards",
"description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.WaitForActiveShards"
},
"style": "form"
},
"indices.stats-metric": {
"in": "path",
"name": "metric",
"description": "Comma-separated list of metrics used to limit the request.\n\nSupported values include:\n - `_all`: Return all statistics.\n - `store`: Size of the index in byte units.\n - `indexing`: Indexing statistics.\n - `get`: Get statistics, including missing stats.\n - `search`: Search statistics including suggest statistics.\nYou can include statistics for custom groups by adding an extra `groups` parameter\n(search operations can be associated with one or more groups).\nThe `groups` parameter accepts a comma-separated list of group names.\nUse `_all` to return statistics for all groups.\n - `merge`: Merge statistics.\n - `flush`: Flush statistics.\n - `refresh`: Refresh statistics.\n - `query_cache`: Query cache statistics.\n - `fielddata`: Fielddata statistics.\n - `docs`: Number of documents and deleted docs not yet merged out. Index refreshes can affect this statistic.\n - `warmer`: Index warming statistics.\n - `completion`: Completion suggester statistics.\n - `segments`: Memory use of all open segments.\nIf the `include_segment_file_sizes` parameter is `true`, this metric includes the aggregated disk usage of each Lucene index file.\n - `translog`: Translog statistics.\n - `request_cache`: Shard request cache statistics.\n - `recovery`: Recovery statistics.\n - `bulk`: Bulk operations statistics.\n - `shard_stats`: Shard statistics, including the total number of shards.\n - `mappings`: Mapping statistics, including the total count and estimated overhead.\n - `dense_vector`: Total number of dense vectors indexed. Index refreshes can affect this statistic.\n - `sparse_vector`: Total number of sparse vectors indexed. Index refreshes can affect this statistic.\n\n",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.CommonStatsFlags"
},
"style": "simple"
},
"indices.stats-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.stats-completion_fields": {
"in": "query",
"name": "completion_fields",
"description": "Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"indices.stats-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Type of index that wildcard patterns 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"
},
"indices.stats-fielddata_fields": {
"in": "query",
"name": "fielddata_fields",
"description": "Comma-separated list or wildcard expressions of fields to include in fielddata statistics.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"indices.stats-fields": {
"in": "query",
"name": "fields",
"description": "Comma-separated list or wildcard expressions of fields to include in the statistics.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"indices.stats-forbid_closed_indices": {
"in": "query",
"name": "forbid_closed_indices",
"description": "If true, statistics are not collected from closed indices.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.stats-groups": {
"in": "query",
"name": "groups",
"description": "Comma-separated list of search groups to include in the search statistics.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"indices.stats-include_segment_file_sizes": {
"in": "query",
"name": "include_segment_file_sizes",
"description": "If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.stats-include_unloaded_segments": {
"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"
},
"indices.stats-level": {
"in": "query",
"name": "level",
"description": "Indicates whether statistics are aggregated at the cluster, indices, or shards level.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Level"
},
"style": "form"
},
"indices.validate_query-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"indices.validate_query-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.validate_query-all_shards": {
"in": "query",
"name": "all_shards",
"description": "If `true`, the validation is executed on all shards instead of one random shard per index.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.validate_query-analyzer": {
"in": "query",
"name": "analyzer",
"description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"indices.validate_query-analyze_wildcard": {
"in": "query",
"name": "analyze_wildcard",
"description": "If `true`, wildcard and prefix queries are analyzed.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.validate_query-default_operator": {
"in": "query",
"name": "default_operator",
"description": "The default operator for query string query: `and` or `or`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.query_dsl.Operator"
},
"style": "form"
},
"indices.validate_query-df": {
"in": "query",
"name": "df",
"description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"indices.validate_query-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"indices.validate_query-explain": {
"in": "query",
"name": "explain",
"description": "If `true`, the response returns detailed information if an error has occurred.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.validate_query-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.validate_query-lenient": {
"in": "query",
"name": "lenient",
"description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.validate_query-rewrite": {
"in": "query",
"name": "rewrite",
"description": "If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"indices.validate_query-q": {
"in": "query",
"name": "q",
"description": "Query in the Lucene query string syntax.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"inference.delete-task_type": {
"in": "path",
"name": "task_type",
"description": "The task type",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/inference._types.TaskType"
},
"style": "simple"
},
"inference.delete-inference_id": {
"in": "path",
"name": "inference_id",
"description": "The inference identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"inference.delete-dry_run": {
"in": "query",
"name": "dry_run",
"description": "When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"inference.delete-force": {
"in": "query",
"name": "force",
"description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"inference.get-task_type": {
"in": "path",
"name": "task_type",
"description": "The task type of the endpoint to return",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/inference._types.TaskType"
},
"style": "simple"
},
"inference.get-inference_id": {
"in": "path",
"name": "inference_id",
"description": "The inference Id of the endpoint to return. Using `_all` or `*` will return all endpoints with the specified\n`task_type` if one is specified, or all endpoints for all task types if no `task_type` is specified",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"inference.inference-task_type": {
"in": "path",
"name": "task_type",
"description": "The type of inference task that the model performs.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/inference._types.TaskType"
},
"style": "simple"
},
"inference.inference-inference_id": {
"in": "path",
"name": "inference_id",
"description": "The unique identifier for the inference endpoint.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"inference.inference-timeout": {
"in": "query",
"name": "timeout",
"description": "The amount of time to wait for the inference request to complete.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"inference.put-task_type": {
"in": "path",
"name": "task_type",
"description": "The task type. Refer to the integration list in the API description for the available task types.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/inference._types.TaskType"
},
"style": "simple"
},
"inference.put-inference_id": {
"in": "path",
"name": "inference_id",
"description": "The inference Id",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"inference.put-timeout": {
"in": "query",
"name": "timeout",
"description": "Specifies the amount of time to wait for the inference endpoint to be created.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"inference.update-inference_id": {
"in": "path",
"name": "inference_id",
"description": "The unique identifier of the inference endpoint.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"inference.update-task_type": {
"in": "path",
"name": "task_type",
"description": "The type of inference task that the model performs.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/inference._types.TaskType"
},
"style": "simple"
},
"ingest.get_geoip_database-id": {
"in": "path",
"name": "id",
"description": "A comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"ingest.get_ip_location_database-id": {
"in": "path",
"name": "id",
"description": "Comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"ingest.get_pipeline-id": {
"in": "path",
"name": "id",
"description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ingest.get_pipeline-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node.\nIf 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"
},
"ingest.get_pipeline-summary": {
"in": "query",
"name": "summary",
"description": "Return pipelines without their definitions",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ingest.simulate-id": {
"in": "path",
"name": "id",
"description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ingest.simulate-verbose": {
"in": "query",
"name": "verbose",
"description": "If `true`, the response includes output data for each processor in the executed pipeline.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"license.post-acknowledge": {
"in": "query",
"name": "acknowledge",
"description": "To update a license, you must accept the acknowledge messages and set this parameter to `true`.\nIn particular, if you are upgrading or downgrading a license, you must acknowlege the feature changes.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"license.post-master_timeout": {
"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"
},
"license.post-timeout": {
"in": "query",
"name": "timeout",
"description": "The 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"
},
"logstash.get_pipeline-id": {
"in": "path",
"name": "id",
"description": "A comma-separated list of pipeline identifiers.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"mget-index": {
"in": "path",
"name": "index",
"description": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"mget-preference": {
"in": "query",
"name": "preference",
"description": "Specifies the node or shard the operation should be performed on. Random by default.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"mget-realtime": {
"in": "query",
"name": "realtime",
"description": "If `true`, the request is real-time as opposed to near-real-time.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mget-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true`, the request refreshes relevant shards before retrieving documents.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mget-routing": {
"in": "query",
"name": "routing",
"description": "Custom value used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"mget-_source": {
"in": "query",
"name": "_source",
"description": "True or false to return the `_source` field or not, or a list of fields to return.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
},
"style": "form"
},
"mget-_source_excludes": {
"in": "query",
"name": "_source_excludes",
"description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"mget-_source_includes": {
"in": "query",
"name": "_source_includes",
"description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"mget-stored_fields": {
"in": "query",
"name": "stored_fields",
"description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"migration.deprecations-index": {
"in": "path",
"name": "index",
"description": "Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"ml.delete_expired_data-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for an anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.delete_expired_data-requests_per_second": {
"in": "query",
"name": "requests_per_second",
"description": "The desired requests per second for the deletion processes. The default\nbehavior is no throttling.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.delete_expired_data-timeout": {
"in": "query",
"name": "timeout",
"description": "How long can the underlying delete processes run until they are canceled.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"ml.delete_forecast-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.delete_forecast-forecast_id": {
"in": "path",
"name": "forecast_id",
"description": "A comma-separated list of forecast identifiers. If you do not specify\nthis optional parameter or if you specify `_all` or `*` the API deletes\nall forecasts from the job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.delete_forecast-allow_no_forecasts": {
"in": "query",
"name": "allow_no_forecasts",
"description": "Specifies whether an error occurs when there are no forecasts. In\nparticular, if this parameter is set to `false` and there are no\nforecasts associated with the job, attempts to delete all forecasts\nreturn an error.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.delete_forecast-timeout": {
"in": "query",
"name": "timeout",
"description": "Specifies the period of time to wait for the completion of the delete\noperation. When this period of time elapses, the API fails and returns an\nerror.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"ml.explain_data_frame_analytics-id": {
"in": "path",
"name": "id",
"description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_buckets-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_buckets-timestamp": {
"in": "path",
"name": "timestamp",
"description": "The timestamp of a single bucket result. If you do not specify this\nparameter, the API returns information about all buckets.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "simple"
},
"ml.get_buckets-anomaly_score": {
"in": "query",
"name": "anomaly_score",
"description": "Returns buckets with anomaly scores greater or equal than this value.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_buckets-desc": {
"in": "query",
"name": "desc",
"description": "If `true`, the buckets are sorted in descending order.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_buckets-end": {
"in": "query",
"name": "end",
"description": "Returns buckets with timestamps earlier than this time. `-1` means it is\nunset and results are not limited to specific timestamps.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_buckets-exclude_interim": {
"in": "query",
"name": "exclude_interim",
"description": "If `true`, the output excludes interim results.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_buckets-expand": {
"in": "query",
"name": "expand",
"description": "If true, the output includes anomaly records.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_buckets-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of buckets.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_buckets-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of buckets to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_buckets-sort": {
"in": "query",
"name": "sort",
"description": "Specifies the sort field for the requested buckets.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
"ml.get_buckets-start": {
"in": "query",
"name": "start",
"description": "Returns buckets with timestamps after this time. `-1` means it is unset\nand results are not limited to specific timestamps.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_calendars-calendar_id": {
"in": "path",
"name": "calendar_id",
"description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_calendars-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_calendars-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_categories-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_categories-category_id": {
"in": "path",
"name": "category_id",
"description": "Identifier for the category, which is unique in the job. If you specify\nneither the category ID nor the partition_field_value, the API returns\ninformation about all categories. If you specify only the\npartition_field_value, it returns information about all categories for\nthe specified partition.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.CategoryId"
},
"style": "simple"
},
"ml.get_categories-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of categories.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_categories-partition_field_value": {
"in": "query",
"name": "partition_field_value",
"description": "Only return categories for the specified partition.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"ml.get_categories-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of categories to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_data_frame_analytics-id": {
"in": "path",
"name": "id",
"description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_data_frame_analytics-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_data_frame_analytics-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of data frame analytics jobs.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_data_frame_analytics-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of data frame analytics jobs to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_data_frame_analytics-exclude_generated": {
"in": "query",
"name": "exclude_generated",
"description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_data_frame_analytics_stats-id": {
"in": "path",
"name": "id",
"description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_data_frame_analytics_stats-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_data_frame_analytics_stats-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of data frame analytics jobs.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_data_frame_analytics_stats-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of data frame analytics jobs to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_data_frame_analytics_stats-verbose": {
"in": "query",
"name": "verbose",
"description": "Defines whether the stats response should be verbose.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_datafeed_stats-datafeed_id": {
"in": "path",
"name": "datafeed_id",
"description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"ml.get_datafeed_stats-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_datafeeds-datafeed_id": {
"in": "path",
"name": "datafeed_id",
"description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"ml.get_datafeeds-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_datafeeds-exclude_generated": {
"in": "query",
"name": "exclude_generated",
"description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_filters-filter_id": {
"in": "path",
"name": "filter_id",
"description": "A string that uniquely identifies a filter.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"ml.get_filters-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of filters.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_filters-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of filters to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_influencers-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_influencers-desc": {
"in": "query",
"name": "desc",
"description": "If true, the results are sorted in descending order.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_influencers-end": {
"in": "query",
"name": "end",
"description": "Returns influencers with timestamps earlier than this time.\nThe default value means it is unset and results are not limited to\nspecific timestamps.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_influencers-exclude_interim": {
"in": "query",
"name": "exclude_interim",
"description": "If true, the output excludes interim results. By default, interim results\nare included.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_influencers-influencer_score": {
"in": "query",
"name": "influencer_score",
"description": "Returns influencers with anomaly scores greater than or equal to this\nvalue.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_influencers-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of influencers.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_influencers-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of influencers to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_influencers-sort": {
"in": "query",
"name": "sort",
"description": "Specifies the sort field for the requested influencers. By default, the\ninfluencers are sorted by the `influencer_score` value.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
"ml.get_influencers-start": {
"in": "query",
"name": "start",
"description": "Returns influencers with timestamps after this time. The default value\nmeans it is unset and results are not limited to specific timestamps.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_job_stats-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs, or a wildcard expression. If\nyou do not specify one of these options, the API returns information for\nall anomaly detection jobs.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_job_stats-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If `false`, the API returns a `404` status\ncode when there are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_jobs-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression. If you do not specify one of these\noptions, the API returns information for all anomaly detection jobs.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"ml.get_jobs-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_jobs-exclude_generated": {
"in": "query",
"name": "exclude_generated",
"description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_memory_stats-node_id": {
"in": "path",
"name": "node_id",
"description": "The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or\n`ml:true`",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_memory_stats-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout\nexpires, the request fails and returns an error.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"ml.get_memory_stats-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request\nfails and returns an error.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"ml.get_model_snapshots-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_model_snapshots-snapshot_id": {
"in": "path",
"name": "snapshot_id",
"description": "A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_model_snapshots-desc": {
"in": "query",
"name": "desc",
"description": "If true, the results are sorted in descending order.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_model_snapshots-end": {
"in": "query",
"name": "end",
"description": "Returns snapshots with timestamps earlier than this time.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_model_snapshots-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of snapshots.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_model_snapshots-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of snapshots to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_model_snapshots-sort": {
"in": "query",
"name": "sort",
"description": "Specifies the sort field for the requested snapshots. By default, the\nsnapshots are sorted by their timestamp.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
"ml.get_model_snapshots-start": {
"in": "query",
"name": "start",
"description": "Returns snapshots with timestamps after this time.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_overall_buckets-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs or groups, or a wildcard\nexpression.\n\nYou can summarize the bucket results for all anomaly detection jobs by\nusing `_all` or by specifying `*` as the ``.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_overall_buckets-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the request returns an empty `jobs` array when there are no\nmatches and the subset of results when there are partial matches. If this\nparameter is `false`, the request returns a `404` status code when there\nare no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_overall_buckets-bucket_span": {
"in": "query",
"name": "bucket_span",
"description": "The span of the overall buckets. Must be greater or equal to the largest\nbucket span of the specified anomaly detection jobs, which is the default\nvalue.\n\nBy default, an overall bucket has a span equal to the largest bucket span\nof the specified anomaly detection jobs. To override that behavior, use\nthe optional `bucket_span` parameter.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"ml.get_overall_buckets-end": {
"in": "query",
"name": "end",
"description": "Returns overall buckets with timestamps earlier than this time.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_overall_buckets-exclude_interim": {
"in": "query",
"name": "exclude_interim",
"description": "If `true`, the output excludes interim results.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_overall_buckets-overall_score": {
"in": "query",
"name": "overall_score",
"description": "Returns overall buckets with overall scores greater than or equal to this\nvalue.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_overall_buckets-start": {
"in": "query",
"name": "start",
"description": "Returns overall buckets with timestamps after this time.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_overall_buckets-top_n": {
"in": "query",
"name": "top_n",
"description": "The number of top anomaly detection job bucket scores to be used in the\n`overall_score` calculation.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_records-job_id": {
"in": "path",
"name": "job_id",
"description": "Identifier for the anomaly detection job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.get_records-desc": {
"in": "query",
"name": "desc",
"description": "If true, the results are sorted in descending order.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_records-end": {
"in": "query",
"name": "end",
"description": "Returns records with timestamps earlier than this time. The default value\nmeans results are not limited to specific timestamps.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_records-exclude_interim": {
"in": "query",
"name": "exclude_interim",
"description": "If `true`, the output excludes interim results.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_records-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of records.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_records-record_score": {
"in": "query",
"name": "record_score",
"description": "Returns records with anomaly scores greater or equal than this value.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_records-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of records to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_records-sort": {
"in": "query",
"name": "sort",
"description": "Specifies the sort field for the requested records.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
"ml.get_records-start": {
"in": "query",
"name": "start",
"description": "Returns records with timestamps after this time. The default value means\nresults are not limited to specific timestamps.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.get_trained_models-model_id": {
"in": "path",
"name": "model_id",
"description": "The unique identifier of the trained model or a model alias.\n\nYou can get information for multiple trained models in a single API\nrequest by using a comma-separated list of model IDs or a wildcard\nexpression.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"ml.get_trained_models-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_trained_models-decompress_definition": {
"in": "query",
"name": "decompress_definition",
"description": "Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_trained_models-exclude_generated": {
"in": "query",
"name": "exclude_generated",
"description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_trained_models-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of models.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_trained_models-include": {
"in": "query",
"name": "include",
"description": "A comma delimited string of optional fields to include in the response\nbody.\n\nSupported values include:\n - `definition`: Includes the model definition.\n - `feature_importance_baseline`: Includes the baseline for feature importance values.\n - `hyperparameters`: Includes the information about hyperparameters used to train the model.\nThis information consists of the value, the absolute and relative\nimportance of the hyperparameter as well as an indicator of whether it was\nspecified by the user or tuned during hyperparameter optimization.\n - `total_feature_importance`: Includes the total feature importance for the training data set. The\nbaseline and total feature importance values are returned in the metadata\nfield in the response body.\n - `definition_status`: Includes the model definition status.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/ml._types.Include"
},
"style": "form"
},
"ml.get_trained_models-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of models to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_trained_models-tags": {
"in": "query",
"name": "tags",
"description": "A comma delimited string of tags. A trained model can have many tags, or\nnone. When supplied, only trained models that contain all the supplied\ntags are returned.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"ml.get_trained_models_stats-model_id": {
"in": "path",
"name": "model_id",
"description": "The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Ids"
},
"style": "simple"
},
"ml.get_trained_models_stats-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"ml.get_trained_models_stats-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of models.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.get_trained_models_stats-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of models to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"ml.preview_data_frame_analytics-id": {
"in": "path",
"name": "id",
"description": "Identifier for the data frame analytics job.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.preview_datafeed-datafeed_id": {
"in": "path",
"name": "datafeed_id",
"description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job\nconfiguration details in the request body.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"ml.preview_datafeed-start": {
"in": "query",
"name": "start",
"description": "The start time from where the datafeed preview should begin",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"ml.preview_datafeed-end": {
"in": "query",
"name": "end",
"description": "The end time when the datafeed preview should stop",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.DateTime"
},
"style": "form"
},
"msearch-index": {
"in": "path",
"name": "index",
"description": "Comma-separated list of data streams, indices, and index aliases to search.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"msearch-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch-ccs_minimize_roundtrips": {
"in": "query",
"name": "ccs_minimize_roundtrips",
"description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\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"
},
"msearch-ignore_throttled": {
"in": "query",
"name": "ignore_throttled",
"description": "If true, concrete, expanded or aliased indices are ignored when frozen.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch-include_named_queries_score": {
"in": "query",
"name": "include_named_queries_score",
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes\nthe name of the matched query associated with its score (true)\nor as an array containing the name of the matched queries (false)\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch-index_": {
"in": "query",
"name": "index",
"description": "Comma-separated list of data streams, indices, and index aliases to use as default",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "form"
},
"msearch-max_concurrent_searches": {
"in": "query",
"name": "max_concurrent_searches",
"description": "Maximum number of concurrent searches the multi search API can execute.\nDefaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"msearch-max_concurrent_shard_requests": {
"in": "query",
"name": "max_concurrent_shard_requests",
"description": "Maximum number of concurrent shard requests that each sub-search request executes per node.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"msearch-pre_filter_shard_size": {
"in": "query",
"name": "pre_filter_shard_size",
"description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"msearch-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch-routing": {
"in": "query",
"name": "routing",
"description": "Custom routing value used to route search operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"msearch-search_type": {
"in": "query",
"name": "search_type",
"description": "Indicates whether global term and document frequencies should be used when scoring returned documents.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
"msearch-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch_template-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"msearch_template-ccs_minimize_roundtrips": {
"in": "query",
"name": "ccs_minimize_roundtrips",
"description": "If `true`, network round-trips are minimized for cross-cluster search requests.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch_template-max_concurrent_searches": {
"in": "query",
"name": "max_concurrent_searches",
"description": "The maximum number of concurrent searches the API can run.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"msearch_template-search_type": {
"in": "query",
"name": "search_type",
"description": "The type of the search operation.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
"msearch_template-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"description": "If `true`, the response returns `hits.total` as an integer.\nIf `false`, it returns `hits.total` as an object.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"msearch_template-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "If `true`, the response prefixes aggregation and suggester names with their respective types.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mtermvectors-index": {
"in": "path",
"name": "index",
"description": "The name of the index that contains the documents.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"mtermvectors-ids": {
"in": "query",
"name": "ids",
"description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
},
"style": "form"
},
"mtermvectors-fields": {
"in": "query",
"name": "fields",
"description": "A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"mtermvectors-field_statistics": {
"in": "query",
"name": "field_statistics",
"description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mtermvectors-offsets": {
"in": "query",
"name": "offsets",
"description": "If `true`, the response includes term offsets.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mtermvectors-payloads": {
"in": "query",
"name": "payloads",
"description": "If `true`, the response includes term payloads.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mtermvectors-positions": {
"in": "query",
"name": "positions",
"description": "If `true`, the response includes term positions.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mtermvectors-preference": {
"in": "query",
"name": "preference",
"description": "The node or shard the operation should be performed on.\nIt is random by default.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"mtermvectors-realtime": {
"in": "query",
"name": "realtime",
"description": "If true, the request is real-time as opposed to near-real-time.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mtermvectors-routing": {
"in": "query",
"name": "routing",
"description": "A custom value used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"mtermvectors-term_statistics": {
"in": "query",
"name": "term_statistics",
"description": "If true, the response includes term frequency and document frequency.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"mtermvectors-version": {
"in": "query",
"name": "version",
"description": "If `true`, returns the document version as part of a hit.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionNumber"
},
"style": "form"
},
"mtermvectors-version_type": {
"in": "query",
"name": "version_type",
"description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionType"
},
"style": "form"
},
"nodes.hot_threads-node_id": {
"in": "path",
"name": "node_id",
"description": "List of node IDs or names used to limit returned information.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeIds"
},
"style": "simple"
},
"nodes.hot_threads-ignore_idle_threads": {
"in": "query",
"name": "ignore_idle_threads",
"description": "If true, known idle threads (e.g. waiting in a socket select, or to get\na task from an empty queue) are filtered out.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"nodes.hot_threads-interval": {
"in": "query",
"name": "interval",
"description": "The interval to do the second sampling of threads.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"nodes.hot_threads-snapshots": {
"in": "query",
"name": "snapshots",
"description": "Number of samples of thread stacktrace.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"nodes.hot_threads-threads": {
"in": "query",
"name": "threads",
"description": "Specifies the number of hot threads to provide information for.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"nodes.hot_threads-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response. If no response is received\nbefore the timeout expires, the request fails and returns an error.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"nodes.hot_threads-type": {
"in": "query",
"name": "type",
"description": "The type to sample.\n\nSupported values include:\n - `cpu`: Threads that consume the most CPU time.\n - `wait`: Threads that have been in a waiting state the longest.\n - `block`: Threads that have been blocked the longest.\n - `gpu`: Threads that consume the most GPU time.\n - `mem`: Threads that allocate the most memory.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.ThreadType"
},
"style": "form"
},
"nodes.hot_threads-sort": {
"in": "query",
"name": "sort",
"description": "The sort order for 'cpu' type\n\nSupported values include:\n - `cpu`: Threads that consume the most CPU time.\n - `wait`: Threads that have been in a waiting state the longest.\n - `block`: Threads that have been blocked the longest.\n - `gpu`: Threads that consume the most GPU time.\n - `mem`: Threads that allocate the most memory.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.ThreadType"
},
"style": "form"
},
"nodes.info-node_id": {
"in": "path",
"name": "node_id",
"description": "Comma-separated list of node IDs or names used to limit returned information.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeIds"
},
"style": "simple"
},
"nodes.info-metric": {
"in": "path",
"name": "metric",
"description": "Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.\n\nSupported values include: `_all`, `_none`, `settings`, `os`, `process`, `jvm`, `thread_pool`, `transport`, `http`, `remote_cluster_server`, `plugins`, `ingest`, `aggregations`, `indices`\n\n",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/nodes.info.NodesInfoMetrics"
},
"style": "simple"
},
"nodes.info-flat_settings": {
"in": "query",
"name": "flat_settings",
"description": "If true, returns settings in flat format.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"nodes.info-timeout": {
"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"
},
"nodes.reload_secure_settings-node_id": {
"in": "path",
"name": "node_id",
"description": "The names of particular nodes in the cluster to target.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeIds"
},
"style": "simple"
},
"nodes.reload_secure_settings-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"nodes.stats-node_id": {
"in": "path",
"name": "node_id",
"description": "Comma-separated list of node IDs or names used to limit returned information.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeIds"
},
"style": "simple"
},
"nodes.stats-metric": {
"in": "path",
"name": "metric",
"description": "Limits the information returned to the specific metrics.\n\nSupported values include: `_all`, `_none`, `indices`, `os`, `process`, `jvm`, `thread_pool`, `fs`, `transport`, `http`, `breaker`, `script`, `discovery`, `ingest`, `adaptive_selection`, `script_cache`, `indexing_pressure`, `repositories`, `allocations`\n\n",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/nodes.stats.NodeStatsMetrics"
},
"style": "simple"
},
"nodes.stats-index_metric": {
"in": "path",
"name": "index_metric",
"description": "Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.\n\nSupported values include:\n - `_all`: Return all statistics.\n - `store`: Size of the index in byte units.\n - `indexing`: Indexing statistics.\n - `get`: Get statistics, including missing stats.\n - `search`: Search statistics including suggest statistics.\nYou can include statistics for custom groups by adding an extra `groups` parameter\n(search operations can be associated with one or more groups).\nThe `groups` parameter accepts a comma-separated list of group names.\nUse `_all` to return statistics for all groups.\n - `merge`: Merge statistics.\n - `flush`: Flush statistics.\n - `refresh`: Refresh statistics.\n - `query_cache`: Query cache statistics.\n - `fielddata`: Fielddata statistics.\n - `docs`: Number of documents and deleted docs not yet merged out. Index refreshes can affect this statistic.\n - `warmer`: Index warming statistics.\n - `completion`: Completion suggester statistics.\n - `segments`: Memory use of all open segments.\nIf the `include_segment_file_sizes` parameter is `true`, this metric includes the aggregated disk usage of each Lucene index file.\n - `translog`: Translog statistics.\n - `request_cache`: Shard request cache statistics.\n - `recovery`: Recovery statistics.\n - `bulk`: Bulk operations statistics.\n - `shard_stats`: Shard statistics, including the total number of shards.\n - `mappings`: Mapping statistics, including the total count and estimated overhead.\n - `dense_vector`: Total number of dense vectors indexed. Index refreshes can affect this statistic.\n - `sparse_vector`: Total number of sparse vectors indexed. Index refreshes can affect this statistic.\n\n",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.CommonStatsFlags"
},
"style": "simple"
},
"nodes.stats-completion_fields": {
"in": "query",
"name": "completion_fields",
"description": "Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"nodes.stats-fielddata_fields": {
"in": "query",
"name": "fielddata_fields",
"description": "Comma-separated list or wildcard expressions of fields to include in fielddata statistics.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"nodes.stats-fields": {
"in": "query",
"name": "fields",
"description": "Comma-separated list or wildcard expressions of fields to include in the statistics.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"nodes.stats-groups": {
"in": "query",
"name": "groups",
"description": "Comma-separated list of search groups to include in the search statistics.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"nodes.stats-include_segment_file_sizes": {
"in": "query",
"name": "include_segment_file_sizes",
"description": "If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"nodes.stats-level": {
"in": "query",
"name": "level",
"description": "Indicates whether statistics are aggregated at the node, indices, or shards level.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeStatsLevel"
},
"style": "form"
},
"nodes.stats-timeout": {
"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"
},
"nodes.stats-types": {
"in": "query",
"name": "types",
"description": "A comma-separated list of document types for the indexing index metric.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
"nodes.stats-include_unloaded_segments": {
"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"
},
"nodes.usage-node_id": {
"in": "path",
"name": "node_id",
"description": "A comma-separated list of node IDs or names to limit the returned information.\nUse `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeIds"
},
"style": "simple"
},
"nodes.usage-metric": {
"in": "path",
"name": "metric",
"description": "Limits the information returned to the specific metrics.\nA comma-separated list of the following options: `_all`, `rest_actions`, `aggregations`.\n\nSupported values include: `_all`, `rest_actions`, `aggregations`\n\n",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/nodes.usage.NodesUsageMetrics"
},
"style": "simple"
},
"nodes.usage-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response.\nIf 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"
},
"put_script-id": {
"in": "path",
"name": "id",
"description": "The identifier for the stored script or search template.\nIt must be unique within the cluster.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"put_script-context": {
"in": "path",
"name": "context",
"description": "The context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"put_script-context_": {
"in": "query",
"name": "context",
"description": "The context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.\nIf you specify both this and the `` path parameter, the API uses the request path parameter.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "form"
},
"put_script-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"put_script-timeout": {
"in": "query",
"name": "timeout",
"description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"rank_eval-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard (`*`) expressions are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"rank_eval-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"rank_eval-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.\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"
},
"rank_eval-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"rank_eval-search_type": {
"in": "query",
"name": "search_type",
"description": "Search operation type\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
"render_search_template-id": {
"in": "path",
"name": "id",
"description": "The ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"rollup.get_jobs-id": {
"in": "path",
"name": "id",
"description": "Identifier for the rollup job.\nIf it is `_all` or omitted, the API returns all rollup jobs.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"rollup.get_rollup_caps-id": {
"in": "path",
"name": "id",
"description": "Index, indices or index-pattern to return rollup capabilities for.\n`_all` may be used to fetch rollup capabilities from all jobs.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"rollup.rollup_search-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams and indices used to limit the request.\nThis parameter has the following rules:\n\n* At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using `_all` are not permitted.\n* Multiple non-rollup indices may be specified.\n* Only one rollup index may be specified. If more than one are supplied, an exception occurs.\n* Wildcard expressions (`*`) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"rollup.rollup_search-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"rollup.rollup_search-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"scroll-scroll_id": {
"in": "path",
"name": "scroll_id",
"description": "The scroll ID",
"required": true,
"deprecated": true,
"schema": {
"$ref": "#/components/schemas/_types.ScrollId"
},
"style": "simple"
},
"scroll-scroll": {
"in": "query",
"name": "scroll",
"description": "The period to retain the search context for scrolling.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"scroll-scroll_id_": {
"in": "query",
"name": "scroll_id",
"description": "The scroll ID",
"deprecated": true,
"schema": {
"$ref": "#/components/schemas/_types.ScrollId"
},
"style": "form"
},
"scroll-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"description": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"search-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-allow_partial_search_results": {
"in": "query",
"name": "allow_partial_search_results",
"description": "If `true` and there are shard request timeouts or shard failures, the request returns partial results.\nIf `false`, it returns an error with no partial results.\n\nTo override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-analyzer": {
"in": "query",
"name": "analyzer",
"description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"search-analyze_wildcard": {
"in": "query",
"name": "analyze_wildcard",
"description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-batched_reduce_size": {
"in": "query",
"name": "batched_reduce_size",
"description": "The number of shard results that should be reduced at once on the coordinating node.\nIf the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search-ccs_minimize_roundtrips": {
"in": "query",
"name": "ccs_minimize_roundtrips",
"description": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-default_operator": {
"in": "query",
"name": "default_operator",
"description": "The default operator for the query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.query_dsl.Operator"
},
"style": "form"
},
"search-df": {
"in": "query",
"name": "df",
"description": "The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"search-docvalue_fields": {
"in": "query",
"name": "docvalue_fields",
"description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"search-expand_wildcards": {
"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"
},
"search-explain": {
"in": "query",
"name": "explain",
"description": "If `true`, the request returns detailed information about score computation as part of a hit.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-ignore_throttled": {
"in": "query",
"name": "ignore_throttled",
"description": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-include_named_queries_score": {
"in": "query",
"name": "include_named_queries_score",
"description": "If `true`, the response includes the score contribution from any named queries.\n\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-lenient": {
"in": "query",
"name": "lenient",
"description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-max_concurrent_shard_requests": {
"in": "query",
"name": "max_concurrent_shard_requests",
"description": "The number of concurrent shard requests per node that the search runs concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search-preference": {
"in": "query",
"name": "preference",
"description": "The nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.\nValid values are:\n\n* `_only_local` to run the search only on shards on the local node.\n* `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method.\n* `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.\n* `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.\n* `_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.\n* `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"search-pre_filter_shard_size": {
"in": "query",
"name": "pre_filter_shard_size",
"description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.\nThis filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).\nWhen unspecified, the pre-filter phase is executed if any of these conditions is met:\n\n* The request targets more than 128 shards.\n* The request targets one or more read-only index.\n* The primary sort of the query targets an indexed field.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search-request_cache": {
"in": "query",
"name": "request_cache",
"description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-routing": {
"in": "query",
"name": "routing",
"description": "A custom value that is used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"search-scroll": {
"in": "query",
"name": "scroll",
"description": "The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"search-search_type": {
"in": "query",
"name": "search_type",
"description": "Indicates how distributed term frequencies are calculated for relevance scoring.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
"search-stats": {
"in": "query",
"name": "stats",
"description": "Specific `tag` of the request for logging and statistical purposes.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
"search-stored_fields": {
"in": "query",
"name": "stored_fields",
"description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"search-suggest_field": {
"in": "query",
"name": "suggest_field",
"description": "The field to use for suggestions.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
"search-suggest_mode": {
"in": "query",
"name": "suggest_mode",
"description": "The suggest mode.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.\n\nSupported values include:\n - `missing`: Only generate suggestions for terms that are not in the shard.\n - `popular`: Only suggest terms that occur in more docs on the shard than the original term.\n - `always`: Suggest any matching suggestions based on terms in the suggest text.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SuggestMode"
},
"style": "form"
},
"search-suggest_size": {
"in": "query",
"name": "suggest_size",
"description": "The number of suggestions to return.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search-suggest_text": {
"in": "query",
"name": "suggest_text",
"description": "The source text for which the suggestions should be returned.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"search-terminate_after": {
"in": "query",
"name": "terminate_after",
"description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.\nIf set to `0` (default), the query does not terminate early.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search-timeout": {
"in": "query",
"name": "timeout",
"description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt defaults to no timeout.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"search-track_total_hits": {
"in": "query",
"name": "track_total_hits",
"description": "The number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.TrackHits"
},
"style": "form"
},
"search-track_scores": {
"in": "query",
"name": "track_scores",
"description": "If `true`, the request calculates and returns document scores, even if the scores are not used for sorting.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"description": "Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-version": {
"in": "query",
"name": "version",
"description": "If `true`, the request returns the document version as part of a hit.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-_source": {
"in": "query",
"name": "_source",
"description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nValid values are:\n\n* `true` to return the entire document source.\n* `false` to not return the document source.\n* `` to return the source fields that are specified as a comma-separated list that supports wildcard (`*`) patterns.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
},
"style": "form"
},
"search-_source_excludes": {
"in": "query",
"name": "_source_excludes",
"description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"search-_source_exclude_vectors": {
"in": "query",
"name": "_source_exclude_vectors",
"description": "Whether vectors should be excluded from _source",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 9.2.0",
"style": "form"
},
"search-_source_includes": {
"in": "query",
"name": "_source_includes",
"description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"search-seq_no_primary_term": {
"in": "query",
"name": "seq_no_primary_term",
"description": "If `true`, the request returns the sequence number and primary term of the last modification of each hit.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search-q": {
"in": "query",
"name": "q",
"description": "A query in the Lucene query string syntax.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.\n\nIMPORTANT: This parameter overrides the query parameter in the request body.\nIf both parameters are specified, documents matching the query request body parameter are not returned.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"search-size": {
"in": "query",
"name": "size",
"description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search-from": {
"in": "query",
"name": "from",
"description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search-sort": {
"in": "query",
"name": "sort",
"description": "A comma-separated list of `:` pairs.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"search_application.get_behavioral_analytics-name": {
"in": "path",
"name": "name",
"description": "A list of analytics collections to limit the returned information",
"required": true,
"deprecated": false,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Name"
}
},
"style": "simple"
},
"search_application.search-name": {
"in": "path",
"name": "name",
"description": "The name of the search application to be searched.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"search_application.search-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "Determines whether aggregation names are prefixed by their respective types in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.14.0",
"style": "form"
},
"search_mvt-index": {
"in": "path",
"name": "index",
"description": "A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `:` syntax.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"search_mvt-field": {
"in": "path",
"name": "field",
"description": "A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "simple"
},
"search_mvt-zoom": {
"in": "path",
"name": "zoom",
"description": "The zoom level of the vector tile to search. It accepts `0` to `29`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search_mvt._types.ZoomLevel"
},
"style": "simple"
},
"search_mvt-x": {
"in": "path",
"name": "x",
"description": "The X coordinate for the vector tile to search.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search_mvt._types.Coordinate"
},
"style": "simple"
},
"search_mvt-y": {
"in": "path",
"name": "y",
"description": "The Y coordinate for the vector tile to search.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search_mvt._types.Coordinate"
},
"style": "simple"
},
"search_mvt-exact_bounds": {
"in": "query",
"name": "exact_bounds",
"description": "If `false`, the meta layer's feature is the bounding box of the tile.\nIf true, the meta layer's feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_mvt-extent": {
"in": "query",
"name": "extent",
"description": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search_mvt-grid_agg": {
"in": "query",
"name": "grid_agg",
"description": "Aggregation used to create a grid for `field`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search_mvt._types.GridAggregationType"
},
"style": "form"
},
"search_mvt-grid_precision": {
"in": "query",
"name": "grid_precision",
"description": "Additional zoom levels available through the aggs layer. For example, if is 7\nand grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search_mvt-grid_type": {
"in": "query",
"name": "grid_type",
"description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a geotile_grid cell. If 'grid' each feature is a Polygon\nof the cells bounding box. If 'point' each feature is a Point that is the centroid\nof the cell.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search_mvt._types.GridType"
},
"style": "form"
},
"search_mvt-size": {
"in": "query",
"name": "size",
"description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"search_mvt-track_total_hits": {
"in": "query",
"name": "track_total_hits",
"description": "The number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_global.search._types.TrackHits"
},
"style": "form"
},
"search_mvt-with_labels": {
"in": "query",
"name": "with_labels",
"description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_shards-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"search_shards-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_shards-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "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.\nSupports 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"
},
"search_shards-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_shards-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request retrieves information from the local node only.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_shards-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIT can also be set to `-1` to indicate that the request should never timeout.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"search_shards-preference": {
"in": "query",
"name": "preference",
"description": "The node or shard the operation should be performed on.\nIt is random by default.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"search_shards-routing": {
"in": "query",
"name": "routing",
"description": "A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"search_template-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"search_template-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_template-ccs_minimize_roundtrips": {
"in": "query",
"name": "ccs_minimize_roundtrips",
"description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_template-expand_wildcards": {
"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.\nSupports 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"
},
"search_template-explain": {
"in": "query",
"name": "explain",
"description": "If `true`, the response includes additional details about score computation as part of a hit.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_template-ignore_throttled": {
"in": "query",
"name": "ignore_throttled",
"description": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.",
"deprecated": true,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_template-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_template-preference": {
"in": "query",
"name": "preference",
"description": "The node or shard the operation should be performed on.\nIt is random by default.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"search_template-profile": {
"in": "query",
"name": "profile",
"description": "If `true`, the query execution is profiled.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"search_template-routing": {
"in": "query",
"name": "routing",
"description": "A custom value used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"search_template-scroll": {
"in": "query",
"name": "scroll",
"description": "Specifies how long a consistent view of the index\nshould be maintained for scrolled search.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"search_template-search_type": {
"in": "query",
"name": "search_type",
"description": "The type of the search operation.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SearchType"
},
"style": "form"
},
"search_template-rest_total_hits_as_int": {
"in": "query",
"name": "rest_total_hits_as_int",
"description": "If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 7.0.0",
"style": "form"
},
"search_template-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "If `true`, the response prefixes aggregation and suggester names with their respective types.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"searchable_snapshots.cache_stats-node_id": {
"in": "path",
"name": "node_id",
"description": "The names of the nodes in the cluster to target.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.NodeIds"
},
"style": "simple"
},
"searchable_snapshots.clear_cache-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and aliases to clear from the cache.\nIt supports wildcards (`*`).",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"searchable_snapshots.clear_cache-expand_wildcards": {
"in": "query",
"name": "expand_wildcards",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both\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"
},
"searchable_snapshots.clear_cache-allow_no_indices": {
"in": "query",
"name": "allow_no_indices",
"description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"searchable_snapshots.clear_cache-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"searchable_snapshots.stats-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams and indices to retrieve statistics for.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"searchable_snapshots.stats-level": {
"in": "query",
"name": "level",
"description": "Return stats aggregated at cluster, index or shard level",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/searchable_snapshots._types.StatsLevel"
},
"style": "form"
},
"security.change_password-username": {
"in": "path",
"name": "username",
"description": "The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Username"
},
"style": "simple"
},
"security.change_password-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.clone_api_key-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.create_api_key-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.create_service_token-namespace": {
"in": "path",
"name": "namespace",
"description": "The name of the namespace, which is a top-level grouping of service accounts.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Namespace"
},
"style": "simple"
},
"security.create_service_token-service": {
"in": "path",
"name": "service",
"description": "The name of the service.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Service"
},
"style": "simple"
},
"security.create_service_token-name": {
"in": "path",
"name": "name",
"description": "The name for the service account token.\nIf omitted, a random name will be generated.\n\nToken names must be at least one and no more than 256 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.\n\nNOTE: Token names must be unique in the context of the associated service account.\nThey must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `//`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"security.create_service_token-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.disable_user-username": {
"in": "path",
"name": "username",
"description": "An identifier for the user.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Username"
},
"style": "simple"
},
"security.disable_user-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.disable_user_profile-uid": {
"in": "path",
"name": "uid",
"description": "Unique identifier for the user profile.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/security._types.UserProfileId"
},
"style": "simple"
},
"security.disable_user_profile-refresh": {
"in": "query",
"name": "refresh",
"description": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.enable_user-username": {
"in": "path",
"name": "username",
"description": "An identifier for the user.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Username"
},
"style": "simple"
},
"security.enable_user-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.enable_user_profile-uid": {
"in": "path",
"name": "uid",
"description": "A unique identifier for the user profile.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/security._types.UserProfileId"
},
"style": "simple"
},
"security.enable_user_profile-refresh": {
"in": "query",
"name": "refresh",
"description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.get_privileges-application": {
"in": "path",
"name": "application",
"description": "The name of the application.\nApplication privileges are always associated with exactly one application.\nIf you do not specify this parameter, the API returns information about all privileges for all applications.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"security.get_privileges-name": {
"in": "path",
"name": "name",
"description": "The name of the privilege.\nIf you do not specify this parameter, the API returns information about all privileges for the requested application.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"security.get_role-name": {
"in": "path",
"name": "name",
"description": "The name of the role.\nYou can specify multiple roles as a comma-separated list.\nIf you do not specify this parameter, the API returns information about all roles.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"security.get_role-include_implicit": {
"in": "query",
"name": "include_implicit",
"description": "If `true`, include privileges that are implicitly granted by registered `ImplicitPrivilegesProviders` alongside the explicitly configured privileges.\nEach implicit entry in the response is annotated with `implicitly_granted: true`.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 9.5.0",
"style": "form"
},
"security.get_role_mapping-name": {
"in": "path",
"name": "name",
"description": "The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"security.get_service_accounts-namespace": {
"in": "path",
"name": "namespace",
"description": "The name of the namespace.\nOmit this parameter to retrieve information about all service accounts.\nIf you omit this parameter, you must also omit the `service` parameter.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Namespace"
},
"style": "simple"
},
"security.get_service_accounts-service": {
"in": "path",
"name": "service",
"description": "The service name.\nOmit this parameter to retrieve information about all service accounts that belong to the specified `namespace`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Service"
},
"style": "simple"
},
"security.get_user-username": {
"in": "path",
"name": "username",
"description": "An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.",
"required": true,
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/_types.Username"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Username"
}
}
]
},
"style": "simple"
},
"security.get_user-with_profile_uid": {
"in": "query",
"name": "with_profile_uid",
"description": "Determines whether to retrieve the user profile UID, if it exists, for the users.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.5.0",
"style": "form"
},
"security.has_privileges-user": {
"in": "path",
"name": "user",
"description": "Username",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"security.put_privileges-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.put_role-name": {
"in": "path",
"name": "name",
"description": "The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"security.put_role-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.put_role_mapping-name": {
"in": "path",
"name": "name",
"description": "The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"security.put_role_mapping-refresh": {
"in": "query",
"name": "refresh",
"description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.put_user-username": {
"in": "path",
"name": "username",
"description": "An identifier for the user.\n\nNOTE: Usernames must be at least 1 and no more than 507 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block.\nLeading or trailing whitespace is not allowed.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Username"
},
"style": "simple"
},
"security.put_user-refresh": {
"in": "query",
"name": "refresh",
"description": "Valid values are `true`, `false`, and `wait_for`.\nThese values have the same meaning as in the index API, but the default value for this API is true.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"security.query_api_keys-with_limited_by": {
"in": "query",
"name": "with_limited_by",
"description": "Return the snapshot of the owner user's role descriptors associated with the API key.\nAn API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).\nAn API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.5.0",
"style": "form"
},
"security.query_api_keys-with_profile_uid": {
"in": "query",
"name": "with_profile_uid",
"description": "Determines whether to also retrieve the profile UID for the API key owner principal.\nIf it exists, the profile UID is returned under the `profile_uid` response field for each API key.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.14.0",
"style": "form"
},
"security.query_api_keys-typed_keys": {
"in": "query",
"name": "typed_keys",
"description": "Determines whether aggregation names are prefixed by their respective types in the response.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"x-state": "Generally available; Added in 8.14.0",
"style": "form"
},
"security.query_user-with_profile_uid": {
"in": "query",
"name": "with_profile_uid",
"description": "Determines whether to retrieve the user profile UID, if it exists, for the users.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"security.suggest_user_profiles-data": {
"in": "query",
"name": "data",
"description": "A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content, use `data=` to retrieve content nested under the specified ``.\nBy default, the API returns no `data` content.\nIt is an error to specify `data` as both the query parameter and the request body field.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"security.update_user_profile_data-uid": {
"in": "path",
"name": "uid",
"description": "A unique identifier for the user profile.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/security._types.UserProfileId"
},
"style": "simple"
},
"security.update_user_profile_data-if_seq_no": {
"in": "query",
"name": "if_seq_no",
"description": "Only perform the operation if the document has this sequence number.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SequenceNumber"
},
"style": "form"
},
"security.update_user_profile_data-if_primary_term": {
"in": "query",
"name": "if_primary_term",
"description": "Only perform the operation if the document has this primary term.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"security.update_user_profile_data-refresh": {
"in": "query",
"name": "refresh",
"description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Refresh"
},
"style": "form"
},
"simulate.ingest-index": {
"in": "path",
"name": "index",
"description": "The index to simulate ingesting into.\nThis value can be overridden by specifying an index on each document.\nIf you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"simulate.ingest-pipeline": {
"in": "query",
"name": "pipeline",
"description": "The pipeline to use as the default pipeline.\nThis value can be used to override the default pipeline of the index.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.PipelineName"
},
"style": "form"
},
"simulate.ingest-merge_type": {
"in": "query",
"name": "merge_type",
"description": "The mapping merge type if mapping overrides are being provided in mapping_addition.\nThe allowed values are one of index or template.\nThe index option merges mappings the way they would be merged into an existing index.\nThe template option merges mappings the way they would be merged into a template.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/simulate.ingest.MergeType"
},
"style": "form"
},
"slm.get_lifecycle-policy_id": {
"in": "path",
"name": "policy_id",
"description": "A comma-separated list of snapshot lifecycle policy identifiers.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"slm.get_lifecycle-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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"
},
"slm.get_lifecycle-timeout": {
"in": "query",
"name": "timeout",
"description": "The period to wait for a response.\nIf 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"
},
"snapshot.create-repository": {
"in": "path",
"name": "repository",
"description": "The name of the repository for the snapshot.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"snapshot.create-snapshot": {
"in": "path",
"name": "snapshot",
"description": "The name of the snapshot.\nIt supportes date math.\nIt must be unique in the repository.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"snapshot.create-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for a connection to the master node.\nIf 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"
},
"snapshot.create-wait_for_completion": {
"in": "query",
"name": "wait_for_completion",
"description": "If `true`, the request returns a response when the snapshot is complete.\nIf `false`, the request returns a response when the snapshot initializes.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"snapshot.create_repository-repository": {
"in": "path",
"name": "repository",
"description": "The name of the snapshot repository to register or update.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"snapshot.create_repository-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"snapshot.create_repository-timeout": {
"in": "query",
"name": "timeout",
"description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"snapshot.create_repository-verify": {
"in": "query",
"name": "verify",
"description": "If `true`, the request verifies the repository is functional on all master and data nodes in the cluster.\nIf `false`, this verification is skipped.\nYou can also perform this verification with the verify snapshot repository API.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"snapshot.get_repository-repository": {
"in": "path",
"name": "repository",
"description": "A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`.\n\nTo get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"snapshot.get_repository-local": {
"in": "query",
"name": "local",
"description": "If `true`, the request gets information from the local node only.\nIf `false`, the request gets information from the master node.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"snapshot.get_repository-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"snapshot.status-repository": {
"in": "path",
"name": "repository",
"description": "The snapshot repository name used to limit the request.\nIt supports wildcards (`*`) if `` isn't specified.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"snapshot.status-snapshot": {
"in": "path",
"name": "snapshot",
"description": "A comma-separated list of snapshots to retrieve status for.\nThe default is currently running snapshots.\nWildcards (`*`) are not supported.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"snapshot.status-ignore_unavailable": {
"in": "query",
"name": "ignore_unavailable",
"description": "If `false`, the request returns an error for any snapshots that are unavailable.\nIf `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"snapshot.status-master_timeout": {
"in": "query",
"name": "master_timeout",
"description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"sql.query-format": {
"in": "query",
"name": "format",
"description": "The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/sql.query.SqlFormat"
},
"style": "form"
},
"tasks.cancel-task_id": {
"in": "path",
"name": "task_id",
"description": "The task identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.TaskId"
},
"style": "simple"
},
"tasks.cancel-actions": {
"in": "query",
"name": "actions",
"description": "A comma-separated list or wildcard expression of actions that is used to limit the request.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"tasks.cancel-nodes": {
"in": "query",
"name": "nodes",
"description": "A comma-separated list of node IDs or names that is used to limit the request.",
"deprecated": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
"tasks.cancel-parent_task_id": {
"in": "query",
"name": "parent_task_id",
"description": "A parent task ID that is used to limit the tasks.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"tasks.cancel-wait_for_completion": {
"in": "query",
"name": "wait_for_completion",
"description": "If true, the request blocks until all found tasks are complete.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"terms_enum-index": {
"in": "path",
"name": "index",
"description": "A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Indices"
},
"style": "simple"
},
"termvectors-index": {
"in": "path",
"name": "index",
"description": "The name of the index that contains the document.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.IndexName"
},
"style": "simple"
},
"termvectors-id": {
"in": "path",
"name": "id",
"description": "A unique identifier for the document.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"termvectors-fields": {
"in": "query",
"name": "fields",
"description": "A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Fields"
},
"style": "form"
},
"termvectors-field_statistics": {
"in": "query",
"name": "field_statistics",
"description": "If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"termvectors-offsets": {
"in": "query",
"name": "offsets",
"description": "If `true`, the response includes term offsets.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"termvectors-payloads": {
"in": "query",
"name": "payloads",
"description": "If `true`, the response includes term payloads.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"termvectors-positions": {
"in": "query",
"name": "positions",
"description": "If `true`, the response includes term positions.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"termvectors-preference": {
"in": "query",
"name": "preference",
"description": "The node or shard the operation should be performed on.\nIt is random by default.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"termvectors-realtime": {
"in": "query",
"name": "realtime",
"description": "If true, the request is real-time as opposed to near-real-time.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"termvectors-routing": {
"in": "query",
"name": "routing",
"description": "A custom value that is used to route operations to a specific shard.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Routing"
},
"style": "form"
},
"termvectors-term_statistics": {
"in": "query",
"name": "term_statistics",
"description": "If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"termvectors-version": {
"in": "query",
"name": "version",
"description": "If `true`, returns the document version as part of a hit.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionNumber"
},
"style": "form"
},
"termvectors-version_type": {
"in": "query",
"name": "version_type",
"description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionType"
},
"style": "form"
},
"text_structure.find_message_structure-column_names": {
"in": "query",
"name": "column_names",
"description": "If the format is `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.",
"deprecated": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"style": "form"
},
"text_structure.find_message_structure-delimiter": {
"in": "query",
"name": "delimiter",
"description": "If you the format is `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"text_structure.find_message_structure-ecs_compatibility": {
"in": "query",
"name": "ecs_compatibility",
"description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/text_structure._types.EcsCompatibilityType"
},
"style": "form"
},
"text_structure.find_message_structure-explain": {
"in": "query",
"name": "explain",
"description": "If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"text_structure.find_message_structure-format": {
"in": "query",
"name": "format",
"description": "The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/text_structure._types.FormatType"
},
"style": "form"
},
"text_structure.find_message_structure-grok_pattern": {
"in": "query",
"name": "grok_pattern",
"description": "If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.GrokPattern"
},
"style": "form"
},
"text_structure.find_message_structure-quote": {
"in": "query",
"name": "quote",
"description": "If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"text_structure.find_message_structure-should_trim_fields": {
"in": "query",
"name": "should_trim_fields",
"description": "If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"text_structure.find_message_structure-should_parse_recursively": {
"in": "query",
"name": "should_parse_recursively",
"description": "If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"text_structure.find_message_structure-timeout": {
"in": "query",
"name": "timeout",
"description": "The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"text_structure.find_message_structure-timestamp_field": {
"in": "query",
"name": "timestamp_field",
"description": "The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Field"
},
"style": "form"
},
"text_structure.find_message_structure-timestamp_format": {
"in": "query",
"name": "timestamp_format",
"description": "The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"text_structure.test_grok_pattern-ecs_compatibility": {
"in": "query",
"name": "ecs_compatibility",
"description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.",
"deprecated": false,
"schema": {
"type": "string"
},
"style": "form"
},
"transform.get_transform-transform_id": {
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the ``, or by omitting the\n``.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"transform.get_transform-allow_no_match": {
"in": "query",
"name": "allow_no_match",
"description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"transform.get_transform-from": {
"in": "query",
"name": "from",
"description": "Skips the specified number of transforms.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"transform.get_transform-size": {
"in": "query",
"name": "size",
"description": "Specifies the maximum number of transforms to obtain.",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"transform.get_transform-exclude_generated": {
"in": "query",
"name": "exclude_generated",
"description": "Excludes fields that were automatically added when creating the\ntransform. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"transform.preview_transform-transform_id": {
"in": "path",
"name": "transform_id",
"description": "Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"transform.preview_transform-timeout": {
"in": "query",
"name": "timeout",
"description": "Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Duration"
},
"style": "form"
},
"watcher.ack_watch-watch_id": {
"in": "path",
"name": "watch_id",
"description": "The watch identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"watcher.ack_watch-action_id": {
"in": "path",
"name": "action_id",
"description": "A comma-separated list of the action identifiers to acknowledge.\nIf you omit this parameter, all of the actions of the watch are acknowledged.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Names"
},
"style": "simple"
},
"watcher.activate_watch-watch_id": {
"in": "path",
"name": "watch_id",
"description": "The watch identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"watcher.deactivate_watch-watch_id": {
"in": "path",
"name": "watch_id",
"description": "The watch identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Name"
},
"style": "simple"
},
"watcher.execute_watch-id": {
"in": "path",
"name": "id",
"description": "The watch identifier.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"watcher.execute_watch-debug": {
"in": "query",
"name": "debug",
"description": "Defines whether the watch runs in debug mode.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"watcher.put_watch-id": {
"in": "path",
"name": "id",
"description": "The identifier for the watch.",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.Id"
},
"style": "simple"
},
"watcher.put_watch-active": {
"in": "query",
"name": "active",
"description": "The initial state of the watch.\nThe default value is `true`, which means the watch is active by default.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"watcher.put_watch-if_primary_term": {
"in": "query",
"name": "if_primary_term",
"description": "Only update the watch if the last operation that has changed the watch has the specified primary term",
"deprecated": false,
"schema": {
"type": "number"
},
"style": "form"
},
"watcher.put_watch-if_seq_no": {
"in": "query",
"name": "if_seq_no",
"description": "Only update the watch if the last operation that has changed the watch has the specified sequence number",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.SequenceNumber"
},
"style": "form"
},
"watcher.put_watch-version": {
"in": "query",
"name": "version",
"description": "Explicit version number for concurrency control",
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types.VersionNumber"
},
"style": "form"
},
"watcher.stats-metric": {
"in": "path",
"name": "metric",
"description": "Defines which additional metrics are included in the response.\n\nSupported values include: `_all` (or `all`), `queued_watches`, `current_watches`, `pending_watches`\n\n",
"required": true,
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/watcher.stats.WatcherMetric"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher.stats.WatcherMetric"
}
}
]
},
"style": "simple"
},
"watcher.stats-emit_stacktraces": {
"in": "query",
"name": "emit_stacktraces",
"description": "Defines whether stack traces are generated for each watch that is running.",
"deprecated": false,
"schema": {
"type": "boolean"
},
"style": "form"
},
"watcher.stats-metric_": {
"in": "query",
"name": "metric",
"description": "Defines which additional metrics are included in the response.\n\nSupported values include: `_all` (or `all`), `queued_watches`, `current_watches`, `pending_watches`\n\n",
"deprecated": false,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/watcher.stats.WatcherMetric"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/watcher.stats.WatcherMetric"
}
}
]
},
"style": "form"
}
},
"requestBodies": {
"async_search.submit": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"collapse": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FieldCollapse"
}
]
},
"explain": {
"description": "If true, returns detailed information about score computation as part of a hit.",
"default": false,
"type": "boolean"
},
"ext": {
"description": "Configuration of search extensions defined by Elasticsearch plugins.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"from": {
"description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.",
"default": 0,
"type": "number"
},
"highlight": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Highlight"
}
]
},
"track_total_hits": {
"description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.TrackHits"
}
]
},
"indices_boost": {
"description": "Boosts the _score of documents from specified indices.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "number"
},
"minProperties": 1,
"maxProperties": 1
}
},
"docvalue_fields": {
"description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"knn": {
"description": "Defines the approximate kNN search to run.",
"x-state": "Generally available; Added in 8.4.0",
"oneOf": [
{
"$ref": "#/components/schemas/_types.KnnSearch"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.KnnSearch"
}
}
]
},
"min_score": {
"description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in search results and results collected by aggregations.",
"type": "number"
},
"post_filter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"profile": {
"type": "boolean"
},
"query": {
"description": "Defines the search definition using the Query DSL.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"rescore": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.Rescore"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Rescore"
}
}
]
},
"script_fields": {
"description": "Retrieve a script evaluation (based on different fields) for each hit.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ScriptField"
}
},
"search_after": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
},
"size": {
"description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.",
"default": 10,
"type": "number"
},
"slice": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SlicedScroll"
}
]
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"_source": {
"description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"fields": {
"description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"suggest": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Suggester"
}
]
},
"terminate_after": {
"description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.",
"default": 0,
"type": "number"
},
"timeout": {
"description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
"type": "string"
},
"track_scores": {
"description": "If true, calculate and return document scores, even if the scores are not used for sorting.",
"default": false,
"type": "boolean"
},
"version": {
"description": "If true, returns document version as part of a hit.",
"default": false,
"type": "boolean"
},
"seq_no_primary_term": {
"description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.",
"type": "boolean"
},
"stored_fields": {
"description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"pit": {
"description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.PointInTimeReference"
}
]
},
"runtime_mappings": {
"description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"stats": {
"description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"examples": {
"AsyncSearchSubmitRequestExample1": {
"description": "Perform a search request asynchronously with `POST /sales*/_async_search?size=0`. It accepts the same parameters and request body as the search API.\n",
"value": "{\n \"sort\": [\n { \"date\": { \"order\": \"asc\" } }\n ],\n \"aggs\": {\n \"sale_date\": {\n \"date_histogram\": {\n \"field\": \"date\",\n \"calendar_interval\": \"1d\"\n }\n }\n }\n}"
}
}
}
}
},
"bulk": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.bulk.OperationContainer"
},
{
"$ref": "#/components/schemas/_global.bulk.UpdateAction"
},
{
"type": "object"
}
]
}
},
"examples": {
"BulkRequestExample1": {
"summary": "Multiple operations",
"description": "Run `POST _bulk` to perform multiple operations.",
"value": "{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n{ \"delete\" : { \"_index\" : \"test\", \"_id\" : \"2\" } }\n{ \"create\" : { \"_index\" : \"test\", \"_id\" : \"3\" } }\n{ \"field1\" : \"value3\" }\n{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"test\"} }\n{ \"doc\" : {\"field2\" : \"value2\"} }"
},
"BulkRequestExample2": {
"summary": "Bulk updates",
"description": "When you run `POST _bulk` and use the `update` action, you can use `retry_on_conflict` as a field in the action itself (not in the extra payload line) to specify how many times an update should be retried in the case of a version conflict.\n",
"value": "{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"index1\", \"retry_on_conflict\" : 3} }\n{ \"doc\" : {\"field\" : \"value\"} }\n{ \"update\" : { \"_id\" : \"0\", \"_index\" : \"index1\", \"retry_on_conflict\" : 3} }\n{ \"script\" : { \"source\": \"ctx._source.counter += params.param1\", \"lang\" : \"painless\", \"params\" : {\"param1\" : 1}}, \"upsert\" : {\"counter\" : 1}}\n{ \"update\" : {\"_id\" : \"2\", \"_index\" : \"index1\", \"retry_on_conflict\" : 3} }\n{ \"doc\" : {\"field\" : \"value\"}, \"doc_as_upsert\" : true }\n{ \"update\" : {\"_id\" : \"3\", \"_index\" : \"index1\", \"_source\" : true} }\n{ \"doc\" : {\"field\" : \"value\"} }\n{ \"update\" : {\"_id\" : \"4\", \"_index\" : \"index1\"} }\n{ \"doc\" : {\"field\" : \"value\"}, \"_source\": true}"
},
"BulkRequestExample3": {
"summary": "Filter for failed operations",
"description": "To return only information about failed operations, run `POST /_bulk?filter_path=items.*.error`.\n",
"value": "{ \"update\": {\"_id\": \"5\", \"_index\": \"index1\"} }\n{ \"doc\": {\"my_field\": \"foo\"} }\n{ \"update\": {\"_id\": \"6\", \"_index\": \"index1\"} }\n{ \"doc\": {\"my_field\": \"foo\"} }\n{ \"create\": {\"_id\": \"7\", \"_index\": \"index1\"} }\n{ \"my_field\": \"foo\" }"
},
"BulkRequestExample4": {
"summary": "Dynamic templates",
"description": "Run `POST /_bulk` to perform a bulk request that consists of index and create actions with the `dynamic_templates` parameter. The bulk request creates two new fields `work_location` and `home_location` with type `geo_point` according to the `dynamic_templates` parameter. However, the `raw_location` field is created using default dynamic mapping rules, as a text field in that case since it is supplied as a string in the JSON document.\n",
"value": "{ \"index\" : { \"_index\" : \"my_index\", \"_id\" : \"1\", \"dynamic_templates\": {\"work_location\": \"geo_point\"}} }\n{ \"field\" : \"value1\", \"work_location\": \"41.12,-71.34\", \"raw_location\": \"41.12,-71.34\"}\n{ \"create\" : { \"_index\" : \"my_index\", \"_id\" : \"2\", \"dynamic_templates\": {\"home_location\": \"geo_point\"}} }\n{ \"field\" : \"value2\", \"home_location\": \"41.12,-71.34\"}"
}
}
}
},
"required": true
},
"cat.count": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"clear_scroll": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scroll_id": {
"description": "The scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScrollIds"
}
]
}
}
},
"examples": {
"ClearScrollRequestExample1": {
"description": "Run `DELETE /_search/scroll` to clear the search context and results for a scrolling search.",
"value": "{\n \"scroll_id\": \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}"
}
}
}
}
},
"cluster.allocation_explain": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index": {
"description": "The name of the index that you would like an explanation for.",
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"shard": {
"description": "An identifier for the shard that you would like an explanation for.",
"type": "number"
},
"primary": {
"description": "If true, returns an explanation for the primary shard for the specified shard ID.",
"type": "boolean"
},
"current_node": {
"description": "Explain a shard only if it is currently located on the specified node name or node ID.",
"allOf": [
{
"$ref": "#/components/schemas/_types.NodeId"
}
]
}
}
},
"examples": {
"ClusterAllocationExplainRequestExample1": {
"summary": "All parameters in the request body",
"description": "Run `GET _cluster/allocation/explain` to get an explanation for a shard's current allocation.",
"value": "{\n \"index\": \"my-index-000001\",\n \"shard\": 0,\n \"primary\": false,\n \"current_node\": \"my-node\"\n}"
},
"ClusterAllocationExplainRequestExample2": {
"summary": "Query Parameters",
"description": "Run `GET _cluster/allocation/explain?index=my-index-000001&shard=0&primary=false¤t_node=my-node` to get an explanation for a shard's current allocation. No parameters are required in the request body\n",
"value": "{}"
}
}
}
}
},
"cluster.put_component_template": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"template": {
"description": "The template to be applied which includes mappings, settings, or aliases configuration.",
"allOf": [
{
"$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping"
}
]
},
"version": {
"description": "Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"_meta": {
"description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"deprecated": {
"description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.",
"type": "boolean"
}
},
"required": [
"template"
]
},
"examples": {
"ClusterPutComponentTemplateRequestExample1": {
"summary": "Create a template",
"value": "{\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n}"
},
"ClusterPutComponentTemplateRequestExample2": {
"summary": "Create a template with aliases",
"description": "You can include index aliases in a component template. During index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to.\n",
"value": "{\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"aliases\": {\n \"alias1\": {},\n \"alias2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n },\n \"{index}-alias\": {}\n }\n }\n}"
}
}
}
},
"required": true
},
"connector.put": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"index_name": {
"allOf": [
{
"$ref": "#/components/schemas/_types.IndexName"
}
]
},
"is_native": {
"type": "boolean"
},
"language": {
"type": "string"
},
"name": {
"type": "string"
},
"service_type": {
"type": "string"
}
}
},
"examples": {
"ConnectorPutRequestExample1": {
"value": "{\n \"index_name\": \"search-google-drive\",\n \"name\": \"My Connector\",\n \"service_type\": \"google_drive\"\n}"
},
"ConnectorPutRequestExample2": {
"value": "{\n \"index_name\": \"search-google-drive\",\n \"name\": \"My Connector\",\n \"description\": \"My Connector to sync data to Elastic index from Google Drive\",\n \"service_type\": \"google_drive\",\n \"language\": \"english\"\n}"
}
}
}
}
},
"count": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"description": "Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
}
},
"examples": {
"CountRequestExample1": {
"description": "Run `GET /my-index-000001/_count?q=user:kimchy`. Alternatively, run `GET /my-index-000001/_count` with the same query in the request body. Both requests count the number of documents in `my-index-000001` with a `user.id` of `kimchy`.\n",
"value": "{\n \"query\" : {\n \"term\" : { \"user.id\" : \"kimchy\" }\n }\n}"
}
}
}
}
},
"create": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"CreateRequestExample1": {
"description": "Run `PUT my-index-000001/_create/1` to index a document into the `my-index-000001` index if no document with that ID exists.\n",
"value": "{\n \"@timestamp\": \"2099-11-15T13:12:00\",\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n}"
}
}
}
},
"required": true
},
"eql.search": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"description": "EQL query you wish to run.",
"type": "string"
},
"case_sensitive": {
"type": "boolean"
},
"event_category_field": {
"description": "Field containing the event classification, such as process, file, or network.",
"default": "event.category",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"tiebreaker_field": {
"description": "Field used to sort hits with the same timestamp in ascending order",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"timestamp_field": {
"description": "Field containing event timestamp.",
"default": "@timestamp",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"fetch_size": {
"description": "Maximum number of events to search at a time for sequence queries.",
"default": 1000,
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"filter": {
"description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
}
]
},
"keep_alive": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"keep_on_completion": {
"type": "boolean"
},
"wait_for_completion_timeout": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"allow_partial_search_results": {
"description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results",
"default": true,
"type": "boolean"
},
"allow_partial_sequence_results": {
"description": "This flag applies only to sequences and has effect only if allow_partial_search_results=true.\nIf true, the sequence query will return results based on the available shards, ignoring the others.\nIf false, the sequence query will return successfully, but will always have empty results.",
"default": false,
"type": "boolean"
},
"size": {
"description": "For basic queries, the maximum number of matching events to return. Defaults to 10",
"allOf": [
{
"$ref": "#/components/schemas/_types.uint"
}
]
},
"fields": {
"description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.",
"oneOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
}
]
},
"result_position": {
"description": "\n\nSupported values include:\n - `tail`: Return the most recent matches, similar to the Unix tail command.\n - `head`: Return the earliest matches, similar to the Unix head command.\n\n",
"default": "tail",
"allOf": [
{
"$ref": "#/components/schemas/eql.search.ResultPosition"
}
]
},
"runtime_mappings": {
"x-state": "Generally available; Added in 8.0.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"max_samples_per_key": {
"description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.",
"default": 1,
"type": "number"
}
},
"required": [
"query"
]
},
"examples": {
"EqlSearchRequestExample1": {
"summary": "Basic query",
"description": "Run `GET /my-data-stream/_eql/search` to search for events that have a `process.name` of `cmd.exe` and a `process.pid` other than `2013`.\n",
"value": "{\n \"query\": \"\"\"\n process where (process.name == \"cmd.exe\" and process.pid != 2013)\n \"\"\"\n}"
},
"EqlSearchRequestExample2": {
"summary": "Sequence query",
"description": "Run `GET /my-data-stream/_eql/search` to search for a sequence of events. The sequence starts with an event with an `event.category` of `file`, a `file.name` of `cmd.exe`, and a `process.pid` other than `2013`. It is followed by an event with an `event.category` of `process` and a `process.executable` that contains the substring `regsvr32`. These events must also share the same `process.pid` value.\n",
"value": "{\n \"query\": \"\"\"\n sequence by process.pid\n [ file where file.name == \"cmd.exe\" and process.pid != 2013 ]\n [ process where stringContains(process.executable, \"regsvr32\") ]\n \"\"\"\n}"
}
}
}
},
"required": true
},
"explain": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"description": "Defines the search definition using the Query DSL.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
}
},
"examples": {
"ExplainRequestExample1": {
"description": "Run `GET /my-index-000001/_explain/0` with the request body. Alternatively, run `GET /my-index-000001/_explain/0?q=message:elasticsearch`\n",
"value": "{\n \"query\" : {\n \"match\" : { \"message\" : \"elasticsearch\" }\n }\n}"
}
}
}
}
},
"field_caps": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fields": {
"description": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.",
"x-state": "Generally available; Added in 8.5.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"index_filter": {
"description": "Filter indices if the provided query rewrites to `match_none` on every shard.\n\nIMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request.\nFor instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range.\nHowever, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"runtime_mappings": {
"description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.",
"x-state": "Generally available; Added in 7.12.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
}
}
},
"examples": {
"FieldCapabilitiesRequestExample1": {
"description": "Run `POST my-index-*/_field_caps?fields=rating` to get field capabilities and filter indices with a query. Indices that rewrite the provided filter to `match_none` on every shard will be filtered from the response.\n",
"value": "{\n \"index_filter\": {\n \"range\": {\n \"@timestamp\": {\n \"gte\": \"2018\"\n }\n }\n }\n}"
}
}
}
}
},
"fleet.msearch": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.msearch.RequestItem"
}
}
}
},
"required": true
},
"fleet.search": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"collapse": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FieldCollapse"
}
]
},
"explain": {
"description": "If true, returns detailed information about score computation as part of a hit.",
"default": false,
"type": "boolean"
},
"ext": {
"description": "Configuration of search extensions defined by Elasticsearch plugins.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"from": {
"description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.",
"default": 0,
"type": "number"
},
"highlight": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Highlight"
}
]
},
"track_total_hits": {
"description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.TrackHits"
}
]
},
"indices_boost": {
"description": "Boosts the _score of documents from specified indices.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "number"
},
"minProperties": 1,
"maxProperties": 1
}
},
"docvalue_fields": {
"description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"min_score": {
"description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in search results and results collected by aggregations.",
"type": "number"
},
"post_filter": {
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"profile": {
"type": "boolean"
},
"query": {
"description": "Defines the search definition using the Query DSL.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"rescore": {
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.Rescore"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Rescore"
}
}
]
},
"script_fields": {
"description": "Retrieve a script evaluation (based on different fields) for each hit.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ScriptField"
}
},
"search_after": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
},
"size": {
"description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.",
"default": 10,
"type": "number"
},
"slice": {
"allOf": [
{
"$ref": "#/components/schemas/_types.SlicedScroll"
}
]
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"_source": {
"description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"fields": {
"description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"suggest": {
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Suggester"
}
]
},
"terminate_after": {
"description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.",
"default": 0,
"type": "number"
},
"timeout": {
"description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
"type": "string"
},
"track_scores": {
"description": "If true, calculate and return document scores, even if the scores are not used for sorting.",
"default": false,
"type": "boolean"
},
"version": {
"description": "If true, returns document version as part of a hit.",
"default": false,
"type": "boolean"
},
"seq_no_primary_term": {
"description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.",
"type": "boolean"
},
"stored_fields": {
"description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"pit": {
"description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.PointInTimeReference"
}
]
},
"runtime_mappings": {
"description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"stats": {
"description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"required": true
},
"graph.explore": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"connections": {
"description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.",
"allOf": [
{
"$ref": "#/components/schemas/graph._types.Hop"
}
]
},
"controls": {
"description": "Direct the Graph API how to build the graph.",
"allOf": [
{
"$ref": "#/components/schemas/graph._types.ExploreControls"
}
]
},
"query": {
"description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"vertices": {
"description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.",
"type": "array",
"items": {
"$ref": "#/components/schemas/graph._types.VertexDefinition"
}
}
}
},
"examples": {
"GraphExploreRequestExample1": {
"description": "Run `POST clicklogs/_graph/explore` for a basic exploration An initial graph explore query typically begins with a query to identify strongly related terms. Seed the exploration with a query. This example is searching `clicklogs` for people who searched for the term `midi`.Identify the vertices to include in the graph. This example is looking for product codes that are significantly associated with searches for `midi`. Find the connections. This example is looking for other search terms that led people to click on the products that are associated with searches for `midi`.\n",
"value": "{\n \"query\": {\n \"match\": {\n \"query.raw\": \"midi\"\n }\n },\n \"vertices\": [\n {\n \"field\": \"product\"\n }\n ],\n \"connections\": {\n \"vertices\": [\n {\n \"field\": \"query.raw\"\n }\n ]\n }\n}"
}
}
}
},
"required": true
},
"index": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"IndexRequestExample1": {
"summary": "Automate document IDs",
"description": "Run `POST my-index-000001/_doc/` to index a document. When you use the `POST //_doc/` request format, the `op_type` is automatically set to `create` and the index operation generates a unique ID for the document.\n",
"value": "{\n \"@timestamp\": \"2099-11-15T13:12:00\",\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n}"
},
"IndexRequestExample2": {
"summary": "Define document IDs",
"description": "Run `PUT my-index-000001/_doc/1` to insert a JSON document into the `my-index-000001` index with an `_id` of 1.\n",
"value": "{\n \"@timestamp\": \"2099-11-15T13:12:00\",\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n}"
}
}
}
},
"required": true
},
"indices.analyze": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"analyzer": {
"description": "The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.",
"type": "string"
},
"attributes": {
"description": "Array of token attributes used to filter the output of the `explain` parameter.",
"type": "array",
"items": {
"type": "string"
}
},
"char_filter": {
"description": "Array of character filters used to preprocess characters before the tokenizer.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.analysis.CharFilter"
}
},
"explain": {
"description": "If `true`, the response includes token attributes and additional details.",
"default": false,
"type": "boolean"
},
"field": {
"description": "Field used to derive the analyzer.\nTo use this parameter, you must specify an index.\nIf specified, the `analyzer` parameter overrides this value.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"filter": {
"description": "Array of token filters used to apply after the tokenizer.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.analysis.TokenFilter"
}
},
"normalizer": {
"description": "Normalizer to use to convert text into a single token.",
"type": "string"
},
"text": {
"description": "Text to analyze.\nIf an array of strings is provided, it is analyzed as a multi-value field.",
"allOf": [
{
"$ref": "#/components/schemas/indices.analyze.TextToAnalyze"
}
]
},
"tokenizer": {
"description": "Tokenizer to use to convert text into tokens.",
"allOf": [
{
"$ref": "#/components/schemas/_types.analysis.Tokenizer"
}
]
}
}
},
"examples": {
"indicesAnalyzeRequestExample1": {
"summary": "No index specified",
"description": "You can apply any of the built-in analyzers to the text string without specifying an index.",
"value": "{\n \"analyzer\": \"standard\",\n \"text\": \"this is a test\"\n}"
},
"indicesAnalyzeRequestExample2": {
"summary": "An array of text strings",
"description": "If the text parameter is provided as array of strings, it is analyzed as a multi-value field.",
"value": "{\n \"analyzer\": \"standard\",\n \"text\": [\n \"this is a test\",\n \"the second text\"\n ]\n}"
},
"indicesAnalyzeRequestExample3": {
"summary": "Custom analyzer example 1",
"description": "You can test a custom transient analyzer built from tokenizers, token filters, and char filters. Token filters use the filter parameter.",
"value": "{\n \"tokenizer\": \"keyword\",\n \"filter\": [\n \"lowercase\"\n ],\n \"char_filter\": [\n \"html_strip\"\n ],\n \"text\": \"this is a test\"\n}"
},
"indicesAnalyzeRequestExample4": {
"summary": "Custom analyzer example 2",
"description": "Custom tokenizers, token filters, and character filters can be specified in the request body.",
"value": "{\n \"tokenizer\": \"whitespace\",\n \"filter\": [\n \"lowercase\",\n {\n \"type\": \"stop\",\n \"stopwords\": [\n \"a\",\n \"is\",\n \"this\"\n ]\n }\n ],\n \"text\": \"this is a test\"\n}"
},
"indicesAnalyzeRequestExample5": {
"summary": "Derive analyzer from field mapping",
"description": "Run `GET /analyze_sample/_analyze` to run an analysis on the text using the default index analyzer associated with the `analyze_sample` index. Alternatively, the analyzer can be derived based on a field mapping.",
"value": "{\n \"field\": \"obj1.field1\",\n \"text\": \"this is a test\"\n}"
},
"indicesAnalyzeRequestExample6": {
"summary": "Normalizer",
"description": "Run `GET /analyze_sample/_analyze` and supply a normalizer for a keyword field if there is a normalizer associated with the specified index.",
"value": "{\n \"normalizer\": \"my_normalizer\",\n \"text\": \"BaR\"\n}"
},
"indicesAnalyzeRequestExample7": {
"summary": "Explain analysis",
"description": "If you want to get more advanced details, set `explain` to `true`. It will output all token attributes for each token. You can filter token attributes you want to output by setting the `attributes` option. NOTE: The format of the additional detail information is labelled as experimental in Lucene and it may change in the future.\n",
"value": "{\n \"tokenizer\": \"standard\",\n \"filter\": [\n \"snowball\"\n ],\n \"text\": \"detailed output\",\n \"explain\": true,\n \"attributes\": [\n \"keyword\"\n ]\n}"
}
}
}
},
"required": true
},
"indices.clone": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aliases": {
"description": "Aliases for the resulting index.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"settings": {
"description": "Configuration options for the target index.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"examples": {
"indicesCloneRequestExample1": {
"summary": "Clone an existing index.",
"description": "Clone `my_source_index` into a new index called `my_target_index` with `POST /my_source_index/_clone/my_target_index`. The API accepts `settings` and `aliases` parameters for the target index.\n",
"value": "{\n \"settings\": {\n \"index.refresh_interval\": \"2s\"\n },\n \"aliases\": {\n \"my_search_indices\": {}\n }\n}"
}
}
}
}
},
"indices.create_from": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/indices.create_from.CreateFrom"
}
}
}
},
"indices.put_alias": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"filter": {
"description": "Query used to limit documents the alias can access.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"index_routing": {
"description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.",
"type": "string"
},
"is_write_index": {
"description": "If `true`, sets the write index or data stream for the alias.\nIf an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.\nIf an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.\nData stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.",
"type": "boolean"
},
"routing": {
"description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.",
"type": "string"
},
"search_routing": {
"description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.",
"type": "string"
}
}
},
"examples": {
"indicesPutAliasRequestExample1": {
"summary": "Filter an alias",
"description": "The filter option uses Query DSL to limit the documents an alias can access.",
"value": "{\n \"filter\": {\n \"bool\": {\n \"filter\": [\n {\n \"range\": {\n \"@timestamp\": {\n \"gte\": \"now-1d/d\",\n \"lt\": \"now/d\"\n }\n }\n },\n {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n ]\n }\n }\n}"
},
"indicesPutAliasRequestExample2": {
"summary": "Write index",
"description": "You can use is_write_index to specify a write index or data stream for an alias. Elasticsearch routes any write requests for the alias to this index or data stream.",
"value": "{\n \"is_write_index\": true\n}"
},
"indicesPutAliasRequestExample3": {
"summary": "Routing",
"description": "Use the routing option to route requests for an alias to a specific shard.",
"value": "{\n \"routing\": \"1\"\n}"
}
}
}
}
},
"indices.put_index_template": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index_patterns": {
"description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"composed_of": {
"description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Name"
}
},
"template": {
"description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.",
"allOf": [
{
"$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping"
}
]
},
"data_stream": {
"description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamVisibility"
}
]
},
"priority": {
"description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.",
"type": "number"
},
"version": {
"description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"_meta": {
"description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"allow_auto_create": {
"description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.",
"type": "boolean"
},
"ignore_missing_component_templates": {
"description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist",
"type": "array",
"items": {
"type": "string"
}
},
"deprecated": {
"description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.",
"type": "boolean"
}
}
},
"examples": {
"IndicesPutIndexTemplateRequestExample1": {
"summary": "Create a template",
"value": "{\n \"index_patterns\" : [\"template*\"],\n \"priority\" : 1,\n \"template\": {\n \"settings\" : {\n \"number_of_shards\" : 2\n }\n }\n}"
},
"IndicesPutIndexTemplateRequestExample2": {
"summary": "Create a template with aliases",
"description": "You can include index aliases in an index template.\nDuring index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to.\n",
"value": "{\n \"index_patterns\": [\n \"template*\"\n ],\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"aliases\": {\n \"alias1\": {},\n \"alias2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n },\n \"{index}-alias\": {}\n }\n }\n}"
}
}
}
},
"required": true
},
"indices.put_mapping": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"date_detection": {
"description": "Controls whether dynamic date detection is enabled.",
"type": "boolean"
},
"dynamic": {
"description": "Controls whether new fields are added dynamically.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.DynamicMapping"
}
]
},
"dynamic_date_formats": {
"description": "If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.",
"type": "array",
"items": {
"type": "string"
}
},
"dynamic_templates": {
"description": "Specify dynamic templates for the mapping.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.DynamicTemplate"
},
"minProperties": 1,
"maxProperties": 1
}
},
"_field_names": {
"description": "Control whether field names are enabled for the index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.FieldNamesField"
}
]
},
"_meta": {
"description": "A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"numeric_detection": {
"description": "Automatically map strings into numeric data types for all fields.",
"default": false,
"type": "boolean"
},
"properties": {
"description": "Mapping for a field. For new fields, this mapping can include:\n\n- Field name\n- Field data type\n- Mapping parameters",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.mapping.Property"
}
},
"_routing": {
"description": "Enable making a routing value required on indexed documents.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RoutingField"
}
]
},
"_source": {
"description": "Control whether the _source field is enabled on the index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.SourceField"
}
]
},
"runtime": {
"description": "Mapping of runtime fields for the index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
}
}
},
"examples": {
"indicesPutMappingRequestExample1": {
"summary": "Update multiple targets",
"description": "The update mapping API can be applied to multiple data streams or indices with a single request. For example, run `PUT /my-index-000001,my-index-000002/_mapping` to update mappings for the `my-index-000001` and `my-index-000002` indices at the same time.\n",
"value": "{\n \"properties\": {\n \"user\": {\n \"properties\": {\n \"name\": {\n \"type\": \"keyword\"\n }\n }\n }\n }\n}"
}
}
}
},
"required": true
},
"indices.put_settings": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/indices._types.IndexSettings"
},
"examples": {
"IndicesPutSettingsRequestExample1": {
"summary": "Change a dynamic index setting",
"value": "{\n \"index\" : {\n \"number_of_replicas\" : 2\n }\n}"
},
"indicesPutSettingsRequestExample2": {
"summary": "Reset an index setting",
"description": "To revert a setting to the default value, use `null`.",
"value": "{\n \"index\" : {\n \"refresh_interval\" : null\n }\n}"
},
"indicesPutSettingsRequestExample3": {
"summary": "Update index analysis",
"description": "To add an analyzer, you must close the index (`POST /my-index-000001/_close`), define the analyzer, then reopen the index (`POST /my-index-000001/_open`).",
"value": "{\n \"analysis\": {\n \"analyzer\": {\n \"content\": {\n \"type\": \"custom\",\n \"tokenizer\": \"whitespace\"\n }\n }\n }\n}"
}
}
}
},
"required": true
},
"indices.put_template": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aliases": {
"description": "Aliases for the index.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"index_patterns": {
"description": "Array of wildcard expressions used to match the names\nof indices during creation.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"mappings": {
"description": "Mapping for fields in the index.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"order": {
"description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.",
"type": "number"
},
"settings": {
"description": "Configuration options for the index.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.IndexSettings"
}
]
},
"version": {
"description": "Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.\nTo unset a version, replace the template without specifying one.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
}
}
},
"examples": {
"indicesPutTemplateRequestExample1": {
"summary": "Create an index template",
"value": "{\n \"index_patterns\": [\n \"te*\",\n \"bar*\"\n ],\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n}"
},
"indicesPutTemplateRequestExample2": {
"summary": "Create an index template with aliases",
"description": "You can include index aliases in an index template. During index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to.\n",
"value": "{\n \"index_patterns\": [\n \"te*\"\n ],\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"aliases\": {\n \"alias1\": {},\n \"alias2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n },\n \"{index}-alias\": {}\n }\n}"
}
}
}
},
"required": true
},
"indices.resolve_index": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"indices.rollover": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aliases": {
"description": "Aliases for the target index.\nData streams do not support this parameter.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"conditions": {
"description": "Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.",
"allOf": [
{
"$ref": "#/components/schemas/indices.rollover.RolloverConditions"
}
]
},
"mappings": {
"description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping paramaters.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"settings": {
"description": "Configuration options for the index.\nData streams do not support this parameter.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"examples": {
"indicesRolloverRequestExample1": {
"summary": "Stack request",
"description": "Create a new index for a data stream",
"value": "{\n \"conditions\": {\n \"max_age\": \"7d\",\n \"max_docs\": 1000,\n \"max_primary_shard_size\": \"50gb\",\n \"max_primary_shard_docs\": \"2000\"\n }\n}"
},
"indicesRolloverRequestExample2": {
"summary": "Serverless request",
"description": "Create a new index for a data stream",
"value": "{}"
}
}
}
}
},
"indices.shrink": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aliases": {
"description": "The key is the alias name.\nIndex alias names support date math.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"settings": {
"description": "Configuration options for the target index.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"examples": {
"indicesShrinkRequestExample1": {
"summary": "Shrink an existing index into a new index with fewer primary shards.",
"value": "{\n \"settings\": {\n \"index.routing.allocation.require._name\": null,\n \"index.blocks.write\": null\n }\n}"
}
}
}
},
"required": true
},
"indices.simulate_template": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"allow_auto_create": {
"description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.",
"type": "boolean"
},
"index_patterns": {
"description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"composed_of": {
"description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Name"
}
},
"template": {
"description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.",
"allOf": [
{
"$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping"
}
]
},
"data_stream": {
"description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.",
"allOf": [
{
"$ref": "#/components/schemas/indices._types.DataStreamVisibility"
}
]
},
"priority": {
"description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.",
"type": "number"
},
"version": {
"description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"_meta": {
"description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"ignore_missing_component_templates": {
"description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist",
"type": "array",
"items": {
"type": "string"
}
},
"deprecated": {
"description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.",
"type": "boolean"
}
}
},
"examples": {
"indicesSimulateTemplateRequestExample1": {
"description": "To see what settings will be applied by a template before you add it to the cluster, you can pass a template configuration in the request body. The specified template is used for the simulation if it has a higher priority than existing templates.\n",
"value": "{\n \"index_patterns\": [\"my-index-*\"],\n \"composed_of\": [\"ct2\"],\n \"priority\": 10,\n \"template\": {\n \"settings\": {\n \"index.number_of_replicas\": 1\n }\n }\n}"
}
}
}
}
},
"indices.split": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aliases": {
"description": "Aliases for the resulting index.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.Alias"
}
},
"settings": {
"description": "Configuration options for the target index.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"examples": {
"indicesSplitRequestExample1": {
"description": "Split an existing index into a new index with more primary shards.",
"value": "{\n \"settings\": {\n \"index.number_of_shards\": 2\n }\n}"
}
}
}
},
"required": true
},
"indices.validate_query": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"description": "Query in the Lucene query string syntax.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
}
}
}
}
}
},
"inference.inference": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.",
"type": "string"
},
"input": {
"description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"input_type": {
"description": "Specifies the input data type for the embedding model. The `input_type` parameter only applies to Inference Endpoints with the `embedding` or `text_embedding` task type. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\nNot all services support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.",
"type": "string"
},
"task_settings": {
"description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.",
"allOf": [
{
"$ref": "#/components/schemas/inference._types.TaskSettings"
}
]
}
},
"required": [
"input"
]
}
}
},
"required": true
},
"inference.put": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
"examples": {
"InferencePutExample1": {
"description": "An example body for a `PUT _inference/rerank/my-rerank-model` request.",
"value": "{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n}"
}
}
}
},
"required": true
},
"inference.update": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inference._types.InferenceEndpoint"
},
"examples": {
"InferenceUpdateExample1": {
"description": "An example body for a `PUT _inference/my-inference-endpoint/_update` request.",
"value": "{\n \"service_settings\": {\n \"api_key\": \"\"\n },\n\"service\": \"example-service\"\n}"
}
}
}
},
"required": true
},
"ingest.simulate": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"description": "Sample documents to test in the pipeline.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.Document"
}
},
"pipeline": {
"description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.",
"allOf": [
{
"$ref": "#/components/schemas/ingest._types.Pipeline"
}
]
}
},
"required": [
"docs"
]
},
"examples": {
"SimulatePipelineRequestExample1": {
"summary": "Run an ingest pipeline against a set of provided documents.",
"description": "You can specify the used pipeline either in the request body or as a path parameter.",
"value": "{\n \"pipeline\" :\n {\n \"description\": \"_description\",\n \"processors\": [\n {\n \"set\" : {\n \"field\" : \"field2\",\n \"value\" : \"_value\"\n }\n }\n ]\n },\n \"docs\": [\n {\n \"_index\": \"index\",\n \"_id\": \"id\",\n \"_source\": {\n \"foo\": \"bar\"\n }\n },\n {\n \"_index\": \"index\",\n \"_id\": \"id\",\n \"_source\": {\n \"foo\": \"rab\"\n }\n }\n ]\n}"
}
}
}
},
"required": true
},
"license.post": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"license": {
"allOf": [
{
"$ref": "#/components/schemas/license._types.License"
}
]
},
"licenses": {
"description": "A sequence of one or more JSON documents containing the license information.",
"type": "array",
"items": {
"$ref": "#/components/schemas/license._types.License"
}
}
}
},
"examples": {
"PostLicenseRequestExample1": {
"description": "Run `PUT _license` to update to a basic license. NOTE: These values are invalid; you must substitute the appropriate contents from your license file.\n",
"value": "{\n \"licenses\": [\n {\n \"uid\":\"893361dc-9749-4997-93cb-802e3d7fa4xx\",\n \"type\":\"basic\",\n \"issue_date_in_millis\":1411948800000,\n \"expiry_date_in_millis\":1914278399999,\n \"max_nodes\":1,\n \"issued_to\":\"issuedTo\",\n \"issuer\":\"issuer\",\n \"signature\":\"xx\"\n }\n ]\n}"
}
}
}
}
},
"mget": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"description": "The documents you want to retrieve. Required if no index is specified in the request URI.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.mget.Operation"
}
},
"ids": {
"description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Ids"
}
]
}
}
},
"examples": {
"MultiGetRequestExample1": {
"summary": "Get documents by ID",
"description": "Run `GET /my-index-000001/_mget`. When you specify an index in the request URI, only the document IDs are required in the request body.\n",
"value": "{\n \"docs\": [\n {\n \"_id\": \"1\"\n },\n {\n \"_id\": \"2\"\n }\n ]\n}"
},
"MultiGetRequestExample2": {
"summary": "Filter source fields",
"description": "Run `GET /_mget`. This request sets `_source` to `false` for document 1 to exclude the source entirely. It retrieves `field3` and `field4` from document 2. It retrieves the `user` field from document 3 but filters out the `user.location` field.\n",
"value": "{\n \"docs\": [\n {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"_source\": false\n },\n {\n \"_index\": \"test\",\n \"_id\": \"2\",\n \"_source\": [ \"field3\", \"field4\" ]\n },\n {\n \"_index\": \"test\",\n \"_id\": \"3\",\n \"_source\": {\n \"include\": [ \"user\" ],\n \"exclude\": [ \"user.location\" ]\n }\n }\n ]\n}"
},
"MultiGetRequestExample3": {
"summary": "Get stored fields",
"description": "Run `GET /_mget`. This request retrieves `field1` and `field2` from document 1 and `field3` and `field4` from document 2.\n",
"value": "{\n \"docs\": [\n {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"stored_fields\": [ \"field1\", \"field2\" ]\n },\n {\n \"_index\": \"test\",\n \"_id\": \"2\",\n \"stored_fields\": [ \"field3\", \"field4\" ]\n }\n ]\n}"
},
"MultiGetRequestExample4": {
"summary": "Document routing",
"description": "Run `GET /_mget?routing=key1`. If routing is used during indexing, you need to specify the routing value to retrieve documents. This request fetches `test/_doc/2` from the shard corresponding to routing key `key1`. It fetches `test/_doc/1` from the shard corresponding to routing key `key2`.\n",
"value": "{\n \"docs\": [\n {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"routing\": \"key2\"\n },\n {\n \"_index\": \"test\",\n \"_id\": \"2\"\n }\n ]\n}"
}
}
}
},
"required": true
},
"ml.delete_expired_data": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requests_per_second": {
"description": "The desired requests per second for the deletion processes. The default\nbehavior is no throttling.",
"type": "number"
},
"timeout": {
"description": "How long can the underlying delete processes run until they are canceled.",
"default": "8h",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
}
}
}
},
"ml.explain_data_frame_analytics": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"source": {
"description": "The configuration of how to source the analysis data. It requires an\nindex. Optionally, query and _source may be specified.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource"
}
]
},
"dest": {
"description": "The destination configuration, consisting of index and optionally\nresults_field (ml by default).",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination"
}
]
},
"analysis": {
"description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer"
}
]
},
"description": {
"description": "A description of the job.",
"type": "string"
},
"model_memory_limit": {
"description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to\ncreate data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.",
"default": "1gb",
"type": "string"
},
"max_num_threads": {
"description": "The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.",
"default": 1,
"type": "number"
},
"analyzed_fields": {
"description": "Specify includes and/or excludes patterns to select which fields will be\nincluded in the analysis. The patterns specified in excludes are applied\nlast, therefore excludes takes precedence. In other words, if the same\nfield is specified in both includes and excludes, then the field will not\nbe included in the analysis.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields"
}
]
},
"allow_lazy_start": {
"description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.",
"default": false,
"type": "boolean"
}
}
},
"examples": {
"MlExplainDataFrameAnalyticsRequestExample1": {
"description": "Run `POST _ml/data_frame/analytics/_explain` to explain a data frame analytics job configuration.",
"value": "{\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n}"
}
}
}
}
},
"ml.get_buckets": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"anomaly_score": {
"description": "Refer to the description for the `anomaly_score` query parameter.",
"default": 0,
"type": "number"
},
"desc": {
"description": "Refer to the description for the `desc` query parameter.",
"default": false,
"type": "boolean"
},
"end": {
"description": "Refer to the description for the `end` query parameter.",
"default": "-1",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"exclude_interim": {
"description": "Refer to the description for the `exclude_interim` query parameter.",
"default": false,
"type": "boolean"
},
"expand": {
"description": "Refer to the description for the `expand` query parameter.",
"default": false,
"type": "boolean"
},
"page": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Page"
}
]
},
"sort": {
"description": "Refer to the desription for the `sort` query parameter.",
"default": "timestamp",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"start": {
"description": "Refer to the description for the `start` query parameter.",
"default": "-1",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
}
},
"examples": {
"MlGetBucketsExample1": {
"description": "An example body for a `GET _ml/anomaly_detectors/low_request_rate/results/buckets` request.",
"value": "{\n \"anomaly_score\": 80,\n \"start\": \"1454530200001\"\n}"
}
}
}
}
},
"ml.get_calendars": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"description": "This object is supported only when you omit the calendar identifier.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Page"
}
]
}
}
}
}
}
},
"ml.get_categories": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"description": "Configures pagination.\nThis parameter has the `from` and `size` properties.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Page"
}
]
}
}
},
"examples": {
"MlGetCategoriesExample1": {
"description": "An example body for a `GET _ml/anomaly_detectors/esxi_log/results/categories` request.",
"value": "{\n \"page\":{\n \"size\": 1\n }\n}"
}
}
}
}
},
"ml.get_influencers": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"description": "Configures pagination.\nThis parameter has the `from` and `size` properties.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Page"
}
]
}
}
}
}
}
},
"ml.get_model_snapshots": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"desc": {
"description": "Refer to the description for the `desc` query parameter.",
"default": false,
"type": "boolean"
},
"end": {
"description": "Refer to the description for the `end` query parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"page": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Page"
}
]
},
"sort": {
"description": "Refer to the description for the `sort` query parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"start": {
"description": "Refer to the description for the `start` query parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
}
},
"examples": {
"MlGetModelSnapshotsExample1": {
"description": "An example body for a `GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots` request.",
"value": "{\n \"start\": \"1575402236000\"\n}"
}
}
}
}
},
"ml.get_overall_buckets": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"allow_no_match": {
"description": "Refer to the description for the `allow_no_match` query parameter.",
"default": true,
"type": "boolean"
},
"bucket_span": {
"description": "Refer to the description for the `bucket_span` query parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"end": {
"description": "Refer to the description for the `end` query parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"exclude_interim": {
"description": "Refer to the description for the `exclude_interim` query parameter.",
"default": false,
"type": "boolean"
},
"overall_score": {
"description": "Refer to the description for the `overall_score` query parameter.",
"type": "number"
},
"start": {
"description": "Refer to the description for the `start` query parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"top_n": {
"description": "Refer to the description for the `top_n` query parameter.",
"default": 1,
"type": "number"
}
}
},
"examples": {
"MlGetOverallBucketsExample1": {
"description": "An example body for a `GET _ml/anomaly_detectors/job-*/results/overall_buckets` request.",
"value": "{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}"
}
}
}
}
},
"ml.get_records": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"desc": {
"description": "Refer to the description for the `desc` query parameter.",
"default": false,
"type": "boolean"
},
"end": {
"description": "Refer to the description for the `end` query parameter.",
"default": "-1",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
},
"exclude_interim": {
"description": "Refer to the description for the `exclude_interim` query parameter.",
"default": false,
"type": "boolean"
},
"page": {
"allOf": [
{
"$ref": "#/components/schemas/ml._types.Page"
}
]
},
"record_score": {
"description": "Refer to the description for the `record_score` query parameter.",
"default": 0,
"type": "number"
},
"sort": {
"description": "Refer to the description for the `sort` query parameter.",
"default": "record_score",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"start": {
"description": "Refer to the description for the `start` query parameter.",
"default": "-1",
"allOf": [
{
"$ref": "#/components/schemas/_types.DateTime"
}
]
}
}
},
"examples": {
"MlGetRecordsExample1": {
"description": "An example body for a `GET _ml/anomaly_detectors/low_request_rate/results/records` request.",
"value": "{\n \"sort\": \"record_score\",\n \"desc\": true,\n \"start\": \"1454944100000\"\n}"
}
}
}
}
},
"ml.preview_data_frame_analytics": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"config": {
"description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.",
"allOf": [
{
"$ref": "#/components/schemas/ml.preview_data_frame_analytics.DataframePreviewConfig"
}
]
}
}
},
"examples": {
"MlPreviewDataFrameAnalyticsExample1": {
"description": "An example body for a `POST _ml/data_frame/analytics/_preview` request.",
"value": "{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}"
}
}
}
}
},
"ml.preview_datafeed": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"datafeed_config": {
"description": "The datafeed definition to preview.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.DatafeedConfig"
}
]
},
"job_config": {
"description": "The configuration details for the anomaly detection job that is associated with the datafeed. If the\n`datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must\nsupply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is\nused. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object.",
"allOf": [
{
"$ref": "#/components/schemas/ml._types.JobConfig"
}
]
}
}
}
}
}
},
"msearch": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.msearch.RequestItem"
}
},
"examples": {
"MsearchRequestExample1": {
"description": "An example body for a `GET my-index-000001/_msearch` request.",
"value": "{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}"
}
}
}
},
"required": true
},
"msearch_template": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.msearch_template.RequestItem"
}
},
"examples": {
"MultiSearchTemplateRequestExample1": {
"description": "Run `GET my-index/_msearch/template` to run multiple templated searches.",
"value": "{ }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}"
}
}
}
},
"required": true
},
"mtermvectors": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"description": "An array of existing or artificial documents.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.mtermvectors.Operation"
}
},
"ids": {
"description": "A simplified syntax to specify documents by their ID if they're in the same index.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Id"
}
}
}
},
"examples": {
"MultiTermVectorsRequestExample1": {
"summary": "Get multiple term vectors",
"description": "Run `POST /my-index-000001/_mtermvectors`. When you specify an index in the request URI, the index does not need to be specified for each documents in the request body.\n",
"value": "{\n \"docs\": [\n {\n \"_id\": \"2\",\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n },\n {\n \"_id\": \"1\"\n }\n ]\n}"
},
"MultiTermVectorsRequestExample2": {
"summary": "Simplified syntax",
"description": "Run `POST /my-index-000001/_mtermvectors`. If all requested documents are in same index and the parameters are the same, you can use a simplified syntax.\n",
"value": "{\n \"ids\": [ \"1\", \"2\" ],\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n}"
},
"MultiTermVectorsRequestExample3": {
"summary": "Artificial documents",
"description": "Run `POST /_mtermvectors` to generate term vectors for artificial documents provided in the body of the request. The mapping used is determined by the specified `_index`.\n",
"value": "{\n \"docs\": [\n {\n \"_index\": \"my-index-000001\",\n \"doc\" : {\n \"message\" : \"test test test\"\n }\n },\n {\n \"_index\": \"my-index-000001\",\n \"doc\" : {\n \"message\" : \"Another test ...\"\n }\n }\n ]\n}"
}
}
}
}
},
"nodes.reload_secure_settings": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"secure_settings_password": {
"description": "The password for the Elasticsearch keystore.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Password"
}
]
}
}
},
"examples": {
"ReloadSecureSettingsRequestExample1": {
"description": "Run `POST _nodes/reload_secure_settings` to reload the keystore on nodes in the cluster.",
"value": "{\n \"secure_settings_password\": \"keystore-password\"\n}"
}
}
}
}
},
"put_script": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"script": {
"description": "The script or search template, its parameters, and its language.",
"allOf": [
{
"$ref": "#/components/schemas/_types.StoredScript"
}
]
}
},
"required": [
"script"
]
},
"examples": {
"PutScriptRequestExample1": {
"summary": "Create a search template",
"description": "Run `PUT _scripts/my-search-template` to create a search template.\n",
"value": "{\n \"script\": {\n \"lang\": \"mustache\",\n \"source\": {\n \"query\": {\n \"match\": {\n \"message\": \"{{query_string}}\"\n }\n },\n \"from\": \"{{from}}\",\n \"size\": \"{{size}}\"\n }\n }\n}"
},
"PutScriptRequestExample2": {
"summary": "Create a stored script",
"description": "Run `PUT _scripts/my-stored-script` to create a stored script.\n",
"value": "{\n \"script\": {\n \"lang\": \"painless\",\n \"source\": \"Math.log(_score * 2) + params['my_modifier']\"\n }\n}"
}
}
}
},
"required": true
},
"rank_eval": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requests": {
"description": "A set of typical search requests, together with their provided ratings.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.rank_eval.RankEvalRequestItem"
}
},
"metric": {
"description": "Definition of the evaluation metric to calculate.",
"allOf": [
{
"$ref": "#/components/schemas/_global.rank_eval.RankEvalMetric"
}
]
}
},
"required": [
"requests"
]
},
"examples": {
"RankEvalRequestExample1": {
"description": "An example body for a `GET /my-index-000001/_rank_eval` request.",
"value": "{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}"
}
}
}
},
"required": true
},
"render_search_template": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"description": "The ID of the search template to render.\nIf no `source` is specified, this or the `` request path parameter is required.\nIf you specify both this parameter and the `` parameter, the API uses only ``.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"file": {
"type": "string"
},
"params": {
"description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"source": {
"description": "An inline search template.\nIt supports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSource"
}
]
}
}
},
"examples": {
"RenderSearchTemplateRequestExample1": {
"description": "Run `POST _render/template`",
"value": "{\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 20,\n \"size\": 10\n }\n}"
}
}
}
},
"required": true
},
"rollup.rollup_search": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregations": {
"externalDocs": {
"url": "https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-aggregation-limitations"
},
"description": "Specifies aggregations.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"query": {
"externalDocs": {
"url": "https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-search-limitations"
},
"description": "Specifies a DSL query that is subject to some limitations.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"size": {
"description": "Must be zero if set, as rollups work on pre-aggregated data.",
"type": "number"
}
}
},
"examples": {
"RollupSearchRequestExample1": {
"description": "Search rolled up data stored in `sensor_rollup` with `GET /sensor_rollup/_rollup_search`",
"value": "{\n \"size\": 0,\n \"aggregations\": {\n \"max_temperature\": {\n \"max\": {\n \"field\": \"temperature\"\n }\n }\n }\n}"
}
}
}
},
"required": true
},
"scripts_painless_execute": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"context": {
"description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.\n\nSupported values include:\n - `painless_test`: The default context if no other context is specified.\n - `filter`: Treats scripts as if they were run inside a script query.\n - `score`: Treats scripts as if they were run inside a `script_score` function in a `function_score` query.\n - `boolean_field`: The context for boolean fields. The script returns a `true` or `false` response.\n - `date_field`: The context for date fields. `emit` takes a long value and the script returns a sorted list of dates.\n - `double_field`: The context for double numeric fields. The script returns a sorted list of double values.\n - `geo_point_field`: The context for geo-point fields. `emit` takes two double parameters, the latitude and longitude values, and the script returns an object in GeoJSON format containing the coordinates for the geo point.\n - `ip_field`: The context for `ip` fields. The script returns a sorted list of IP addresses.\n - `keyword_field`: The context for keyword fields. The script returns a sorted list of string values.\n - `long_field`: The context for long numeric fields. The script returns a sorted list of long values.\n - `composite_field`: The context for composite runtime fields. The script returns a map of values.\n\n",
"default": "painless_test",
"allOf": [
{
"$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContext"
}
]
},
"context_setup": {
"description": "Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.",
"allOf": [
{
"$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContextSetup"
}
]
},
"script": {
"description": "The Painless script to run.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Script"
}
]
}
}
},
"examples": {
"ExecutePainlessScriptRequestExample1": {
"summary": "Test context",
"description": "Run `POST /_scripts/painless/_execute`. The `painless_test` context is the default context. It runs scripts without additional parameters. The only variable that is available is `params`, which can be used to access user defined values. The result of the script is always converted to a string.\n",
"value": "{\n \"script\": {\n \"source\": \"params.count / params.total\",\n \"params\": {\n \"count\": 100.0,\n \"total\": 1000.0\n }\n }\n}"
},
"ExecutePainlessScriptRequestExample2": {
"summary": "Filter context",
"description": "Run `POST /_scripts/painless/_execute` with a `filter` context. It treats scripts as if they were run inside a script query. For testing purposes, a document must be provided so that it will be temporarily indexed in-memory and is accessible from the script. More precisely, the `_source`, stored fields, and doc values of such a document are available to the script being tested.\n",
"value": "{\n \"script\": {\n \"source\": \"doc['field'].value.length() <= params.max_length\",\n \"params\": {\n \"max_length\": 4\n }\n },\n \"context\": \"filter\",\n \"context_setup\": {\n \"index\": \"my-index-000001\",\n \"document\": {\n \"field\": \"four\"\n }\n }\n}"
},
"ExecutePainlessScriptRequestExample3": {
"summary": "Score context",
"description": "Run `POST /_scripts/painless/_execute` with a `score` context. It treats scripts as if they were run inside a `script_score` function in a `function_score` query.\n",
"value": "{\n \"script\": {\n \"source\": \"doc['rank'].value / params.max_rank\",\n \"params\": {\n \"max_rank\": 5.0\n }\n },\n \"context\": \"score\",\n \"context_setup\": {\n \"index\": \"my-index-000001\",\n \"document\": {\n \"rank\": 4\n }\n }\n}"
}
}
}
},
"required": true
},
"scroll": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scroll": {
"description": "The period to retain the search context for scrolling.",
"default": "1d",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"scroll_id": {
"description": "The scroll ID of the search.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScrollId"
}
]
}
},
"required": [
"scroll_id"
]
},
"examples": {
"ScrollRequestExample1": {
"description": "Run `GET /_search/scroll` to get the next batch of results for a scrolling search.",
"value": "{\n \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}"
}
}
}
}
},
"search": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregations": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations"
},
"description": "Defines the aggregations that are run as part of the search request.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"collapse": {
"description": "Collapses search results the values of the specified field.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.FieldCollapse"
}
]
},
"explain": {
"description": "If `true`, the request returns detailed information about score computation as part of a hit.",
"default": false,
"type": "boolean"
},
"ext": {
"description": "Configuration of search extensions defined by Elasticsearch plugins.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"from": {
"description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"default": 0,
"type": "number"
},
"highlight": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting"
},
"description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Highlight"
}
]
},
"track_total_hits": {
"description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.",
"default": "10000",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.TrackHits"
}
]
},
"indices_boost": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores"
},
"description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "number"
},
"minProperties": 1,
"maxProperties": 1
}
},
"docvalue_fields": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields"
},
"description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"knn": {
"externalDocs": {
"url": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn"
},
"description": "The approximate kNN search to run.",
"x-state": "Generally available; Added in 8.4.0",
"oneOf": [
{
"$ref": "#/components/schemas/_types.KnnSearch"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.KnnSearch"
}
}
]
},
"rank": {
"description": "The Reciprocal Rank Fusion (RRF) to use.",
"x-state": "Generally available; Added in 8.8.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.RankContainer"
}
]
},
"min_score": {
"description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results and results collected by aggregations.",
"type": "number"
},
"post_filter": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/filter-search-results"
},
"description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"profile": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-profile"
},
"description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.",
"default": false,
"type": "boolean"
},
"query": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl"
},
"description": "The search definition using the Query DSL.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"rescore": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/rescore-search-results"
},
"description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.",
"oneOf": [
{
"$ref": "#/components/schemas/_global.search._types.Rescore"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/_global.search._types.Rescore"
}
}
]
},
"retriever": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers"
},
"description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.",
"x-state": "Generally available; Added in 8.14.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.RetrieverContainer"
}
]
},
"script_fields": {
"description": "Retrieve a script evaluation (based on different fields) for each hit.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.ScriptField"
}
},
"search_after": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after"
},
"description": "Used to retrieve the next page of hits using a set of sort values from the previous page.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
},
"size": {
"description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.",
"default": 10,
"type": "number"
},
"slice": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#slice-scroll"
},
"description": "Split a scrolled search into multiple slices that can be consumed independently.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SlicedScroll"
}
]
},
"sort": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results"
},
"description": "A comma-separated list of : pairs.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"_source": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering"
},
"description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.SourceConfig"
}
]
},
"fields": {
"description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
}
},
"suggest": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-suggesters"
},
"description": "Defines a suggester that provides similar looking terms based on a provided text.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.Suggester"
}
]
},
"terminate_after": {
"description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.",
"default": 0,
"type": "number"
},
"timeout": {
"description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
"type": "string"
},
"track_scores": {
"description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.",
"default": false,
"type": "boolean"
},
"version": {
"description": "If `true`, the request returns the document version as part of a hit.",
"default": false,
"type": "boolean"
},
"seq_no_primary_term": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control"
},
"description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.",
"type": "boolean"
},
"stored_fields": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields"
},
"description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"pit": {
"description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.PointInTimeReference"
}
]
},
"runtime_mappings": {
"externalDocs": {
"url": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request"
},
"description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"stats": {
"description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"examples": {
"SearchRequestExample1": {
"summary": "A simple term search",
"description": "Run `GET /my-index-000001/_search?from=40&size=20` to run a search.\n",
"value": "{\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
},
"SearchRequestExample2": {
"summary": "A point in time search",
"description": "Run `POST /_search` to run a point in time search. The `id` parameter tells Elasticsearch to run the request using contexts from this open point in time. The `keep_alive` parameter tells Elasticsearch how long it should extend the time to live of the point in time.\n",
"value": "{\n \"size\": 100, \n \"query\": {\n \"match\" : {\n \"title\" : \"elasticsearch\"\n }\n },\n \"pit\": {\n \"id\": \"46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA==\", \n \"keep_alive\": \"1m\" \n }\n}"
},
"SearchRequestExample3": {
"summary": "Search slicing",
"description": "When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently. The result from running the first `GET /_search` request returns documents belonging to the first slice (`id: 0`). If you run a second request with `id` set to `1', it returns documents in the second slice. Since the maximum number of slices is set to `2`, the union of the results is equivalent to the results of a point-in-time search without slicing.\n",
"value": "{\n \"slice\": {\n \"id\": 0, \n \"max\": 2 \n },\n \"query\": {\n \"match\": {\n \"message\": \"foo\"\n }\n },\n \"pit\": {\n \"id\": \"46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA==\"\n }\n}"
}
}
}
}
},
"search_application.search": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"params": {
"description": "Query parameters specific to this request, which will override any defaults specified in the template.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"examples": {
"SearchApplicationsSearchRequestExample1": {
"description": "Use `POST _application/search_application/my-app/_search` to run a search against a search application called `my-app` that uses a search template.",
"value": "{\n \"params\": {\n \"query_string\": \"my first query\",\n \"text_fields\": [\n {\"name\": \"title\", \"boost\": 5},\n {\"name\": \"description\", \"boost\": 1}\n ]\n }\n}"
}
}
}
}
},
"search_mvt": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggs": {
"description": "Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
}
},
"buffer": {
"description": "The size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.",
"default": 5,
"type": "number"
},
"exact_bounds": {
"description": "If `false`, the meta layer's feature is the bounding box of the tile.\nIf `true`, the meta layer's feature is a bounding box resulting from a\n`geo_bounds` aggregation. The aggregation runs on values that intersect\nthe `//` tile with `wrap_longitude` set to `false`. The resulting\nbounding box may be larger than the vector tile.",
"default": false,
"type": "boolean"
},
"extent": {
"description": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.",
"default": 4096,
"type": "number"
},
"fields": {
"description": "The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Fields"
}
]
},
"grid_agg": {
"description": "The aggregation used to create a grid for the `field`.",
"allOf": [
{
"$ref": "#/components/schemas/_global.search_mvt._types.GridAggregationType"
}
]
},
"grid_precision": {
"description": "Additional zoom levels available through the aggs layer. For example, if `` is `7`\nand `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.",
"default": 8,
"type": "number"
},
"grid_type": {
"description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.",
"default": "grid",
"allOf": [
{
"$ref": "#/components/schemas/_global.search_mvt._types.GridType"
}
]
},
"query": {
"description": "The query DSL used to filter documents for the search.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"runtime_mappings": {
"description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"size": {
"description": "The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.",
"default": 10000,
"type": "number"
},
"sort": {
"description": "Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"track_total_hits": {
"description": "The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.",
"default": "10000",
"allOf": [
{
"$ref": "#/components/schemas/_global.search._types.TrackHits"
}
]
},
"with_labels": {
"description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.",
"type": "boolean"
}
}
},
"examples": {
"SearchMvtRequestExample1": {
"description": "Run `GET museums/_mvt/location/13/4207/2692` to search an index for `location` values that intersect the `13/4207/2692` vector tile.\n",
"value": "{\n \"grid_agg\": \"geotile\",\n \"grid_precision\": 2,\n \"fields\": [\n \"name\",\n \"price\"\n ],\n \"query\": {\n \"term\": {\n \"included\": true\n }\n },\n \"aggs\": {\n \"min_price\": {\n \"min\": {\n \"field\": \"price\"\n }\n },\n \"max_price\": {\n \"max\": {\n \"field\": \"price\"\n }\n },\n \"avg_price\": {\n \"avg\": {\n \"field\": \"price\"\n }\n }\n }\n}"
}
}
}
}
},
"search_template": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"explain": {
"description": "If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.",
"default": false,
"type": "boolean"
},
"id": {
"description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Id"
}
]
},
"params": {
"description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"profile": {
"description": "If `true`, the query execution is profiled.",
"default": false,
"type": "boolean"
},
"source": {
"description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.",
"allOf": [
{
"$ref": "#/components/schemas/_types.ScriptSource"
}
]
}
}
},
"examples": {
"SearchTemplateRequestExample1": {
"description": "Run `GET my-index/_search/template` to run a search with a search template.\n",
"value": "{\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n }\n}"
}
}
}
},
"required": true
},
"security.change_password": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"password": {
"description": "The new password value. Passwords must be at least 6 characters long.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Password"
}
]
},
"password_hash": {
"description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.",
"type": "string"
}
}
},
"examples": {
"SecurityChangePasswordRequestExample1": {
"description": "Run `POST /_security/user/jacknich/_password` to update the password for the `jacknich` user.\n",
"value": "{\n \"password\" : \"new-test-password\"\n}"
}
}
}
},
"required": true
},
"security.clone_api_key": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"api_key": {
"description": "The credentials of the API key to clone.\nThis is the secret value returned when the key was originally created.",
"type": "string"
},
"name": {
"description": "A name for the cloned API key.\nIf not provided, the name of the source key is used.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"expiration": {
"description": "The expiration time for the cloned API key.\nBy default, API keys never expire.\nSet to `null` to explicitly create a key with no expiration.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"metadata": {
"description": "Arbitrary metadata to associate with the cloned API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
},
"required": [
"api_key"
]
}
}
},
"required": true
},
"security.create_api_key": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expiration": {
"description": "The expiration time for the API key.\nBy default, API keys never expire.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"name": {
"description": "A name for the API key.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Name"
}
]
},
"role_descriptors": {
"externalDocs": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role"
},
"description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security._types.RoleDescriptor"
}
},
"metadata": {
"description": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.",
"x-state": "Generally available; Added in 7.13.0",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
}
}
},
"examples": {
"SecurityCreateApiKeyRequestExample1": {
"description": "Run `POST /_security/api_key` to create an API key. If `expiration` is not provided, the API keys do not expire. If `role_descriptors` is not provided, the permissions of the authenticated user are applied.\n",
"value": "{\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\", \n \"role_descriptors\": { \n \"role-a\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-a*\"],\n \"privileges\": [\"read\"]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-b*\"],\n \"privileges\": [\"all\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\"dev\", \"staging\"]\n }\n }\n}"
}
}
}
},
"required": true
},
"security.has_privileges": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"application": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security.has_privileges.ApplicationPrivilegesCheck"
}
},
"cluster": {
"description": "A list of the cluster privileges that you want to check.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ClusterPrivilege"
}
},
"index": {
"type": "array",
"items": {
"$ref": "#/components/schemas/security.has_privileges.IndexPrivilegesCheck"
}
}
}
},
"examples": {
"SecurityHasPrivilegesRequestExample1": {
"description": "Run `GET /_security/user/_has_privileges` to check whether the current user has a specific set of cluster, index, and application privileges.",
"value": "{\n \"cluster\": [ \"monitor\", \"manage\" ],\n \"index\" : [\n {\n \"names\": [ \"suppliers\", \"products\" ],\n \"privileges\": [ \"read\" ]\n },\n {\n \"names\": [ \"inventory\" ],\n \"privileges\" : [ \"read\", \"write\" ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\" : [ \"read\", \"data:write/inventory\" ],\n \"resources\" : [ \"product/1852563\" ]\n }\n ]\n}"
}
}
}
},
"required": true
},
"security.has_privileges_user_profile": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uids": {
"description": "A list of profile IDs. The privileges are checked for associated users of the profiles.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.UserProfileId"
}
},
"privileges": {
"description": "An object containing all the privileges to be checked.",
"allOf": [
{
"$ref": "#/components/schemas/security.has_privileges_user_profile.PrivilegesCheck"
}
]
}
},
"required": [
"uids",
"privileges"
]
},
"examples": {
"HasPrivilegesUserProfileRequestExample1": {
"description": "Run `POST /_security/profile/_has_privileges` to check whether the two users associated with the specified profiles have all the requested set of cluster, index, and application privileges.\n",
"value": "{\n \"uids\": [\n \"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\n \"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\n \"u_does-not-exist_0\"\n ],\n \"privileges\": {\n \"cluster\": [ \"monitor\", \"create_snapshot\", \"manage_ml\" ],\n \"index\" : [\n {\n \"names\": [ \"suppliers\", \"products\" ],\n \"privileges\": [ \"create_doc\"]\n },\n {\n \"names\": [ \"inventory\" ],\n \"privileges\" : [ \"read\", \"write\" ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\" : [ \"read\", \"data:write/inventory\" ],\n \"resources\" : [ \"product/1852563\" ]\n }\n ]\n }\n}"
}
}
}
},
"required": true
},
"security.put_privileges": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.put_privileges.Actions"
}
}
},
"examples": {
"SecurityPutPrivilegesRequestExample1": {
"summary": "Add a privilege",
"description": "Run `PUT /_security/privilege` to add a single application privilege. The wildcard (`*`) means that this privilege grants access to all actions that start with `data:read/`. Elasticsearch does not assign any meaning to these actions. However, if the request includes an application privilege such as `data:read/users` or `data:read/settings`, the has privileges API respects the use of a wildcard and returns `true`.\n",
"value": "{\n \"myapp\": {\n \"read\": {\n \"actions\": [ \n \"data:read/*\" , \n \"action:login\" ],\n \"metadata\": { \n \"description\": \"Read access to myapp\"\n }\n }\n }\n}"
},
"SecurityPutPrivilegesRequestExample2": {
"summary": "Add multiple privileges",
"description": "Run `PUT /_security/privilege` to add multiple application privileges.\n",
"value": "{\n \"app01\": {\n \"read\": {\n \"actions\": [ \"action:login\", \"data:read/*\" ]\n },\n \"write\": {\n \"actions\": [ \"action:login\", \"data:write/*\" ]\n }\n },\n \"app02\": {\n \"all\": {\n \"actions\": [ \"*\" ]\n }\n }\n}"
}
}
}
},
"required": true
},
"security.put_role": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"applications": {
"description": "A list of application privilege entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ApplicationPrivileges"
}
},
"cluster": {
"description": "A list of cluster privileges. These privileges define the cluster-level actions for users with this role.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.ClusterPrivilege"
}
},
"global": {
"description": "An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.",
"x-state": "Generally available",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"indices": {
"description": "A list of indices permissions entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.IndicesPrivileges"
}
},
"remote_indices": {
"description": "A list of remote indices permissions entries.\n\nNOTE: Remote indices are effective for remote clusters configured with the API key based model.\nThey have no effect for remote clusters configured with the certificate based model.",
"x-state": "Generally available; Added in 8.14.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteIndicesPrivileges"
}
},
"remote_cluster": {
"description": "A list of remote cluster permissions entries.",
"x-state": "Generally available; Added in 8.15.0",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RemoteClusterPrivileges"
}
},
"metadata": {
"description": "Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"run_as": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users"
},
"description": "A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.",
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"description": "Optional description of the role descriptor",
"type": "string"
},
"transient_metadata": {
"description": "Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"examples": {
"SecurityPutRoleRequestExample1": {
"summary": "Role example 1",
"description": "Run `POST /_security/role/my_admin_role` to create a role.",
"value": "{\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [ \"index1\", \"index2\" ],\n \"privileges\": [\"all\"],\n \"field_security\" : { // optional\n \"grant\" : [ \"title\", \"body\" ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\" // optional\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [ \"admin\", \"read\" ],\n \"resources\": [ \"*\" ]\n }\n ],\n \"run_as\": [ \"other_user\" ], // optional\n \"metadata\" : { // optional\n \"version\" : 1\n }\n}"
},
"SecurityPutRoleRequestExample2": {
"summary": "Role example 2",
"description": "Run `POST /_security/role/cli_or_drivers_minimal` to configure a role that can run SQL in JDBC.",
"value": "{\n \"cluster\": [\"cluster:monitor/main\"],\n \"indices\": [\n {\n \"names\": [\"test\"],\n \"privileges\": [\"read\", \"indices:admin/get\"]\n }\n ]\n}"
},
"SecurityPutRoleRequestExample3": {
"summary": "Role example 3",
"description": "Run `POST /_security/role/only_remote_access_role` to configure a role with remote indices and remote cluster privileges for a remote cluster.",
"value": "{\n \"remote_indices\": [\n {\n \"clusters\": [\"my_remote\"], \n \"names\": [\"logs*\"], \n \"privileges\": [\"read\", \"read_cross_cluster\", \"view_index_metadata\"] \n }\n ],\n \"remote_cluster\": [\n {\n \"clusters\": [\"my_remote\"], \n \"privileges\": [\"monitor_stats\"] \n }\n ]\n}"
}
}
}
},
"required": true
},
"security.put_role_mapping": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"description": "Mappings that have `enabled` set to `false` are ignored when role mapping is performed.",
"type": "boolean"
},
"metadata": {
"description": "Additional metadata that helps define which roles are assigned to each user.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"roles": {
"description": "A list of role names that are granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.",
"type": "array",
"items": {
"type": "string"
}
},
"role_templates": {
"description": "A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.",
"type": "array",
"items": {
"$ref": "#/components/schemas/security._types.RoleTemplate"
}
},
"rules": {
"description": "The rules that determine which users should be matched by the mapping.\nA rule is a logical condition that is expressed by using a JSON DSL.",
"allOf": [
{
"$ref": "#/components/schemas/security._types.RoleMappingRule"
}
]
},
"run_as": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"examples": {
"SecurityPutRoleMappingRequestExample1": {
"summary": "Roles for all users",
"description": "Run `POST /_security/role_mapping/mapping1` to assign the `user` role to all users.\n",
"value": "{\n \"roles\": [ \"user\"],\n \"enabled\": true, \n \"rules\": {\n \"field\" : { \"username\" : \"*\" }\n },\n \"metadata\" : { \n \"version\" : 1\n }\n}"
},
"SecurityPutRoleMappingRequestExample2": {
"summary": "Roles for specific users",
"description": "Run `POST /_security/role_mapping/mapping2` to assign the \"user\" and \"admin\" roles to specific users.\n",
"value": "{\n \"roles\": [ \"user\", \"admin\" ],\n \"enabled\": true,\n \"rules\": {\n \"field\" : { \"username\" : [ \"esadmin01\", \"esadmin02\" ] }\n }\n}"
},
"SecurityPutRoleMappingRequestExample3": {
"summary": "Roles for specific realms",
"description": "Run `POST /_security/role_mapping/mapping3` to match users who authenticated against a specific realm.\n",
"value": "{\n \"roles\": [ \"ldap-user\" ],\n \"enabled\": true,\n \"rules\": {\n \"field\" : { \"realm.name\" : \"ldap1\" }\n }\n}"
},
"SecurityPutRoleMappingRequestExample4": {
"summary": "Roles for specific groups",
"description": "Run `POST /_security/role_mapping/mapping4` to match any user where either the username is `esadmin` or the user is in the `cn=admin,dc=example,dc=com group`. This example is useful when the group names in your identity management system (such as Active Directory, or a SAML Identity Provider) do not have a one-to-one correspondence with the names of roles in Elasticsearch. The role mapping is the means by which you link a group name with a role name.\n",
"value": "{\n \"roles\": [ \"superuser\" ],\n \"enabled\": true,\n \"rules\": {\n \"any\": [\n {\n \"field\": {\n \"username\": \"esadmin\"\n }\n },\n {\n \"field\": {\n \"groups\": \"cn=admins,dc=example,dc=com\"\n }\n }\n ]\n }\n}"
},
"SecurityPutRoleMappingRequestExample5": {
"summary": "Roles for multiple groups",
"description": "Run `POST /_security/role_mapping/mapping5` to use an array syntax for the groups field when there are multiple groups. This pattern matches any of the groups (rather than all of the groups).\n",
"value": "{\n \"role_templates\": [\n {\n \"template\": { \"source\": \"{{#tojson}}groups{{/tojson}}\" }, \n \"format\" : \"json\" \n }\n ],\n \"rules\": {\n \"field\" : { \"realm.name\" : \"saml1\" }\n },\n \"enabled\": true\n}"
},
"SecurityPutRoleMappingRequestExample6": {
"summary": "Templated roles for groups",
"description": "Run `POST /_security/role_mapping/mapping6` for rare cases when the names of your groups may be an exact match for the names of your Elasticsearch roles. This can be the case when your SAML Identity Provider includes its own \"group mapping\" feature and can be configured to release Elasticsearch role names in the user's SAML attributes. In these cases it is possible to use a template that treats the group names as role names.\nNOTE: This should only be done if you intend to define roles for all of the provided groups. Mapping a user to a large number of unnecessary or undefined roles is inefficient and can have a negative effect on system performance. If you only need to map a subset of the groups, you should do it by using explicit mappings.\nThe `tojson` mustache function is used to convert the list of group names into a valid JSON array. Because the template produces a JSON array, the `format` must be set to `json`.\n",
"value": "{\n \"role_templates\": [\n {\n \"template\": { \"source\": \"{{#tojson}}groups{{/tojson}}\" }, \n \"format\" : \"json\" \n }\n ],\n \"rules\": {\n \"field\" : { \"realm.name\" : \"saml1\" }\n },\n \"enabled\": true\n}"
},
"SecurityPutRoleMappingRequestExample7": {
"summary": "Users in a LDAP sub-tree and realm",
"description": "Run `POST /_security/role_mapping/mapping7` to match users within a particular LDAP sub-tree in a specific realm.\n",
"value": "{\n \"roles\": [ \"ldap-example-user\" ],\n \"enabled\": true,\n \"rules\": {\n \"all\": [\n { \"field\" : { \"dn\" : \"*,ou=subtree,dc=example,dc=com\" } },\n { \"field\" : { \"realm.name\" : \"ldap1\" } }\n ]\n }\n}"
},
"SecurityPutRoleMappingRequestExample8": {
"summary": "Complex roles",
"description": "Run `POST /_security/role_mapping/mapping8` to assign rules that are complex and include wildcard matching. For example, this mapping matches any user where all of these conditions are met: the Distinguished Name matches the pattern `*,ou=admin,dc=example,dc=com`, or the `username` is `es-admin`, or the `username` is `es-system`; the user is in the `cn=people,dc=example,dc=com` group; the user does not have a `terminated_date`.\n",
"value": "{\n \"roles\": [ \"superuser\" ],\n \"enabled\": true,\n \"rules\": {\n \"all\": [\n {\n \"any\": [\n {\n \"field\": {\n \"dn\": \"*,ou=admin,dc=example,dc=com\"\n }\n },\n {\n \"field\": {\n \"username\": [ \"es-admin\", \"es-system\" ]\n }\n }\n ]\n },\n {\n \"field\": {\n \"groups\": \"cn=people,dc=example,dc=com\"\n }\n },\n {\n \"except\": {\n \"field\": {\n \"metadata.terminated_date\": null\n }\n }\n }\n ]\n }\n}"
},
"SecurityPutRoleMappingRequestExample9": {
"summary": "Templated roles",
"description": "Run `POST /_security/role_mapping/mapping9` to use templated roles to automatically map every user to their own custom role. In this example every user who authenticates using the `cloud-saml` realm will be automatically mapped to two roles: the `saml_user` role and a role that is their username prefixed with `_user_`. For example, the user `nwong` would be assigned the `saml_user` and `_user_nwong` roles.\n",
"value": "{\n \"rules\": { \"field\": { \"realm.name\": \"cloud-saml\" } },\n \"role_templates\": [\n { \"template\": { \"source\" : \"saml_user\" } }, \n { \"template\": { \"source\" : \"_user_{{username}}\" } }\n ],\n \"enabled\": true\n}"
}
}
}
},
"required": true
},
"security.put_user": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"username": {
"allOf": [
{
"$ref": "#/components/schemas/_types.Username"
}
]
},
"email": {
"description": "The email of the user.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"full_name": {
"description": "The full name of the user.",
"oneOf": [
{
"type": "string"
},
{
"nullable": true,
"type": "string"
}
]
},
"metadata": {
"description": "Arbitrary metadata that you want to associate with the user.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"password": {
"description": "The user's password.\nPasswords must be at least 6 characters long.\nWhen adding a user, one of `password` or `password_hash` is required.\nWhen updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password",
"allOf": [
{
"$ref": "#/components/schemas/_types.Password"
}
]
},
"password_hash": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#hashing-settings"
},
"description": "A hash of the user's password.\nThis must be produced using the same hashing algorithm as has been configured for password storage.\nFor more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation.\nUsing this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons.\nThe `password` parameter and the `password_hash` parameter cannot be used in the same request.",
"type": "string"
},
"roles": {
"description": "A set of roles the user has.\nThe roles determine the user's access permissions.\nTo create a user without any roles, specify an empty list (`[]`).",
"type": "array",
"items": {
"type": "string"
}
},
"enabled": {
"description": "Specifies whether the user is enabled.",
"default": true,
"type": "boolean"
}
}
},
"examples": {
"SecurityPutUserRequestExample1": {
"description": "Run `POST /_security/user/jacknich` to activate a user profile.",
"value": "{\n \"password\" : \"l0ng-r4nd0m-p@ssw0rd\",\n \"roles\" : [ \"admin\", \"other_role1\" ],\n \"full_name\" : \"Jack Nicholson\",\n \"email\" : \"jacknich@example.com\",\n \"metadata\" : {\n \"intelligence\" : 7\n }\n}"
}
}
}
},
"required": true
},
"security.query_api_keys": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregations": {
"description": "Any aggregations to run over the corpus of returned API keys.\nAggregations and queries work together. Aggregations are computed only on the API keys that match the query.\nThis supports only a subset of aggregation types, namely: `terms`, `range`, `date_range`, `missing`,\n`cardinality`, `value_count`, `composite`, `filter`, and `filters`.\nAdditionally, aggregations only run over the same subset of fields that query works with.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/security.query_api_keys.ApiKeyAggregationContainer"
}
},
"query": {
"description": "A query to filter which API keys to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following public information associated with an API key: `id`, `type`, `name`,\n`creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`.\n\nNOTE: The queryable string values associated with API keys are internally mapped as keywords.\nConsequently, if no `analyzer` parameter is specified for a `match` query, then the provided match query string is interpreted as a single keyword value.\nSuch a match query is hence equivalent to a `term` query.",
"allOf": [
{
"$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer"
}
]
},
"from": {
"description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"default": 0,
"type": "number"
},
"sort": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results"
},
"description": "The sort definition.\nOther than `id`, all public fields of an API key are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"size": {
"description": "The number of hits to return.\nIt must not be negative.\nThe `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"default": 10,
"type": "number"
},
"search_after": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after"
},
"description": "The search after definition.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
}
}
},
"examples": {
"QueryApiKeysRequestExample1": {
"summary": "Query API keys by ID",
"description": "Run `GET /_security/_query/api_key?with_limited_by=true` to retrieve an API key by ID.",
"value": "{\n \"query\": {\n \"ids\": {\n \"values\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n }\n}"
},
"QueryApiKeysRequestExample2": {
"summary": "Query API keys with pagination",
"description": "Run `GET /_security/_query/api_key`. Use a `bool` query to issue complex logical conditions and use `from`, `size`, and `sort` to help paginate the result. For example, the API key name must begin with `app1-key-` and must not be `app1-key-01`. It must be owned by a username with the wildcard pattern `org-*-user` and the `environment` metadata field must have a `production` value. The offset to begin the search result is the twentieth (zero-based index) API key. The page size of the response is 10 API keys. The result is first sorted by creation date in descending order, then by name in ascending order.\n",
"value": "{\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"prefix\": {\n \"name\": \"app1-key-\" \n }\n },\n {\n \"term\": {\n \"invalidated\": \"false\" \n }\n }\n ],\n \"must_not\": [\n {\n \"term\": {\n \"name\": \"app1-key-01\" \n }\n }\n ],\n \"filter\": [\n {\n \"wildcard\": {\n \"username\": \"org-*-user\" \n }\n },\n {\n \"term\": {\n \"metadata.environment\": \"production\" \n }\n }\n ]\n }\n },\n \"from\": 20, \n \"size\": 10, \n \"sort\": [ \n { \"creation\": { \"order\": \"desc\", \"format\": \"date_time\" } },\n \"name\"\n ]\n}"
},
"QueryApiKeysRequestExample3": {
"summary": "Query API keys by name",
"description": "Run `GET /_security/_query/api_key` to retrieve the API key by name.",
"value": "{\n \"query\": {\n \"term\": {\n \"name\": {\n \"value\": \"application-key-1\"\n }\n }\n }\n}"
}
}
}
}
},
"security.query_role": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"description": "A query to filter which roles to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with roles: `name`, `description`, `metadata`,\n`applications.application`, `applications.privileges`, and `applications.resources`.",
"allOf": [
{
"$ref": "#/components/schemas/security.query_role.RoleQueryContainer"
}
]
},
"from": {
"description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"default": 0,
"type": "number"
},
"sort": {
"description": "The sort definition.\nYou can sort on `name`, `description`, `metadata`, `applications.application`, `applications.privileges`,\nand `applications.resources`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"size": {
"description": "The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"default": 10,
"type": "number"
},
"search_after": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after"
},
"description": "The search after definition.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
}
}
},
"examples": {
"QueryRolesRequestExample1": {
"summary": "Query roles by name",
"description": "Run `POST /_security/_query/role` to lists all roles, sorted by the role name.",
"value": "{\n \"sort\": [\"name\"]\n}"
},
"QueryRolesRequestExample2": {
"summary": "Query roles by description",
"description": "Run `POST /_security/_query/role` to query only the user access role, given its description. It returns only the best matching role because `size` is set to `1`.\n",
"value": "{\n \"query\": {\n \"match\": {\n \"description\": {\n \"query\": \"user access\"\n }\n }\n },\n \"size\": 1 \n}"
}
}
}
}
},
"security.query_user": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"description": "A query to filter which users to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with user: `username`, `roles`, `enabled`, `full_name`, and `email`.",
"allOf": [
{
"$ref": "#/components/schemas/security.query_user.UserQueryContainer"
}
]
},
"from": {
"description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"default": 0,
"type": "number"
},
"sort": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results"
},
"description": "The sort definition.\nFields eligible for sorting are: `username`, `roles`, `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"size": {
"description": "The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
"default": 10,
"type": "number"
},
"search_after": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after"
},
"description": "The search after definition",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
}
}
},
"examples": {
"SecurityQueryUserRequestExample1": {
"summary": "Query users by role prefix",
"description": "Run `POST /_security/_query/user?with_profile_uid=true` to get users that have roles that are prefixed with `other`. It will also include the user `profile_uid` in the response.\n",
"value": "{\n \"query\": {\n \"prefix\": {\n \"roles\": \"other\"\n }\n }\n}"
},
"SecurityQueryUserRequestExample2": {
"summary": "Query users with multiple conditions",
"description": "Run `POST /_security/_query/user`. Use a `bool` query to issue complex logical conditions: The `email` must end with `example.com`. The user must be enabled. The result will be filtered to only contain users with at least one role that contains the substring `other`. The offset to begin the search result is the second (zero-based index) user. The page size of the response is two users. The result is sorted by `username` in descending order.\n",
"value": "{\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"wildcard\": {\n \"email\": \"*example.com\" \n }\n },\n {\n \"term\": {\n \"enabled\": true \n }\n }\n ],\n \"filter\": [\n {\n \"wildcard\": {\n \"roles\": \"*other*\" \n }\n }\n ]\n }\n },\n \"from\": 1, \n \"size\": 2, \n \"sort\": [\n { \"username\": { \"order\": \"desc\"} } \n ]\n}"
}
}
}
}
},
"security.suggest_user_profiles": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"description": "A query string used to match name-related fields in user profile documents.\nName-related fields are the user's `username`, `full_name`, and `email`.",
"type": "string"
},
"size": {
"description": "The number of profiles to return.",
"default": 10,
"type": "number"
},
"data": {
"description": "A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content, use `data=` to retrieve content nested under the specified ``.\nBy default, the API returns no `data` content.\nIt is an error to specify `data` as both the query parameter and the request body field.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"hint": {
"description": "Extra search criteria to improve relevance of the suggestion result.\nProfiles matching the spcified hint are ranked higher in the response.\nProfiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query.",
"allOf": [
{
"$ref": "#/components/schemas/security.suggest_user_profiles.Hint"
}
]
}
}
},
"examples": {
"SuggestUserProfilesRequestExample1": {
"description": "Run `POST /_security/profile/_suggest` to get suggestions for profile documents with name-related fields matching `jack`. It specifies both `uids` and `labels` hints for better relevance. The `labels` hint ranks profiles higher if their `direction` label matches either `north` or `east`.\n",
"value": "{\n \"name\": \"jack\", \n \"hint\": {\n \"uids\": [ \n \"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\n \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n ],\n \"labels\": {\n \"direction\": [\"north\", \"east\"] \n }\n }\n}"
}
}
}
}
},
"security.update_user_profile_data": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"labels": {
"description": "Searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the labels object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"description": "Non-searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).\nThe data object is not searchable, but can be retrieved with the get user profile API.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"examples": {
"UpdateUserProfileDataRequestExample1": {
"description": "Run `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data` to update a profile document for the `u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0` user profile.\n",
"value": "{\n \"labels\": {\n \"direction\": \"east\"\n },\n \"data\": {\n \"app1\": {\n \"theme\": \"default\"\n }\n }\n}"
}
}
}
},
"required": true
},
"simulate.ingest": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"description": "Sample documents to test in the pipeline.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ingest._types.Document"
}
},
"component_template_substitutions": {
"description": "A map of component template names to substitute component template definition objects.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/cluster._types.ComponentTemplateNode"
}
},
"index_template_substitutions": {
"description": "A map of index template names to substitute index template definition objects.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/indices._types.IndexTemplate"
}
},
"mapping_addition": {
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.TypeMapping"
}
]
},
"pipeline_substitutions": {
"description": "Pipelines to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ingest._types.Pipeline"
}
}
},
"required": [
"docs"
]
},
"examples": {
"SimulateIngestRequestExample1": {
"summary": "Existing pipeline definitions",
"description": "In this example the index `my-index` has a default pipeline called `my-pipeline` and a final pipeline called `my-final-pipeline`. Since both documents are being ingested into `my-index`, both pipelines are run using the pipeline definitions that are already in the system.",
"value": "{\n \"docs\": [\n {\n \"_id\": \"123\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"bar\"\n }\n },\n {\n \"_id\": \"456\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"rab\"\n }\n }\n ]\n}"
},
"SimulateIngestRequestExample2": {
"summary": "Pipeline substitions",
"description": "In this example the index `my-index` has a default pipeline called `my-pipeline` and a final pipeline called `my-final-pipeline`. But a substitute definition of `my-pipeline` is provided in `pipeline_substitutions`. The substitute `my-pipeline` will be used in place of the `my-pipeline` that is in the system, and then the `my-final-pipeline` that is already defined in the system will run.",
"value": "{\n \"docs\": [\n {\n \"_index\": \"my-index\",\n \"_id\": \"123\",\n \"_source\": {\n \"foo\": \"bar\"\n }\n },\n {\n \"_index\": \"my-index\",\n \"_id\": \"456\",\n \"_source\": {\n \"foo\": \"rab\"\n }\n }\n ],\n \"pipeline_substitutions\": {\n \"my-pipeline\": {\n \"processors\": [\n {\n \"uppercase\": {\n \"field\": \"foo\"\n }\n }\n ]\n }\n }\n}"
},
"SimulateIngestRequestExample3": {
"summary": "Component template substitutions",
"description": "In this example, imagine that the index `my-index` has a strict mapping with only the `foo` keyword field defined. Say that field mapping came from a component template named `my-mappings-template`. You want to test adding a new field, `bar`. So a substitute definition of `my-mappings-template` is provided in `component_template_substitutions`. The substitute `my-mappings-template` will be used in place of the existing mapping for `my-index` and in place of the `my-mappings-template` that is in the system.\n",
"value": "{\n \"docs\": [\n {\n \"_index\": \"my-index\",\n \"_id\": \"123\",\n \"_source\": {\n \"foo\": \"foo\"\n }\n },\n {\n \"_index\": \"my-index\",\n \"_id\": \"456\",\n \"_source\": {\n \"bar\": \"rab\"\n }\n }\n ],\n \"component_template_substitutions\": {\n \"my-mappings_template\": {\n \"template\": {\n \"mappings\": {\n \"dynamic\": \"strict\",\n \"properties\": {\n \"foo\": {\n \"type\": \"keyword\"\n },\n \"bar\": {\n \"type\": \"keyword\"\n }\n }\n }\n }\n }\n }\n}"
},
"SimulateIngestRequestExample4": {
"summary": "Multiple substitutions",
"description": "The pipeline, component template, and index template substitutions replace the existing pipeline details for the duration of this request.",
"value": "{\n \"docs\": [\n {\n \"_id\": \"id\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"bar\"\n }\n },\n {\n \"_id\": \"id\",\n \"_index\": \"my-index\",\n \"_source\": {\n \"foo\": \"rab\"\n }\n }\n ],\n \"pipeline_substitutions\": {\n \"my-pipeline\": {\n \"processors\": [\n {\n \"set\": {\n \"field\": \"field3\",\n \"value\": \"value3\"\n }\n }\n ]\n }\n },\n \"component_template_substitutions\": {\n \"my-component-template\": {\n \"template\": {\n \"mappings\": {\n \"dynamic\": true,\n \"properties\": {\n \"field3\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"settings\": {\n \"index\": {\n \"default_pipeline\": \"my-pipeline\"\n }\n }\n }\n }\n },\n \"index_template_substitutions\": {\n \"my-index-template\": {\n \"index_patterns\": [\n \"my-index-*\"\n ],\n \"composed_of\": [\n \"component_template_1\",\n \"component_template_2\"\n ]\n }\n },\n \"mapping_addition\": {\n \"dynamic\": \"strict\",\n \"properties\": {\n \"foo\": {\n \"type\": \"keyword\"\n }\n }\n }\n}"
}
}
}
},
"required": true
},
"snapshot.create": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expand_wildcards": {
"description": "Determines how wildcard patterns in the `indices` parameter match data streams and indices.\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",
"default": "all",
"allOf": [
{
"$ref": "#/components/schemas/_types.ExpandWildcards"
}
]
},
"feature_states": {
"externalDocs": {
"url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore#feature-state"
},
"description": "The feature states to include in the snapshot.\nEach feature state includes one or more system indices containing related data.\nYou can view a list of eligible features using the get features API.\n\nIf `include_global_state` is `true`, all current feature states are included by default.\nIf `include_global_state` is `false`, no feature states are included by default.\n\nNote that specifying an empty array will result in the default behavior.\nTo exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`[\"none\"]`).",
"type": "array",
"items": {
"type": "string"
}
},
"ignore_unavailable": {
"description": "If `true`, the request ignores data streams and indices in `indices` that are missing or closed.\nIf `false`, the request returns an error for any data stream or index that is missing or closed.",
"default": false,
"type": "boolean"
},
"include_global_state": {
"description": "If `true`, the current cluster state is included in the snapshot.\nThe cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies.\nIt also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).",
"default": true,
"type": "boolean"
},
"indices": {
"description": "A comma-separated list of data streams and indices to include in the snapshot.\nIt supports a multi-target syntax.\nThe default is an empty array (`[]`), which includes all regular data streams and regular indices.\nTo exclude all data streams and indices, use `-*`.\n\nYou can't use this parameter to include or exclude system indices or system data streams from a snapshot.\nUse `feature_states` instead.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Indices"
}
]
},
"metadata": {
"description": "Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.\nIt can have any contents but it must be less than 1024 bytes.\nThis information is not automatically generated by Elasticsearch.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"partial": {
"description": "If `true`, it enables you to restore a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.\n\nIf `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.",
"default": false,
"type": "boolean"
}
}
},
"examples": {
"SnapshotCreateRequestExample1": {
"description": "Run `PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true` to take a snapshot of `index_1` and `index_2`.",
"value": "{\n \"indices\": \"index_1,index_2\",\n \"ignore_unavailable\": true,\n \"include_global_state\": false,\n \"metadata\": {\n \"taken_by\": \"user123\",\n \"taken_because\": \"backup before upgrading\"\n }\n}"
}
}
}
}
},
"snapshot.create_repository": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/snapshot._types.Repository"
},
"examples": {
"SnapshotCreateRepositoryRequestExample1": {
"summary": "A shared file system repository",
"description": "Run `PUT /_snapshot/my_repository` to create or update a shared file system snapshot repository.",
"value": "{\n \"type\": \"fs\",\n \"settings\": {\n \"location\": \"my_backup_location\"\n }\n}"
},
"SnapshotCreateRepositoryRequestExample2": {
"summary": "An Azure repository",
"description": "Run `PUT /_snapshot/my_repository` to create or update an Azure snapshot repository.",
"value": "{\n \"type\": \"azure\",\n \"settings\": {\n \"client\": \"secondary\"\n }\n}"
},
"SnapshotCreateRepositoryRequestExample3": {
"summary": "A Google Cloud Storage repository",
"description": "Run `PUT /_snapshot/my_gcs_repository` to create or update a Google Cloud Storage snapshot repository.",
"value": "{\n \"type\": \"gcs\",\n \"settings\": {\n \"bucket\": \"my_other_bucket\",\n \"base_path\": \"dev\"\n }\n}"
},
"SnapshotCreateRepositoryRequestExample4": {
"summary": "An S3 repository",
"description": "Run `PUT /_snapshot/my_s3_repository` to create or update an AWS S3 snapshot repository.",
"value": "{\n \"type\": \"s3\",\n \"settings\": {\n \"bucket\": \"my-bucket\"\n }\n}"
},
"SnapshotCreateRepositoryRequestExample5": {
"summary": "A source-only repository",
"description": "Run `PUT _snapshot/my_src_only_repository` to create or update a source-only snapshot repository.",
"value": "{\n \"type\": \"source\",\n \"settings\": {\n \"delegate_type\": \"fs\",\n \"location\": \"my_backup_repository\"\n }\n}"
},
"SnapshotCreateRepositoryRequestExample6": {
"summary": "A read-only URL repository",
"description": "Run `PUT _snapshot/my_read_only_url_repository` to create or update a read-only URL snapshot repository.",
"value": "{\n \"type\": \"url\",\n \"settings\": {\n \"url\": \"file:/mount/backups/my_fs_backup_location\"\n }\n}"
}
}
}
},
"required": true
},
"sql.query": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"allow_partial_search_results": {
"description": "If `true`, the response has partial results when there are shard request timeouts or shard failures.\nIf `false`, the API returns an error with no partial results.",
"default": false,
"type": "boolean"
},
"catalog": {
"description": "The default catalog (cluster) for queries.\nIf unspecified, the queries execute on the data in the local cluster only.",
"type": "string"
},
"columnar": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-columnar"
},
"description": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.",
"default": false,
"type": "boolean"
},
"cursor": {
"description": "The cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.",
"type": "string"
},
"fetch_size": {
"description": "The maximum number of rows (or entries) to return in one response.",
"default": 1000,
"type": "number"
},
"field_multi_value_leniency": {
"description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.",
"default": false,
"type": "boolean"
},
"filter": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering"
},
"description": "The Elasticsearch query DSL for additional filtering.",
"default": "none",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"index_using_frozen": {
"description": "If `true`, the search can run on frozen indices.",
"default": false,
"type": "boolean"
},
"keep_alive": {
"description": "The retention period for an async or saved synchronous search.",
"default": "5d",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"keep_on_completion": {
"description": "If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter.\nIf `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.",
"default": false,
"type": "boolean"
},
"page_timeout": {
"description": "The minimum retention period for the scroll cursor.\nAfter this time period, a pagination request might fail because the scroll cursor is no longer available.\nSubsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.",
"default": "45s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"params": {
"description": "The values for parameters in the query.",
"type": "array",
"items": {
"type": "object"
}
},
"query": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/sql/sql-spec"
},
"description": "The SQL query to run.",
"type": "string"
},
"request_timeout": {
"description": "The timeout before the request fails.",
"default": "90s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"runtime_mappings": {
"description": "One or more runtime fields for the search request.\nThese fields take precedence over mapped fields with the same name.",
"allOf": [
{
"$ref": "#/components/schemas/_types.mapping.RuntimeFields"
}
]
},
"time_zone": {
"externalDocs": {
"url": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html"
},
"description": "The ISO-8601 time zone ID for the search.",
"default": "Z",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
},
"wait_for_completion_timeout": {
"description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.\nIf the search doesn't finish within this period, the search becomes async.\n\nTo save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
}
}
},
"examples": {
"QuerySqlRequestExample1": {
"description": "Run `POST _sql?format=txt` to get results for an SQL search.",
"value": "{\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"\n}"
}
}
}
},
"required": true
},
"sql.translate": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fetch_size": {
"description": "The maximum number of rows (or entries) to return in one response.",
"default": 1000,
"type": "number"
},
"filter": {
"externalDocs": {
"url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering"
},
"description": "The Elasticsearch query DSL for additional filtering.",
"default": "none",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"query": {
"description": "The SQL query to run.",
"type": "string"
},
"time_zone": {
"externalDocs": {
"url": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html"
},
"description": "The ISO-8601 time zone ID for the search.",
"default": "Z",
"allOf": [
{
"$ref": "#/components/schemas/_types.TimeZone"
}
]
}
},
"required": [
"query"
]
},
"examples": {
"TranslateSqlRequestExample1": {
"summary": "sql/apis/sql-translate-api.asciidoc:12",
"description": "",
"value": "{\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC\",\n \"fetch_size\": 10\n}"
}
}
}
},
"required": true
},
"terms_enum": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"field": {
"description": "The string to match at the start of indexed terms. If not provided, all terms in the field are considered.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Field"
}
]
},
"size": {
"description": "The number of matching terms to return.",
"default": 10,
"type": "number"
},
"timeout": {
"description": "The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.",
"default": "1s",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"case_insensitive": {
"description": "When `true`, the provided search string is matched against index terms without case sensitivity.",
"default": false,
"type": "boolean"
},
"index_filter": {
"description": "Filter an index shard if the provided query rewrites to `match_none`.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"string": {
"description": "The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.",
"type": "string"
},
"search_after": {
"description": "The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.",
"type": "string"
}
},
"required": [
"field"
]
},
"examples": {
"TermsEnumRequestExample1": {
"description": "Run `POST stackoverflow/_terms_enum`.",
"value": "{\n \"field\" : \"tags\",\n \"string\" : \"kiba\"\n}"
}
}
}
},
"required": true
},
"termvectors": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"doc": {
"description": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.",
"type": "object"
},
"filter": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query"
},
"description": "Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.",
"allOf": [
{
"$ref": "#/components/schemas/_global.termvectors.Filter"
}
]
},
"per_field_analyzer": {
"description": "Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fields": {
"description": "A list of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.",
"type": "array",
"items": {
"$ref": "#/components/schemas/_types.Field"
}
},
"field_statistics": {
"description": "If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).",
"default": true,
"type": "boolean"
},
"offsets": {
"description": "If `true`, the response includes term offsets.",
"default": true,
"type": "boolean"
},
"payloads": {
"description": "If `true`, the response includes term payloads.",
"default": true,
"type": "boolean"
},
"positions": {
"description": "If `true`, the response includes term positions.",
"default": true,
"type": "boolean"
},
"term_statistics": {
"description": "If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.",
"default": false,
"type": "boolean"
},
"routing": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-shard-routing"
},
"description": "A custom value that is used to route operations to a specific shard.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Routing"
}
]
},
"version": {
"description": "If `true`, returns the document version as part of a hit.",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionNumber"
}
]
},
"version_type": {
"description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_types.VersionType"
}
]
}
}
},
"examples": {
"TermVectorsRequestExample1": {
"summary": "Return stored term vectors",
"description": "Run `GET /my-index-000001/_termvectors/1` to return all information and statistics for field `text` in document 1.\n",
"value": "{\n \"fields\" : [\"text\"],\n \"offsets\" : true,\n \"payloads\" : true,\n \"positions\" : true,\n \"term_statistics\" : true,\n \"field_statistics\" : true\n}"
},
"TermVectorsRequestExample2": {
"summary": "Per-field analyzer",
"description": "Run `GET /my-index-000001/_termvectors/1` to set per-field analyzers. A different analyzer than the one at the field may be provided by using the `per_field_analyzer` parameter.\n",
"value": "{\n \"doc\" : {\n \"fullname\" : \"John Doe\",\n \"text\" : \"test test test\"\n },\n \"fields\": [\"fullname\"],\n \"per_field_analyzer\" : {\n \"fullname\": \"keyword\"\n }\n}"
},
"TermVectorsRequestExample3": {
"summary": "Terms filtering",
"description": "Run `GET /imdb/_termvectors` to filter the terms returned based on their tf-idf scores. It returns the three most \"interesting\" keywords from the artificial document having the given \"plot\" field value. Notice that the keyword \"Tony\" or any stop words are not part of the response, as their tf-idf must be too low.\n",
"value": "{\n \"doc\": {\n \"plot\": \"When wealthy industrialist Tony Stark is forced to build an armored suit after a life-threatening incident, he ultimately decides to use its technology to fight against evil.\"\n },\n \"term_statistics\": true,\n \"field_statistics\": true,\n \"positions\": false,\n \"offsets\": false,\n \"filter\": {\n \"max_num_terms\": 3,\n \"min_term_freq\": 1,\n \"min_doc_freq\": 1\n }\n}"
},
"TermVectorsRequestExample4": {
"summary": "Generate term vectors on the fly",
"description": "Run `GET /my-index-000001/_termvectors/1`. Term vectors which are not explicitly stored in the index are automatically computed on the fly. This request returns all information and statistics for the fields in document 1, even though the terms haven't been explicitly stored in the index. Note that for the field text, the terms are not regenerated.\n",
"value": "{\n \"fields\" : [\"text\", \"some_field_without_term_vectors\"],\n \"offsets\" : true,\n \"positions\" : true,\n \"term_statistics\" : true,\n \"field_statistics\" : true\n}"
},
"TermVectorsRequestExample5": {
"summary": "Artificial documents",
"description": "Run `GET /my-index-000001/_termvectors`. Term vectors can be generated for artificial documents, that is for documents not present in the index. If dynamic mapping is turned on (default), the document fields not in the original mapping will be dynamically created.\n",
"value": "{\n \"doc\" : {\n \"fullname\" : \"John Doe\",\n \"text\" : \"test test test\"\n }\n}"
}
}
}
}
},
"text_structure.find_message_structure": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"description": "The list of messages you want to analyze.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"messages"
]
},
"examples": {
"FindMessageStructureRequestExample1": {
"description": "Run `POST _text_structure/find_message_structure` to analyze Elasticsearch log files.\n",
"value": "{\n \"messages\": [\n \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\n \"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\n \"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\n \"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\n \"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\n \"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\n \"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\n \"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\n \"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\"\n ]\n}"
}
}
}
},
"required": true
},
"text_structure.test_grok_pattern": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"grok_pattern": {
"description": "The Grok pattern to run on the text.",
"allOf": [
{
"$ref": "#/components/schemas/_types.GrokPattern"
}
]
},
"text": {
"description": "The lines of text to run the Grok pattern on.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"grok_pattern",
"text"
]
},
"examples": {
"TestGrokPatternRequestExample1": {
"description": "Run `GET _text_structure/test_grok_pattern` to test a Grok pattern.",
"value": "{\n \"grok_pattern\": \"Hello %{WORD:first_name} %{WORD:last_name}\",\n \"text\": [\n \"Hello John Doe\",\n \"this does not match\"\n ]\n}"
}
}
}
},
"required": true
},
"transform.preview_transform": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dest": {
"description": "The destination for the transform.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Destination"
}
]
},
"description": {
"description": "Free text description of the transform.",
"type": "string"
},
"frequency": {
"description": "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.",
"default": "1m",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"pivot": {
"description": "The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Pivot"
}
]
},
"source": {
"description": "The source of the data for the transform.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Source"
}
]
},
"settings": {
"description": "Defines optional transform settings.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Settings"
}
]
},
"sync": {
"description": "Defines the properties transforms require to run continuously.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.SyncContainer"
}
]
},
"retention_policy": {
"description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
}
]
},
"latest": {
"description": "The latest method transforms the data by finding the latest document for\neach unique key.",
"allOf": [
{
"$ref": "#/components/schemas/transform._types.Latest"
}
]
}
}
},
"examples": {
"PreviewTransformRequestExample1": {
"description": "Run `POST _transform/_preview` to preview a transform that uses the pivot method.",
"value": "{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n }\n}"
}
}
}
}
},
"watcher.execute_watch": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"action_modes": {
"description": "Determines how to handle the watch actions as part of the watch execution.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/watcher._types.ActionExecutionMode"
}
},
"alternative_input": {
"description": "When present, the watch uses this object as a payload instead of executing its own input.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"ignore_condition": {
"description": "When set to `true`, the watch execution uses the always condition. This can also be specified as an HTTP parameter.",
"default": false,
"type": "boolean"
},
"record_execution": {
"description": "When set to `true`, the watch record representing the watch execution result is persisted to the `.watcher-history` index for the current time.\nIn addition, the status of the watch is updated, possibly throttling subsequent runs.\nThis can also be specified as an HTTP parameter.",
"default": false,
"type": "boolean"
},
"simulated_actions": {
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.SimulatedActions"
}
]
},
"trigger_data": {
"description": "This structure is parsed as the data of the trigger event that will be used during the watch execution.",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ScheduleTriggerEvent"
}
]
},
"watch": {
"description": "When present, this watch is used instead of the one specified in the request.\nThis watch is not persisted to the index and `record_execution` cannot be set.",
"default": "null",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.Watch"
}
]
}
}
},
"examples": {
"WatcherExecuteRequestExample1": {
"summary": "Run a watch",
"description": "Run `POST _watcher/watch/my_watch/_execute` to run a watch. The input defined in the watch is ignored and the `alternative_input` is used as the payload. The condition as defined by the watch is ignored and is assumed to evaluate to true. The `force_simulate` action forces the simulation of `my-action`. Forcing the simulation means that throttling is ignored and the watch is simulated by Watcher instead of being run normally.\n",
"value": "{\n \"trigger_data\" : { \n \"triggered_time\" : \"now\",\n \"scheduled_time\" : \"now\"\n },\n \"alternative_input\" : { \n \"foo\" : \"bar\"\n },\n \"ignore_condition\" : true, \n \"action_modes\" : {\n \"my-action\" : \"force_simulate\" \n },\n \"record_execution\" : true \n}"
},
"WatcherExecuteRequestExample2": {
"summary": "Run a watch with multiple action modes",
"description": "Run `POST _watcher/watch/my_watch/_execute` and set a different mode for each action.\n",
"value": "{\n \"action_modes\" : {\n \"action1\" : \"force_simulate\",\n \"action2\" : \"skip\"\n }\n}"
},
"WatcherExecuteRequestExample3": {
"summary": "Run a watch inline",
"description": "Run `POST _watcher/watch/_execute` to run a watch inline. All other settings for this API still apply when inlining a watch. In this example, while the inline watch defines a compare condition, during the execution this condition will be ignored.\n",
"value": "{\n \"watch\" : {\n \"trigger\" : { \"schedule\" : { \"interval\" : \"10s\" } },\n \"input\" : {\n \"search\" : {\n \"request\" : {\n \"indices\" : [ \"logs\" ],\n \"body\" : {\n \"query\" : {\n \"match\" : { \"message\": \"error\" }\n }\n }\n }\n }\n },\n \"condition\" : {\n \"compare\" : { \"ctx.payload.hits.total\" : { \"gt\" : 0 }}\n },\n \"actions\" : {\n \"log_error\" : {\n \"logging\" : {\n \"text\" : \"Found {{ctx.payload.hits.total}} errors in the logs\"\n }\n }\n }\n }\n}"
}
}
}
}
},
"watcher.put_watch": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"actions": {
"description": "The list of actions that will be run if the condition matches.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/watcher._types.Action"
}
},
"condition": {
"description": "The condition that defines if the actions should be run.",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.ConditionContainer"
}
]
},
"input": {
"description": "The input that defines the input that loads the data for the watch.",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.InputContainer"
}
]
},
"metadata": {
"description": "Metadata JSON that will be copied into the history entries.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Metadata"
}
]
},
"throttle_period": {
"description": "The minimum time between actions being run.\nThe default is 5 seconds.\nThis default can be changed in the config file with the setting `xpack.watcher.throttle.period.default_period`.\nIf both this value and the `throttle_period_in_millis` parameter are specified, Watcher uses the last parameter included in the request.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Duration"
}
]
},
"throttle_period_in_millis": {
"description": "Minimum time in milliseconds between actions being run. Defaults to 5000. If both this value and the throttle_period parameter are specified, Watcher uses the last parameter included in the request.",
"allOf": [
{
"$ref": "#/components/schemas/_types.DurationValueUnitMillis"
}
]
},
"transform": {
"description": "The transform that processes the watch payload to prepare it for the watch actions.",
"allOf": [
{
"$ref": "#/components/schemas/_types.TransformContainer"
}
]
},
"trigger": {
"description": "The trigger that defines when the watch should run.",
"allOf": [
{
"$ref": "#/components/schemas/watcher._types.TriggerContainer"
}
]
}
}
},
"examples": {
"WatcherPutWatchRequestExample1": {
"description": "Run `PUT _watcher/watch/my-watch` add a watch. The watch schedule triggers every minute. The watch search input looks for any 404 HTTP responses that occurred in the last five minutes. The watch condition checks if any search hits where found. When found, the watch action sends an email to an administrator.\n",
"value": "{\n \"trigger\" : {\n \"schedule\" : { \"cron\" : \"0 0/1 * * * ?\" }\n },\n \"input\" : {\n \"search\" : {\n \"request\" : {\n \"indices\" : [\n \"logstash*\"\n ],\n \"body\" : {\n \"query\" : {\n \"bool\" : {\n \"must\" : {\n \"match\": {\n \"response\": 404\n }\n },\n \"filter\" : {\n \"range\": {\n \"@timestamp\": {\n \"from\": \"{{ctx.trigger.scheduled_time}}||-5m\",\n \"to\": \"{{ctx.trigger.triggered_time}}\"\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"condition\" : {\n \"compare\" : { \"ctx.payload.hits.total\" : { \"gt\" : 0 }}\n },\n \"actions\" : {\n \"email_admin\" : {\n \"email\" : {\n \"to\" : \"admin@domain.host.com\",\n \"subject\" : \"404 recently encountered\"\n }\n }\n }\n}"
}
}
}
},
"required": true
},
"watcher.query_watches": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"from": {
"description": "The offset from the first result to fetch.\nIt must be non-negative.",
"default": 0,
"type": "number"
},
"size": {
"description": "The number of hits to return.\nIt must be non-negative.",
"default": 10,
"type": "number"
},
"query": {
"description": "A query that filters the watches to be returned.",
"allOf": [
{
"$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
}
]
},
"sort": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results"
},
"description": "One or more fields used to sort the search results.",
"allOf": [
{
"$ref": "#/components/schemas/_types.Sort"
}
]
},
"search_after": {
"externalDocs": {
"url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after"
},
"description": "Retrieve the next page of hits using a set of sort values from the previous page.",
"allOf": [
{
"$ref": "#/components/schemas/_types.SortResults"
}
]
}
}
}
}
}
}
},
"securitySchemes": {
"apiKeyAuth": {
"in": "header",
"name": "Authorization",
"type": "apiKey",
"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\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.\n"
},
"basicAuth": {
"scheme": "basic",
"type": "http"
},
"bearerAuth": {
"scheme": "bearer",
"type": "http",
"description": "Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.\nFor examples, refer to [Token-based authentication services](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)\n"
}
}
}
}