From c1ed27eb21513dde39abecf346d40fd78714c2e6 Mon Sep 17 00:00:00 2001 From: Jedr Blaszyk Date: Thu, 11 Apr 2024 13:01:39 +0200 Subject: [PATCH] Add Connector API specification (#2367) --- .../elasticsearch-serverless-openapi.json | 16018 +++--- output/schema/schema.json | 40831 +++++++++------- output/schema/validation-errors.json | 12 + output/typescript/types.ts | 408 + specification/_doc_ids/table.csv | 18 + .../_json_spec/connector.check_in.json | 27 + .../_json_spec/connector.delete.json | 27 + specification/_json_spec/connector.get.json | 27 + .../_json_spec/connector.last_sync.json | 32 + specification/_json_spec/connector.list.json | 49 + specification/_json_spec/connector.post.json | 26 + specification/_json_spec/connector.put.json | 32 + .../connector.update_api_key_id.json | 32 + .../connector.update_configuration.json | 32 + .../_json_spec/connector.update_error.json | 32 + .../connector.update_filtering.json | 32 + .../connector.update_index_name.json | 32 + .../_json_spec/connector.update_name.json | 32 + .../_json_spec/connector.update_native.json | 32 + .../_json_spec/connector.update_pipeline.json | 32 + .../connector.update_scheduling.json | 32 + .../connector.update_service_type.json | 32 + .../_json_spec/connector.update_status.json | 32 + specification/connector/_types/Connector.ts | 266 + .../check_in/ConnectorCheckInRequest.ts | 36 + .../check_in/ConnectorCheckInResponse.ts | 26 + .../delete/ConnectorDeleteRequest.ts | 36 + .../delete/ConnectorDeleteResponse.ts | 24 + .../connector/get/ConnectorGetRequest.ts | 36 + .../connector/get/ConnectorGetResponse.ts | 24 + .../ConnectorUpdateLastSyncRequest.ts | 55 + .../ConnectorUpdateLastSyncResponse.ts | 26 + .../connector/list/ConnectorListRequest.ts | 57 + .../connector/list/ConnectorListResponse.ts | 28 + .../connector/post/ConnectorPostRequest.ts | 42 + .../connector/post/ConnectorPostResponse.ts | 26 + .../connector/put/ConnectorPutRequest.ts | 49 + .../connector/put/ConnectorPutResponse.ts | 26 + .../ConnectorUpdateAPIKeyIDRequest.ts | 44 + .../ConnectorUpdateAPIKeyIDResponse.ts | 26 + .../ConnectorUpdateConfigurationRequest.ts | 47 + .../ConnectorUpdateConfigurationResponse.ts | 26 + .../ConnectorUpdateErrorRequest.ts | 44 + .../ConnectorUpdateErrorResponse.ts | 26 + .../ConnectorUpdateFilteringRequest.ts | 44 + .../ConnectorUpdateFilteringResponse.ts | 26 + .../ConnectorUpdateIndexNameRequest.ts | 43 + .../ConnectorUpdateIndexNameResponse.ts | 26 + .../update_name/ConnectorUpdateNameRequest.ts | 43 + .../ConnectorUpdateNameResponse.ts | 26 + .../ConnectorUpdateNativeRequest.ts | 42 + .../ConnectorUpdateNativeResponse.ts | 26 + .../ConnectorUpdatePipelineRequest.ts | 44 + .../ConnectorUpdatePipelineResponse.ts | 26 + .../ConnectorUpdateSchedulingRequest.ts | 44 + .../ConnectorUpdateSchedulingResponse.ts | 26 + .../ConnectorUpdateServiceTypeRequest.ts | 42 + .../ConnectorUpdateServiceTypeResponse.ts | 26 + .../ConnectorUpdateStatusRequest.ts | 43 + .../ConnectorUpdateStatusResponse.ts | 26 + 60 files changed, 33977 insertions(+), 25405 deletions(-) create mode 100644 specification/_json_spec/connector.check_in.json create mode 100644 specification/_json_spec/connector.delete.json create mode 100644 specification/_json_spec/connector.get.json create mode 100644 specification/_json_spec/connector.last_sync.json create mode 100644 specification/_json_spec/connector.list.json create mode 100644 specification/_json_spec/connector.post.json create mode 100644 specification/_json_spec/connector.put.json create mode 100644 specification/_json_spec/connector.update_api_key_id.json create mode 100644 specification/_json_spec/connector.update_configuration.json create mode 100644 specification/_json_spec/connector.update_error.json create mode 100644 specification/_json_spec/connector.update_filtering.json create mode 100644 specification/_json_spec/connector.update_index_name.json create mode 100644 specification/_json_spec/connector.update_name.json create mode 100644 specification/_json_spec/connector.update_native.json create mode 100644 specification/_json_spec/connector.update_pipeline.json create mode 100644 specification/_json_spec/connector.update_scheduling.json create mode 100644 specification/_json_spec/connector.update_service_type.json create mode 100644 specification/_json_spec/connector.update_status.json create mode 100644 specification/connector/_types/Connector.ts create mode 100644 specification/connector/check_in/ConnectorCheckInRequest.ts create mode 100644 specification/connector/check_in/ConnectorCheckInResponse.ts create mode 100644 specification/connector/delete/ConnectorDeleteRequest.ts create mode 100644 specification/connector/delete/ConnectorDeleteResponse.ts create mode 100644 specification/connector/get/ConnectorGetRequest.ts create mode 100644 specification/connector/get/ConnectorGetResponse.ts create mode 100644 specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts create mode 100644 specification/connector/last_sync/ConnectorUpdateLastSyncResponse.ts create mode 100644 specification/connector/list/ConnectorListRequest.ts create mode 100644 specification/connector/list/ConnectorListResponse.ts create mode 100644 specification/connector/post/ConnectorPostRequest.ts create mode 100644 specification/connector/post/ConnectorPostResponse.ts create mode 100644 specification/connector/put/ConnectorPutRequest.ts create mode 100644 specification/connector/put/ConnectorPutResponse.ts create mode 100644 specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts create mode 100644 specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponse.ts create mode 100644 specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts create mode 100644 specification/connector/update_configuration/ConnectorUpdateConfigurationResponse.ts create mode 100644 specification/connector/update_error/ConnectorUpdateErrorRequest.ts create mode 100644 specification/connector/update_error/ConnectorUpdateErrorResponse.ts create mode 100644 specification/connector/update_filtering/ConnectorUpdateFilteringRequest.ts create mode 100644 specification/connector/update_filtering/ConnectorUpdateFilteringResponse.ts create mode 100644 specification/connector/update_index_name/ConnectorUpdateIndexNameRequest.ts create mode 100644 specification/connector/update_index_name/ConnectorUpdateIndexNameResponse.ts create mode 100644 specification/connector/update_name/ConnectorUpdateNameRequest.ts create mode 100644 specification/connector/update_name/ConnectorUpdateNameResponse.ts create mode 100644 specification/connector/update_native/ConnectorUpdateNativeRequest.ts create mode 100644 specification/connector/update_native/ConnectorUpdateNativeResponse.ts create mode 100644 specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts create mode 100644 specification/connector/update_pipeline/ConnectorUpdatePipelineResponse.ts create mode 100644 specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts create mode 100644 specification/connector/update_scheduling/ConnectorUpdateSchedulingResponse.ts create mode 100644 specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts create mode 100644 specification/connector/update_service_type/ConnectorUpdateServiceTypeResponse.ts create mode 100644 specification/connector/update_status/ConnectorUpdateStatusRequest.ts create mode 100644 specification/connector/update_status/ConnectorUpdateStatusResponse.ts diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index e0620f236e..4060ebaff2 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1810,497 +1810,363 @@ } } }, - "/_count": { - "get": { + "/_connector/{connector_id}/_check_in": { + "put": { "tags": [ - "count" + "connector.check_in" ], - "summary": "Returns number of documents matching a query.", - "description": "Returns number of documents matching a query.", + "summary": "Updates the last_seen timestamp in the connector document.", + "description": "Updates the last_seen timestamp in the connector document.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html" }, - "operationId": "count-1", + "operationId": "connector-check-in", "parameters": [ { - "$ref": "#/components/parameters/count#allow_no_indices" - }, - { - "$ref": "#/components/parameters/count#analyzer" - }, - { - "$ref": "#/components/parameters/count#analyze_wildcard" - }, - { - "$ref": "#/components/parameters/count#default_operator" - }, - { - "$ref": "#/components/parameters/count#df" - }, - { - "$ref": "#/components/parameters/count#expand_wildcards" - }, - { - "$ref": "#/components/parameters/count#ignore_throttled" - }, - { - "$ref": "#/components/parameters/count#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/count#lenient" - }, - { - "$ref": "#/components/parameters/count#min_score" - }, - { - "$ref": "#/components/parameters/count#preference" - }, - { - "$ref": "#/components/parameters/count#routing" - }, - { - "$ref": "#/components/parameters/count#terminate_after" - }, - { - "$ref": "#/components/parameters/count#q" + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be checked in", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], - "requestBody": { - "$ref": "#/components/requestBodies/count" - }, "responses": { "200": { - "$ref": "#/components/responses/count#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } } } - }, - "post": { + } + }, + "/_connector/{connector_id}": { + "get": { "tags": [ - "count" + "connector.get" ], - "summary": "Returns number of documents matching a query.", - "description": "Returns number of documents matching a query.", + "summary": "Returns the details about a connector.", + "description": "Returns the details about a connector.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html" }, - "operationId": "count", + "operationId": "connector-get", "parameters": [ { - "$ref": "#/components/parameters/count#allow_no_indices" - }, - { - "$ref": "#/components/parameters/count#analyzer" - }, - { - "$ref": "#/components/parameters/count#analyze_wildcard" - }, - { - "$ref": "#/components/parameters/count#default_operator" - }, - { - "$ref": "#/components/parameters/count#df" - }, - { - "$ref": "#/components/parameters/count#expand_wildcards" - }, - { - "$ref": "#/components/parameters/count#ignore_throttled" - }, - { - "$ref": "#/components/parameters/count#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/count#lenient" - }, - { - "$ref": "#/components/parameters/count#min_score" - }, - { - "$ref": "#/components/parameters/count#preference" - }, - { - "$ref": "#/components/parameters/count#routing" - }, - { - "$ref": "#/components/parameters/count#terminate_after" - }, - { - "$ref": "#/components/parameters/count#q" + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], - "requestBody": { - "$ref": "#/components/requestBodies/count" - }, "responses": { "200": { - "$ref": "#/components/responses/count#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/connector._types:Connector" + } + } + } } } - } - }, - "/{index}/_count": { - "get": { + }, + "put": { "tags": [ - "count" + "connector.put" ], - "summary": "Returns number of documents matching a query.", - "description": "Returns number of documents matching a query.", + "summary": "Creates or updates a connector.", + "description": "Creates or updates a connector.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html" }, - "operationId": "count-3", + "operationId": "connector-put", "parameters": [ { - "$ref": "#/components/parameters/count#index" - }, - { - "$ref": "#/components/parameters/count#allow_no_indices" - }, - { - "$ref": "#/components/parameters/count#analyzer" - }, - { - "$ref": "#/components/parameters/count#analyze_wildcard" - }, - { - "$ref": "#/components/parameters/count#default_operator" - }, - { - "$ref": "#/components/parameters/count#df" - }, - { - "$ref": "#/components/parameters/count#expand_wildcards" - }, - { - "$ref": "#/components/parameters/count#ignore_throttled" - }, - { - "$ref": "#/components/parameters/count#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/count#lenient" - }, - { - "$ref": "#/components/parameters/count#min_score" - }, - { - "$ref": "#/components/parameters/count#preference" - }, - { - "$ref": "#/components/parameters/count#routing" - }, - { - "$ref": "#/components/parameters/count#terminate_after" - }, - { - "$ref": "#/components/parameters/count#q" + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be created or updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], "requestBody": { - "$ref": "#/components/requestBodies/count" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "index_name": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + }, + "is_native": { + "type": "boolean" + }, + "language": { + "type": "string" + }, + "name": { + "type": "string" + }, + "service_type": { + "type": "string" + } + }, + "required": [ + "index_name" + ] + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/count#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } } } }, - "post": { + "delete": { "tags": [ - "count" + "connector.delete" ], - "summary": "Returns number of documents matching a query.", - "description": "Returns number of documents matching a query.", + "summary": "Deletes a connector.", + "description": "Deletes a connector.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-api.html" }, - "operationId": "count-2", + "operationId": "connector-delete", "parameters": [ { - "$ref": "#/components/parameters/count#index" - }, - { - "$ref": "#/components/parameters/count#allow_no_indices" - }, - { - "$ref": "#/components/parameters/count#analyzer" - }, - { - "$ref": "#/components/parameters/count#analyze_wildcard" - }, - { - "$ref": "#/components/parameters/count#default_operator" - }, - { - "$ref": "#/components/parameters/count#df" - }, - { - "$ref": "#/components/parameters/count#expand_wildcards" - }, - { - "$ref": "#/components/parameters/count#ignore_throttled" - }, - { - "$ref": "#/components/parameters/count#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/count#lenient" - }, - { - "$ref": "#/components/parameters/count#min_score" - }, - { - "$ref": "#/components/parameters/count#preference" - }, - { - "$ref": "#/components/parameters/count#routing" - }, - { - "$ref": "#/components/parameters/count#terminate_after" - }, - { - "$ref": "#/components/parameters/count#q" + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be deleted", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], - "requestBody": { - "$ref": "#/components/requestBodies/count" - }, "responses": { "200": { - "$ref": "#/components/responses/count#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } } }, - "/{index}/_create/{id}": { + "/_connector/{connector_id}/_last_sync": { "put": { "tags": [ - "create" + "connector.last_sync" ], - "summary": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", - "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", + "summary": "Updates the stats of last sync in the connector document.", + "description": "Updates the stats of last sync in the connector document.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-last-sync-api.html" }, - "operationId": "create", + "operationId": "connector-last-sync", "parameters": [ { - "$ref": "#/components/parameters/create#index" - }, - { - "$ref": "#/components/parameters/create#id" - }, - { - "$ref": "#/components/parameters/create#pipeline" - }, - { - "$ref": "#/components/parameters/create#refresh" - }, - { - "$ref": "#/components/parameters/create#routing" - }, - { - "$ref": "#/components/parameters/create#timeout" - }, - { - "$ref": "#/components/parameters/create#version" - }, - { - "$ref": "#/components/parameters/create#version_type" - }, - { - "$ref": "#/components/parameters/create#wait_for_active_shards" + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], "requestBody": { - "$ref": "#/components/requestBodies/create" - }, - "responses": { - "200": { - "$ref": "#/components/responses/create#200" - } - } - }, - "post": { - "tags": [ - "create" - ], - "summary": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", - "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" - }, - "operationId": "create-1", - "parameters": [ - { - "$ref": "#/components/parameters/create#index" - }, - { - "$ref": "#/components/parameters/create#id" - }, - { - "$ref": "#/components/parameters/create#pipeline" - }, - { - "$ref": "#/components/parameters/create#refresh" - }, - { - "$ref": "#/components/parameters/create#routing" - }, - { - "$ref": "#/components/parameters/create#timeout" - }, - { - "$ref": "#/components/parameters/create#version" - }, - { - "$ref": "#/components/parameters/create#version_type" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "last_access_control_sync_error": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + }, + "last_access_control_sync_scheduled_at": { + "type": "string" + }, + "last_access_control_sync_status": { + "$ref": "#/components/schemas/connector._types:SyncStatus" + }, + "last_deleted_document_count": { + "type": "number" + }, + "last_incremental_sync_scheduled_at": { + "type": "string" + }, + "last_indexed_document_count": { + "type": "number" + }, + "last_seen": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + }, + "last_sync_error": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + }, + "last_sync_scheduled_at": { + "type": "string" + }, + "last_sync_status": { + "$ref": "#/components/schemas/connector._types:SyncStatus" + }, + "last_synced": { + "type": "string" + } + } + } + } }, - { - "$ref": "#/components/parameters/create#wait_for_active_shards" - } - ], - "requestBody": { - "$ref": "#/components/requestBodies/create" + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/create#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } } } } }, - "/{index}/_doc/{id}": { + "/_connector": { "get": { "tags": [ - "get" + "connector.list" ], - "summary": "Returns a document.", - "description": "Returns a document.", + "summary": "Lists all connectors.", + "description": "Lists all connectors.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-api.html" }, - "operationId": "get", + "operationId": "connector-list", "parameters": [ - { - "in": "path", - "name": "index", - "description": "Name of the index that contains the document.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:IndexName" - }, - "style": "simple" - }, - { - "in": "path", - "name": "id", - "description": "Unique identifier of the document.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" - }, - { - "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" - }, { "in": "query", - "name": "realtime", - "description": "If `true`, the request is real-time as opposed to near-real-time.", + "name": "from", + "description": "Starting offset (default: 0)", "deprecated": false, "schema": { - "type": "boolean" + "type": "number" }, "style": "form" }, { "in": "query", - "name": "refresh", - "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", + "name": "size", + "description": "Specifies a max number of results to get", "deprecated": false, "schema": { - "type": "boolean" + "type": "number" }, "style": "form" }, { "in": "query", - "name": "routing", - "description": "Target the specified primary shard.", + "name": "index_name", + "description": "A comma-separated list of connector index names to fetch connector documents for", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Routing" + "$ref": "#/components/schemas/_types:Indices" }, "style": "form" }, { "in": "query", - "name": "_source", - "description": "True or false to return the _source field or not, or a list of fields to return.", + "name": "connector_name", + "description": "A comma-separated list of connector names to fetch connector documents for", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + "$ref": "#/components/schemas/_types:Names" }, "style": "form" }, { "in": "query", - "name": "_source_excludes", - "description": "A comma-separated list of source fields to exclude in the response.", + "name": "service_type", + "description": "A comma-separated list of connector service types to fetch connector documents for", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Fields" + "$ref": "#/components/schemas/_types:Names" }, "style": "form" }, { "in": "query", - "name": "_source_includes", - "description": "A comma-separated list of source fields to include in the response.", + "name": "query", + "description": "A wildcard query string that filters connectors with matching name, description or index name", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Fields" - }, - "style": "form" - }, - { - "in": "query", - "name": "stored_fields", - "description": "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.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Fields" - }, - "style": "form" - }, - { - "in": "query", - "name": "version", - "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:VersionNumber" - }, - "style": "form" - }, - { - "in": "query", - "name": "version_type", - "description": "Specific version type: internal, external, external_gte.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:VersionType" + "type": "string" }, "style": "form" } @@ -2311,950 +2177,1193 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_global.get:GetResult" + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:Connector" + } + } + }, + "required": [ + "count", + "results" + ] } } } } } }, - "put": { + "post": { "tags": [ - "index" + "connector.post" ], - "summary": "Creates or updates a document in an index.", - "description": "Creates or updates a document in an index.", + "summary": "Creates a connector.", + "description": "Creates a connector.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html" }, - "operationId": "index", - "parameters": [ - { - "$ref": "#/components/parameters/index#index" - }, - { - "$ref": "#/components/parameters/index#id" - }, - { - "$ref": "#/components/parameters/index#if_primary_term" - }, - { - "$ref": "#/components/parameters/index#if_seq_no" - }, - { - "$ref": "#/components/parameters/index#op_type" - }, - { - "$ref": "#/components/parameters/index#pipeline" - }, - { - "$ref": "#/components/parameters/index#refresh" - }, - { - "$ref": "#/components/parameters/index#routing" - }, - { - "$ref": "#/components/parameters/index#timeout" - }, - { - "$ref": "#/components/parameters/index#version" - }, - { - "$ref": "#/components/parameters/index#version_type" - }, - { - "$ref": "#/components/parameters/index#wait_for_active_shards" - }, - { - "$ref": "#/components/parameters/index#require_alias" - } - ], + "operationId": "connector-post", "requestBody": { - "$ref": "#/components/requestBodies/index" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "index_name": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + }, + "is_native": { + "type": "boolean" + }, + "language": { + "type": "string" + }, + "name": { + "type": "string" + }, + "service_type": { + "type": "string" + } + }, + "required": [ + "index_name" + ] + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/index#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "required": [ + "id" + ] + } + } + } } } - }, - "post": { + } + }, + "/_connector/{connector_id}/_api_key_id": { + "put": { "tags": [ - "index" + "connector.update_api_key_id" ], - "summary": "Creates or updates a document in an index.", - "description": "Creates or updates a document in an index.", + "summary": "Updates the API key id and/or API key secret id fields in the connector document.", + "description": "Updates the API key id and/or API key secret id fields in the connector document.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-api-key-id-api.html" }, - "operationId": "index-1", + "operationId": "connector-update-api-key-id", "parameters": [ { - "$ref": "#/components/parameters/index#index" - }, - { - "$ref": "#/components/parameters/index#id" - }, - { - "$ref": "#/components/parameters/index#if_primary_term" - }, - { - "$ref": "#/components/parameters/index#if_seq_no" - }, - { - "$ref": "#/components/parameters/index#op_type" - }, - { - "$ref": "#/components/parameters/index#pipeline" - }, - { - "$ref": "#/components/parameters/index#refresh" - }, - { - "$ref": "#/components/parameters/index#routing" - }, - { - "$ref": "#/components/parameters/index#timeout" - }, - { - "$ref": "#/components/parameters/index#version" - }, - { - "$ref": "#/components/parameters/index#version_type" - }, - { - "$ref": "#/components/parameters/index#wait_for_active_shards" - }, - { - "$ref": "#/components/parameters/index#require_alias" + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], "requestBody": { - "$ref": "#/components/requestBodies/index" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "api_key_id": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + }, + "api_key_secret_id": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + } + } + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/index#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } } } - }, - "delete": { + } + }, + "/_connector/{connector_id}/_configuration": { + "put": { "tags": [ - "delete" + "connector.update_configuration" ], - "summary": "Removes a document from the index.", - "description": "Removes a document from the index.", + "summary": "Updates the connector configuration.", + "description": "Updates the connector configuration.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-configuration-api.html" }, - "operationId": "delete", + "operationId": "connector-update-configuration", "parameters": [ { "in": "path", - "name": "index", - "description": "Name of the target index.", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:IndexName" + "$ref": "#/components/schemas/_types:Id" }, "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "configuration": { + "$ref": "#/components/schemas/connector._types:ConnectorConfiguration" + }, + "values": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + } + } + }, + "/_connector/{connector_id}/_error": { + "put": { + "tags": [ + "connector.update_error" + ], + "summary": "Updates the error field in the connector document.", + "description": "Updates the error field in the connector document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-error-api.html" + }, + "operationId": "connector-update-error", + "parameters": [ { "in": "path", - "name": "id", - "description": "Unique identifier for the document.", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Id" }, "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + } + }, + "required": [ + "error" + ] + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + } + } + }, + "/_connector/{connector_id}/_filtering": { + "put": { + "tags": [ + "connector.update_filtering" + ], + "summary": "Updates the filtering field in the connector document.", + "description": "Updates the filtering field in the connector document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html" + }, + "operationId": "connector-update-filtering", + "parameters": [ { - "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": "refresh", - "description": "If `true`, Elasticsearch refreshes 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` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Refresh" - }, - "style": "form" - }, - { - "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" - }, - { - "in": "query", - "name": "timeout", - "description": "Period to wait for active shards.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" - }, - { - "in": "query", - "name": "version", - "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:VersionNumber" - }, - "style": "form" - }, - { - "in": "query", - "name": "version_type", - "description": "Specific version type: `external`, `external_gte`.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:VersionType" - }, - "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`).", + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:WaitForActiveShards" + "$ref": "#/components/schemas/_types:Id" }, - "style": "form" + "style": "simple" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filtering": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:FilteringConfig" + } + } + }, + "required": [ + "filtering" + ] + } + } + }, + "required": true + }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_types:WriteResponseBase" + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] } } } } } - }, - "head": { + } + }, + "/_connector/{connector_id}/_index_name": { + "put": { "tags": [ - "exists" + "connector.update_index_name" ], - "summary": "Returns information about whether a document exists in an index.", - "description": "Returns information about whether a document exists in an index.", + "summary": "Updates the index name of the connector.", + "description": "Updates the index name of the connector.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-index-name-api.html" }, - "operationId": "exists", + "operationId": "connector-update-index-name", "parameters": [ { "in": "path", - "name": "index", - "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:IndexName" + "$ref": "#/components/schemas/_types:Id" }, "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index_name": { + "$ref": "#/components/schemas/_spec_utils:WithNullValuestring" + } + }, + "required": [ + "index_name" + ] + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + } + } + }, + "/_connector/{connector_id}/_name": { + "put": { + "tags": [ + "connector.update_name" + ], + "summary": "Updates the name and/or description fields in the connector document.", + "description": "Updates the name and/or description fields in the connector document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-name-description-api.html" + }, + "operationId": "connector-update-name", + "parameters": [ { "in": "path", - "name": "id", - "description": "Identifier of the document.", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Id" }, "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + } + } + }, + "/_connector/{connector_id}/_native": { + "put": { + "tags": [ + "connector.update_native" + ], + "summary": "Updates the is_native flag of the connector.", + "description": "Updates the is_native flag of the connector.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-native-api.html" + }, + "operationId": "connector-update-native", + "parameters": [ { - "in": "query", - "name": "preference", - "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", - "deprecated": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "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" - }, - { - "in": "query", - "name": "refresh", - "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "routing", - "description": "Target the specified primary shard.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Routing" - }, - "style": "form" - }, - { - "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" - }, - { - "in": "query", - "name": "_source_excludes", - "description": "A comma-separated list of source fields to exclude in the response.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Fields" - }, - "style": "form" - }, - { - "in": "query", - "name": "_source_includes", - "description": "A comma-separated list of source fields to include in the response.", + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Fields" + "$ref": "#/components/schemas/_types:Id" }, - "style": "form" + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "is_native": { + "type": "boolean" + } + }, + "required": [ + "is_native" + ] + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + } + } + }, + "/_connector/{connector_id}/_pipeline": { + "put": { + "tags": [ + "connector.update_pipeline" + ], + "summary": "Updates the pipeline field in the connector document.", + "description": "Updates the pipeline field in the connector document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-pipeline-api.html" + }, + "operationId": "connector-update-pipeline", + "parameters": [ { - "in": "query", - "name": "stored_fields", - "description": "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.", + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Fields" + "$ref": "#/components/schemas/_types:Id" }, - "style": "form" + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pipeline": { + "$ref": "#/components/schemas/connector._types:IngestPipelineParams" + } + }, + "required": [ + "pipeline" + ] + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + } + } + }, + "/_connector/{connector_id}/_scheduling": { + "put": { + "tags": [ + "connector.update_scheduling" + ], + "summary": "Updates the scheduling field in the connector document.", + "description": "Updates the scheduling field in the connector document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-scheduling-api.html" + }, + "operationId": "connector-update-scheduling", + "parameters": [ { - "in": "query", - "name": "version", - "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:VersionNumber" + "$ref": "#/components/schemas/_types:Id" }, - "style": "form" + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scheduling": { + "$ref": "#/components/schemas/connector._types:SchedulingConfiguration" + } + }, + "required": [ + "scheduling" + ] + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + } + } + }, + "/_connector/{connector_id}/_service_type": { + "put": { + "tags": [ + "connector.update_service_type" + ], + "summary": "Updates the service type of the connector.", + "description": "Updates the service type of the connector.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-service-type-api.html" + }, + "operationId": "connector-update-service-type", + "parameters": [ { - "in": "query", - "name": "version_type", - "description": "Specific version type: `external`, `external_gte`.", + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:VersionType" + "$ref": "#/components/schemas/_types:Id" }, - "style": "form" + "style": "simple" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "service_type": { + "type": "string" + } + }, + "required": [ + "service_type" + ] + } + } + }, + "required": true + }, "responses": { "200": { "description": "", "content": { - "application/json": {} + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } } } } } }, - "/{index}/_delete_by_query": { - "post": { + "/_connector/{connector_id}/_status": { + "put": { "tags": [ - "delete_by_query" + "connector.update_status" ], - "summary": "Deletes documents matching the provided query.", - "description": "Deletes documents matching the provided query.", + "summary": "Updates the status of the connector.", + "description": "Updates the status of the connector.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-status-api.html" }, - "operationId": "delete-by-query", + "operationId": "connector-update-status", "parameters": [ { "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`.", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Indices" + "$ref": "#/components/schemas/_types:Id" }, "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/connector._types:ConnectorStatus" + } + }, + "required": [ + "status" + ] + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + } + } + }, + "/_count": { + "get": { + "tags": [ + "count" + ], + "summary": "Returns number of documents matching a query.", + "description": "Returns number of documents matching a query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + }, + "operationId": "count-1", + "parameters": [ { - "in": "query", - "name": "allow_no_indices", - "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/count#allow_no_indices" }, { - "in": "query", - "name": "analyzer", - "description": "Analyzer to use for the query string.", - "deprecated": false, - "schema": { - "type": "string" - }, - "style": "form" + "$ref": "#/components/parameters/count#analyzer" }, { - "in": "query", - "name": "analyze_wildcard", - "description": "If `true`, wildcard and prefix queries are analyzed.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/count#analyze_wildcard" }, { - "in": "query", - "name": "conflicts", - "description": "What to do if delete by query hits version conflicts: `abort` or `proceed`.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Conflicts" - }, - "style": "form" + "$ref": "#/components/parameters/count#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" + "$ref": "#/components/parameters/count#df" }, { - "in": "query", - "name": "df", - "description": "Field to use as default where no field prefix is given in the query string.", - "deprecated": false, - "schema": { - "type": "string" - }, - "style": "form" + "$ref": "#/components/parameters/count#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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" - }, - "style": "form" + "$ref": "#/components/parameters/count#ignore_throttled" }, { - "in": "query", - "name": "from", - "description": "Starting offset (default: 0)", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" + "$ref": "#/components/parameters/count#ignore_unavailable" }, { - "in": "query", - "name": "ignore_unavailable", - "description": "If `false`, the request returns an error if it targets a missing or closed index.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/count#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" + "$ref": "#/components/parameters/count#min_score" }, { - "in": "query", - "name": "max_docs", - "description": "Maximum number of documents to process.\nDefaults to all documents.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" + "$ref": "#/components/parameters/count#preference" }, { - "in": "query", - "name": "preference", - "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", - "deprecated": false, - "schema": { - "type": "string" - }, - "style": "form" + "$ref": "#/components/parameters/count#routing" }, { - "in": "query", - "name": "refresh", - "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/count#terminate_after" }, { - "in": "query", - "name": "request_cache", - "description": "If `true`, the request cache is used for this request.\nDefaults to the index-level setting.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/count#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/count" + }, + "responses": { + "200": { + "$ref": "#/components/responses/count#200" + } + } + }, + "post": { + "tags": [ + "count" + ], + "summary": "Returns number of documents matching a query.", + "description": "Returns number of documents matching a query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + }, + "operationId": "count", + "parameters": [ + { + "$ref": "#/components/parameters/count#allow_no_indices" }, { - "in": "query", - "name": "requests_per_second", - "description": "The throttle for this request in sub-requests per second.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" + "$ref": "#/components/parameters/count#analyzer" }, { - "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" - }, - { - "in": "query", - "name": "q", - "description": "Query in the Lucene query string syntax.", - "deprecated": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "in": "query", - "name": "scroll", - "description": "Period to retain the search context for scrolling.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" + "$ref": "#/components/parameters/count#analyze_wildcard" }, { - "in": "query", - "name": "scroll_size", - "description": "Size of the scroll request that powers the operation.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" + "$ref": "#/components/parameters/count#default_operator" }, { - "in": "query", - "name": "search_timeout", - "description": "Explicit timeout for each search request.\nDefaults to no timeout.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" + "$ref": "#/components/parameters/count#df" }, { - "in": "query", - "name": "search_type", - "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:SearchType" - }, - "style": "form" + "$ref": "#/components/parameters/count#expand_wildcards" }, { - "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" + "$ref": "#/components/parameters/count#ignore_throttled" }, { - "in": "query", - "name": "sort", - "description": "A comma-separated list of : pairs.", - "deprecated": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "style": "form" + "$ref": "#/components/parameters/count#ignore_unavailable" }, { - "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" + "$ref": "#/components/parameters/count#lenient" }, { - "in": "query", - "name": "terminate_after", - "description": "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.\nUse 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" + "$ref": "#/components/parameters/count#min_score" }, { - "in": "query", - "name": "timeout", - "description": "Period each deletion request waits for active shards.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" + "$ref": "#/components/parameters/count#preference" }, { - "in": "query", - "name": "version", - "description": "If `true`, returns the document version as part of a hit.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/count#routing" }, { - "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" + "$ref": "#/components/parameters/count#terminate_after" }, { - "in": "query", - "name": "wait_for_completion", - "description": "If `true`, the request blocks until the operation is complete.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/count#q" } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "max_docs": { - "description": "The maximum number of documents to delete.", - "type": "number" - }, - "query": { - "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" - }, - "slice": { - "$ref": "#/components/schemas/_types:SlicedScroll" - } - } - } - } - }, - "required": true + "$ref": "#/components/requestBodies/count" }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "batches": { - "type": "number" - }, - "deleted": { - "type": "number" - }, - "failures": { - "type": "array", - "items": { - "$ref": "#/components/schemas/_types:BulkIndexByScrollFailure" - } - }, - "noops": { - "type": "number" - }, - "requests_per_second": { - "type": "number" - }, - "retries": { - "$ref": "#/components/schemas/_types:Retries" - }, - "slice_id": { - "type": "number" - }, - "task": { - "$ref": "#/components/schemas/_types:TaskId" - }, - "throttled": { - "$ref": "#/components/schemas/_types:Duration" - }, - "throttled_millis": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" - }, - "throttled_until": { - "$ref": "#/components/schemas/_types:Duration" - }, - "throttled_until_millis": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" - }, - "timed_out": { - "type": "boolean" - }, - "took": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" - }, - "total": { - "type": "number" - }, - "version_conflicts": { - "type": "number" - } - } - } - } - } + "$ref": "#/components/responses/count#200" } } } }, - "/_scripts/{id}": { + "/{index}/_count": { "get": { "tags": [ - "get_script" + "count" ], - "summary": "Returns a script.", - "description": "Returns a script.", + "summary": "Returns number of documents matching a query.", + "description": "Returns number of documents matching a query.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" }, - "operationId": "get-script", + "operationId": "count-3", "parameters": [ { - "in": "path", - "name": "id", - "description": "Identifier for the stored script or search template.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/count#index" }, { - "in": "query", - "name": "master_timeout", - "description": "Specify timeout for connection to master", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" + "$ref": "#/components/parameters/count#allow_no_indices" + }, + { + "$ref": "#/components/parameters/count#analyzer" + }, + { + "$ref": "#/components/parameters/count#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/count#default_operator" + }, + { + "$ref": "#/components/parameters/count#df" + }, + { + "$ref": "#/components/parameters/count#expand_wildcards" + }, + { + "$ref": "#/components/parameters/count#ignore_throttled" + }, + { + "$ref": "#/components/parameters/count#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/count#lenient" + }, + { + "$ref": "#/components/parameters/count#min_score" + }, + { + "$ref": "#/components/parameters/count#preference" + }, + { + "$ref": "#/components/parameters/count#routing" + }, + { + "$ref": "#/components/parameters/count#terminate_after" + }, + { + "$ref": "#/components/parameters/count#q" } ], + "requestBody": { + "$ref": "#/components/requestBodies/count" + }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "found": { - "type": "boolean" - }, - "script": { - "$ref": "#/components/schemas/_types:StoredScript" - } - }, - "required": [ - "_id", - "found" - ] - } - } - } + "$ref": "#/components/responses/count#200" } } }, + "post": { + "tags": [ + "count" + ], + "summary": "Returns number of documents matching a query.", + "description": "Returns number of documents matching a query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + }, + "operationId": "count-2", + "parameters": [ + { + "$ref": "#/components/parameters/count#index" + }, + { + "$ref": "#/components/parameters/count#allow_no_indices" + }, + { + "$ref": "#/components/parameters/count#analyzer" + }, + { + "$ref": "#/components/parameters/count#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/count#default_operator" + }, + { + "$ref": "#/components/parameters/count#df" + }, + { + "$ref": "#/components/parameters/count#expand_wildcards" + }, + { + "$ref": "#/components/parameters/count#ignore_throttled" + }, + { + "$ref": "#/components/parameters/count#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/count#lenient" + }, + { + "$ref": "#/components/parameters/count#min_score" + }, + { + "$ref": "#/components/parameters/count#preference" + }, + { + "$ref": "#/components/parameters/count#routing" + }, + { + "$ref": "#/components/parameters/count#terminate_after" + }, + { + "$ref": "#/components/parameters/count#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/count" + }, + "responses": { + "200": { + "$ref": "#/components/responses/count#200" + } + } + } + }, + "/{index}/_create/{id}": { "put": { "tags": [ - "put_script" + "create" ], - "summary": "Creates or updates a script.", - "description": "Creates or updates a script.", + "summary": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", + "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, - "operationId": "put-script", + "operationId": "create", "parameters": [ { - "$ref": "#/components/parameters/put_script#id" + "$ref": "#/components/parameters/create#index" }, { - "$ref": "#/components/parameters/put_script#master_timeout" + "$ref": "#/components/parameters/create#id" }, { - "$ref": "#/components/parameters/put_script#timeout" + "$ref": "#/components/parameters/create#pipeline" + }, + { + "$ref": "#/components/parameters/create#refresh" + }, + { + "$ref": "#/components/parameters/create#routing" + }, + { + "$ref": "#/components/parameters/create#timeout" + }, + { + "$ref": "#/components/parameters/create#version" + }, + { + "$ref": "#/components/parameters/create#version_type" + }, + { + "$ref": "#/components/parameters/create#wait_for_active_shards" } ], "requestBody": { - "$ref": "#/components/requestBodies/put_script" + "$ref": "#/components/requestBodies/create" }, "responses": { "200": { - "$ref": "#/components/responses/put_script#200" + "$ref": "#/components/responses/create#200" } } }, "post": { "tags": [ - "put_script" + "create" ], - "summary": "Creates or updates a script.", - "description": "Creates or updates a script.", + "summary": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", + "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, - "operationId": "put-script-1", + "operationId": "create-1", "parameters": [ { - "$ref": "#/components/parameters/put_script#id" + "$ref": "#/components/parameters/create#index" }, { - "$ref": "#/components/parameters/put_script#master_timeout" + "$ref": "#/components/parameters/create#id" }, { - "$ref": "#/components/parameters/put_script#timeout" + "$ref": "#/components/parameters/create#pipeline" + }, + { + "$ref": "#/components/parameters/create#refresh" + }, + { + "$ref": "#/components/parameters/create#routing" + }, + { + "$ref": "#/components/parameters/create#timeout" + }, + { + "$ref": "#/components/parameters/create#version" + }, + { + "$ref": "#/components/parameters/create#version_type" + }, + { + "$ref": "#/components/parameters/create#wait_for_active_shards" } ], "requestBody": { - "$ref": "#/components/requestBodies/put_script" + "$ref": "#/components/requestBodies/create" }, "responses": { "200": { - "$ref": "#/components/responses/put_script#200" + "$ref": "#/components/responses/create#200" } } - }, - "delete": { + } + }, + "/{index}/_doc/{id}": { + "get": { "tags": [ - "delete_script" + "get" ], - "summary": "Deletes a script.", - "description": "Deletes a script.", + "summary": "Returns a document.", + "description": "Returns a document.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, - "operationId": "delete-script", + "operationId": "get", "parameters": [ + { + "in": "path", + "name": "index", + "description": "Name of the index that contains the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, { "in": "path", "name": "id", - "description": "Identifier for the stored script or search template.", + "description": "Unique identifier of the document.", "required": true, "deprecated": false, "schema": { @@ -3264,359 +3373,103 @@ }, { "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.", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on. Random by default.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "type": "string" }, "style": "form" }, { "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.", + "name": "realtime", + "description": "If `true`, the request is real-time as opposed to near-real-time.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "type": "boolean" }, "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } - } - } - } - }, - "/_enrich/policy/{name}": { - "get": { - "tags": [ - "enrich.get_policy" - ], - "summary": "Gets information about an enrich policy.", - "description": "Gets information about an enrich policy.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" - }, - "operationId": "enrich-get-policy", - "parameters": [ - { - "$ref": "#/components/parameters/enrich.get_policy#name" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/enrich.get_policy#200" - } - } - }, - "put": { - "tags": [ - "enrich.put_policy" - ], - "summary": "Creates a new enrich policy.", - "description": "Creates a new enrich policy.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html" - }, - "operationId": "enrich-put-policy", - "parameters": [ + }, { - "in": "path", - "name": "name", - "description": "Name of the enrich policy to create or update.", - "required": true, + "in": "query", + "name": "refresh", + "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Name" + "type": "boolean" }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "geo_match": { - "$ref": "#/components/schemas/enrich._types:Policy" - }, - "match": { - "$ref": "#/components/schemas/enrich._types:Policy" - }, - "range": { - "$ref": "#/components/schemas/enrich._types:Policy" - } - } - } - } + "style": "form" }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } - } - } - }, - "delete": { - "tags": [ - "enrich.delete_policy" - ], - "summary": "Deletes an existing enrich policy and its enrich index.", - "description": "Deletes an existing enrich policy and its enrich index.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html" - }, - "operationId": "enrich-delete-policy", - "parameters": [ { - "in": "path", - "name": "name", - "description": "Enrich policy to delete.", - "required": true, + "in": "query", + "name": "routing", + "description": "Target the specified primary shard.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Name" + "$ref": "#/components/schemas/_types:Routing" }, - "style": "simple" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } - } - } - } - }, - "/_enrich/policy/{name}/_execute": { - "put": { - "tags": [ - "enrich.execute_policy" - ], - "summary": "Creates the enrich index for an existing enrich policy.", - "description": "Creates the enrich index for an existing enrich policy.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html" - }, - "operationId": "enrich-execute-policy", - "parameters": [ + "style": "form" + }, { - "in": "path", - "name": "name", - "description": "Enrich policy to execute.", - "required": true, + "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/_types:Name" + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" }, - "style": "simple" + "style": "form" }, { "in": "query", - "name": "wait_for_completion", - "description": "If `true`, the request blocks other enrich policy execution requests until complete.", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude in the response.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Fields" }, "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/enrich.execute_policy:ExecuteEnrichPolicyStatus" - }, - "task_id": { - "$ref": "#/components/schemas/_types:TaskId" - } - } - } - } - } - } - } - } - }, - "/_enrich/policy": { - "get": { - "tags": [ - "enrich.get_policy" - ], - "summary": "Gets information about an enrich policy.", - "description": "Gets information about an enrich policy.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" - }, - "operationId": "enrich-get-policy-1", - "responses": { - "200": { - "$ref": "#/components/responses/enrich.get_policy#200" - } - } - } - }, - "/_enrich/_stats": { - "get": { - "tags": [ - "enrich.stats" - ], - "summary": "Gets enrich coordinator statistics and information about enrich policies that are currently executing.", - "description": "Gets enrich coordinator statistics and information about enrich policies that are currently executing.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html" - }, - "operationId": "enrich-stats", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "coordinator_stats": { - "description": "Objects containing information about each coordinating ingest node for configured enrich processors.", - "type": "array", - "items": { - "$ref": "#/components/schemas/enrich.stats:CoordinatorStats" - } - }, - "executing_policies": { - "description": "Objects containing information about each enrich policy that is currently executing.", - "type": "array", - "items": { - "$ref": "#/components/schemas/enrich.stats:ExecutingPolicy" - } - }, - "cache_stats": { - "description": "Objects containing information about the enrich cache stats on each ingest node.", - "type": "array", - "items": { - "$ref": "#/components/schemas/enrich.stats:CacheStats" - } - } - }, - "required": [ - "coordinator_stats", - "executing_policies" - ] - } - } - } - } - } - } - }, - "/_eql/search/{id}": { - "get": { - "tags": [ - "eql.get" - ], - "summary": "Returns async results from previously executed Event Query Language (EQL) search", - "description": "Returns async results from previously executed Event Query Language (EQL) search", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-search-api.html" - }, - "operationId": "eql-get", - "parameters": [ + }, { - "in": "path", - "name": "id", - "description": "Identifier for the search.", - "required": true, + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Id" + "$ref": "#/components/schemas/_types:Fields" }, - "style": "simple" + "style": "form" }, { "in": "query", - "name": "keep_alive", - "description": "Period for which the search and its results are stored on the cluster.\nDefaults to the keep_alive value set by the search’s EQL search API request.", + "name": "stored_fields", + "description": "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.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:Fields" }, "style": "form" }, { "in": "query", - "name": "wait_for_completion_timeout", - "description": "Timeout duration to wait for the request to finish.\nDefaults to no timeout, meaning the request waits for complete search results.", + "name": "version", + "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:VersionNumber" }, "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/eql._types:EqlSearchResponseBase" - } - } - } - } - } - }, - "delete": { - "tags": [ - "eql.delete" - ], - "summary": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", - "description": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" - }, - "operationId": "eql-delete", - "parameters": [ + }, { - "in": "path", - "name": "id", - "description": "Identifier for the search to delete.\nA search ID is provided in the EQL search API's response for an async search.\nA search ID is also provided if the request’s `keep_on_completion` parameter is `true`.", - "required": true, + "in": "query", + "name": "version_type", + "description": "Specific version type: internal, external, external_gte.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Id" + "$ref": "#/components/schemas/_types:VersionType" }, - "style": "simple" + "style": "form" } ], "responses": { @@ -3625,182 +3478,148 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + "$ref": "#/components/schemas/_global.get:GetResult" } } } } } - } - }, - "/_eql/search/status/{id}": { - "get": { + }, + "put": { "tags": [ - "eql.get_status" + "index" ], - "summary": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", - "description": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", + "summary": "Creates or updates a document in an index.", + "description": "Creates or updates a document in an index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-status-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, - "operationId": "eql-get-status", + "operationId": "index", "parameters": [ { - "in": "path", - "name": "id", - "description": "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": { - "id": { - "$ref": "#/components/schemas/_types:Id" - }, - "is_partial": { - "description": "If true, the search request is still executing. If false, the search is completed.", - "type": "boolean" - }, - "is_running": { - "description": "If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts.", - "type": "boolean" - }, - "start_time_in_millis": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, - "expiration_time_in_millis": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, - "completion_status": { - "description": "For a completed search shows the http status code of the completed search.", - "type": "number" - } - }, - "required": [ - "id", - "is_partial", - "is_running" - ] - } - } - } - } - } - } - }, - "/{index}/_eql/search": { - "get": { - "tags": [ - "eql.search" - ], - "summary": "Returns results matching a query expressed in Event Query Language (EQL)", - "description": "Returns results matching a query expressed in Event Query Language (EQL)", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" - }, - "operationId": "eql-search", - "parameters": [ + "$ref": "#/components/parameters/index#index" + }, { - "$ref": "#/components/parameters/eql.search#index" + "$ref": "#/components/parameters/index#id" }, { - "$ref": "#/components/parameters/eql.search#allow_no_indices" + "$ref": "#/components/parameters/index#if_primary_term" }, { - "$ref": "#/components/parameters/eql.search#expand_wildcards" + "$ref": "#/components/parameters/index#if_seq_no" }, { - "$ref": "#/components/parameters/eql.search#ignore_unavailable" + "$ref": "#/components/parameters/index#op_type" }, { - "$ref": "#/components/parameters/eql.search#keep_alive" + "$ref": "#/components/parameters/index#pipeline" }, { - "$ref": "#/components/parameters/eql.search#keep_on_completion" + "$ref": "#/components/parameters/index#refresh" }, { - "$ref": "#/components/parameters/eql.search#wait_for_completion_timeout" + "$ref": "#/components/parameters/index#routing" + }, + { + "$ref": "#/components/parameters/index#timeout" + }, + { + "$ref": "#/components/parameters/index#version" + }, + { + "$ref": "#/components/parameters/index#version_type" + }, + { + "$ref": "#/components/parameters/index#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/index#require_alias" } ], "requestBody": { - "$ref": "#/components/requestBodies/eql.search" + "$ref": "#/components/requestBodies/index" }, "responses": { "200": { - "$ref": "#/components/responses/eql.search#200" + "$ref": "#/components/responses/index#200" } } }, "post": { "tags": [ - "eql.search" + "index" ], - "summary": "Returns results matching a query expressed in Event Query Language (EQL)", - "description": "Returns results matching a query expressed in Event Query Language (EQL)", + "summary": "Creates or updates a document in an index.", + "description": "Creates or updates a document in an index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, - "operationId": "eql-search-1", + "operationId": "index-1", "parameters": [ { - "$ref": "#/components/parameters/eql.search#index" + "$ref": "#/components/parameters/index#index" }, { - "$ref": "#/components/parameters/eql.search#allow_no_indices" + "$ref": "#/components/parameters/index#id" }, { - "$ref": "#/components/parameters/eql.search#expand_wildcards" + "$ref": "#/components/parameters/index#if_primary_term" }, { - "$ref": "#/components/parameters/eql.search#ignore_unavailable" + "$ref": "#/components/parameters/index#if_seq_no" }, { - "$ref": "#/components/parameters/eql.search#keep_alive" + "$ref": "#/components/parameters/index#op_type" }, { - "$ref": "#/components/parameters/eql.search#keep_on_completion" + "$ref": "#/components/parameters/index#pipeline" }, { - "$ref": "#/components/parameters/eql.search#wait_for_completion_timeout" + "$ref": "#/components/parameters/index#refresh" + }, + { + "$ref": "#/components/parameters/index#routing" + }, + { + "$ref": "#/components/parameters/index#timeout" + }, + { + "$ref": "#/components/parameters/index#version" + }, + { + "$ref": "#/components/parameters/index#version_type" + }, + { + "$ref": "#/components/parameters/index#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/index#require_alias" } ], "requestBody": { - "$ref": "#/components/requestBodies/eql.search" + "$ref": "#/components/requestBodies/index" }, "responses": { "200": { - "$ref": "#/components/responses/eql.search#200" + "$ref": "#/components/responses/index#200" } } - } - }, - "/{index}/_source/{id}": { - "get": { + }, + "delete": { "tags": [ - "get_source" + "delete" ], - "summary": "Returns the source of a document.", - "description": "Returns the source of a document.", + "summary": "Removes a document from the index.", + "description": "Removes a document from the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html" }, - "operationId": "get-source", + "operationId": "delete", "parameters": [ { "in": "path", "name": "index", - "description": "Name of the index that contains the document.", + "description": "Name of the target index.", "required": true, "deprecated": false, "schema": { @@ -3811,7 +3630,7 @@ { "in": "path", "name": "id", - "description": "Unique identifier of the document.", + "description": "Unique identifier for the document.", "required": true, "deprecated": false, "schema": { @@ -3821,38 +3640,38 @@ }, { "in": "query", - "name": "preference", - "description": "Specifies the node or shard the operation should be performed on. Random by default.", + "name": "if_primary_term", + "description": "Only perform the operation if the document has this primary term.", "deprecated": false, "schema": { - "type": "string" + "type": "number" }, "style": "form" }, { "in": "query", - "name": "realtime", - "description": "Boolean) If true, the request is real-time as opposed to near-real-time.", + "name": "if_seq_no", + "description": "Only perform the operation if the document has this sequence number.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:SequenceNumber" }, "style": "form" }, { "in": "query", "name": "refresh", - "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", + "description": "If `true`, Elasticsearch refreshes 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` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Refresh" }, "style": "form" }, { "in": "query", "name": "routing", - "description": "Target the specified primary shard.", + "description": "Custom value used to route operations to a specific shard.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Routing" @@ -3861,60 +3680,41 @@ }, { "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" - }, - { - "in": "query", - "name": "_source_excludes", - "description": "A comma-separated list of source fields to exclude in the response.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Fields" - }, - "style": "form" - }, - { - "in": "query", - "name": "_source_includes", - "description": "A comma-separated list of source fields to include in the response.", + "name": "timeout", + "description": "Period to wait for active shards.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Fields" + "$ref": "#/components/schemas/_types:Duration" }, "style": "form" }, { "in": "query", - "name": "stored_fields", + "name": "version", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Fields" + "$ref": "#/components/schemas/_types:VersionNumber" }, "style": "form" }, { "in": "query", - "name": "version", - "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", + "name": "version_type", + "description": "Specific version type: `external`, `external_gte`.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:VersionNumber" + "$ref": "#/components/schemas/_types:VersionType" }, "style": "form" }, { "in": "query", - "name": "version_type", - "description": "Specific version type: internal, external, external_gte.", + "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:VersionType" + "$ref": "#/components/schemas/_types:WaitForActiveShards" }, "style": "form" } @@ -3925,7 +3725,7 @@ "content": { "application/json": { "schema": { - "type": "object" + "$ref": "#/components/schemas/_types:WriteResponseBase" } } } @@ -3934,14 +3734,14 @@ }, "head": { "tags": [ - "exists_source" + "exists" ], - "summary": "Returns information about whether a document source exists in an index.", - "description": "Returns information about whether a document source exists in an index.", + "summary": "Returns information about whether a document exists in an index.", + "description": "Returns information about whether a document exists in an index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, - "operationId": "exists-source", + "operationId": "exists", "parameters": [ { "in": "path", @@ -3978,7 +3778,7 @@ { "in": "query", "name": "realtime", - "description": "If true, the request is real-time as opposed to near-real-time.", + "description": "If `true`, the request is real-time as opposed to near-real-time.", "deprecated": false, "schema": { "type": "boolean" @@ -4035,6 +3835,16 @@ }, "style": "form" }, + { + "in": "query", + "name": "stored_fields", + "description": "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, { "in": "query", "name": "version", @@ -4066,528 +3876,742 @@ } } }, - "/{index}/_explain/{id}": { - "get": { + "/{index}/_delete_by_query": { + "post": { "tags": [ - "explain" + "delete_by_query" ], - "summary": "Returns information about why a specific matches (or doesn't match) a query.", - "description": "Returns information about why a specific matches (or doesn't match) a query.", + "summary": "Deletes documents matching the provided query.", + "description": "Deletes documents matching the provided query.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html" }, - "operationId": "explain", + "operationId": "delete-by-query", "parameters": [ { - "$ref": "#/components/parameters/explain#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" }, { - "$ref": "#/components/parameters/explain#id" + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#analyzer" + "in": "query", + "name": "analyzer", + "description": "Analyzer to use for the query string.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#analyze_wildcard" + "in": "query", + "name": "analyze_wildcard", + "description": "If `true`, wildcard and prefix queries are analyzed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#default_operator" + "in": "query", + "name": "conflicts", + "description": "What to do if delete by query hits version conflicts: `abort` or `proceed`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Conflicts" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#df" + "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" }, { - "$ref": "#/components/parameters/explain#lenient" + "in": "query", + "name": "df", + "description": "Field to use as default where no field prefix is given in the query string.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#preference" + "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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#routing" + "in": "query", + "name": "from", + "description": "Starting offset (default: 0)", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#_source" + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#_source_excludes" + "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" }, { - "$ref": "#/components/parameters/explain#_source_includes" + "in": "query", + "name": "max_docs", + "description": "Maximum number of documents to process.\nDefaults to all documents.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#stored_fields" + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#q" - } - ], - "requestBody": { - "$ref": "#/components/requestBodies/explain" - }, - "responses": { - "200": { - "$ref": "#/components/responses/explain#200" - } - } - }, - "post": { - "tags": [ - "explain" - ], - "summary": "Returns information about why a specific matches (or doesn't match) a query.", - "description": "Returns information about why a specific matches (or doesn't match) a query.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" - }, - "operationId": "explain-1", - "parameters": [ + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, { - "$ref": "#/components/parameters/explain#index" + "in": "query", + "name": "request_cache", + "description": "If `true`, the request cache is used for this request.\nDefaults to the index-level setting.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#id" + "in": "query", + "name": "requests_per_second", + "description": "The throttle for this request in sub-requests per second.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#analyzer" + "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" }, { - "$ref": "#/components/parameters/explain#analyze_wildcard" + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#default_operator" + "in": "query", + "name": "scroll", + "description": "Period to retain the search context for scrolling.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#df" + "in": "query", + "name": "scroll_size", + "description": "Size of the scroll request that powers the operation.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#lenient" + "in": "query", + "name": "search_timeout", + "description": "Explicit timeout for each search request.\nDefaults to no timeout.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#preference" + "in": "query", + "name": "search_type", + "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#routing" + "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" }, { - "$ref": "#/components/parameters/explain#_source" + "in": "query", + "name": "sort", + "description": "A comma-separated list of : pairs.", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#_source_excludes" + "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" }, { - "$ref": "#/components/parameters/explain#_source_includes" + "in": "query", + "name": "terminate_after", + "description": "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.\nUse 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" }, { - "$ref": "#/components/parameters/explain#stored_fields" + "in": "query", + "name": "timeout", + "description": "Period each deletion request waits for active shards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" }, { - "$ref": "#/components/parameters/explain#q" + "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": "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" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "If `true`, the request blocks until the operation is complete.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "requestBody": { - "$ref": "#/components/requestBodies/explain" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "max_docs": { + "description": "The maximum number of documents to delete.", + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "slice": { + "$ref": "#/components/schemas/_types:SlicedScroll" + } + } + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/explain#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "batches": { + "type": "number" + }, + "deleted": { + "type": "number" + }, + "failures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:BulkIndexByScrollFailure" + } + }, + "noops": { + "type": "number" + }, + "requests_per_second": { + "type": "number" + }, + "retries": { + "$ref": "#/components/schemas/_types:Retries" + }, + "slice_id": { + "type": "number" + }, + "task": { + "$ref": "#/components/schemas/_types:TaskId" + }, + "throttled": { + "$ref": "#/components/schemas/_types:Duration" + }, + "throttled_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "throttled_until": { + "$ref": "#/components/schemas/_types:Duration" + }, + "throttled_until_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "timed_out": { + "type": "boolean" + }, + "took": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "total": { + "type": "number" + }, + "version_conflicts": { + "type": "number" + } + } + } + } + } } } } }, - "/_field_caps": { + "/_scripts/{id}": { "get": { "tags": [ - "field_caps" + "get_script" ], - "summary": "Returns the information about the capabilities of fields among multiple indices.", - "description": "Returns the information about the capabilities of fields among multiple indices.", + "summary": "Returns a script.", + "description": "Returns a script.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, - "operationId": "field-caps", + "operationId": "get-script", "parameters": [ { - "$ref": "#/components/parameters/field_caps#allow_no_indices" - }, - { - "$ref": "#/components/parameters/field_caps#expand_wildcards" - }, - { - "$ref": "#/components/parameters/field_caps#fields" - }, - { - "$ref": "#/components/parameters/field_caps#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/field_caps#include_unmapped" - }, - { - "$ref": "#/components/parameters/field_caps#filters" - }, - { - "$ref": "#/components/parameters/field_caps#types" + "in": "path", + "name": "id", + "description": "Identifier for the stored script or search template.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/field_caps#include_empty_fields" + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], - "requestBody": { - "$ref": "#/components/requestBodies/field_caps" - }, "responses": { "200": { - "$ref": "#/components/responses/field_caps#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "found": { + "type": "boolean" + }, + "script": { + "$ref": "#/components/schemas/_types:StoredScript" + } + }, + "required": [ + "_id", + "found" + ] + } + } + } } } }, - "post": { + "put": { "tags": [ - "field_caps" + "put_script" ], - "summary": "Returns the information about the capabilities of fields among multiple indices.", - "description": "Returns the information about the capabilities of fields among multiple indices.", + "summary": "Creates or updates a script.", + "description": "Creates or updates a script.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, - "operationId": "field-caps-1", + "operationId": "put-script", "parameters": [ { - "$ref": "#/components/parameters/field_caps#allow_no_indices" - }, - { - "$ref": "#/components/parameters/field_caps#expand_wildcards" - }, - { - "$ref": "#/components/parameters/field_caps#fields" - }, - { - "$ref": "#/components/parameters/field_caps#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/field_caps#include_unmapped" - }, - { - "$ref": "#/components/parameters/field_caps#filters" + "$ref": "#/components/parameters/put_script#id" }, { - "$ref": "#/components/parameters/field_caps#types" + "$ref": "#/components/parameters/put_script#master_timeout" }, { - "$ref": "#/components/parameters/field_caps#include_empty_fields" + "$ref": "#/components/parameters/put_script#timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/field_caps" + "$ref": "#/components/requestBodies/put_script" }, "responses": { "200": { - "$ref": "#/components/responses/field_caps#200" + "$ref": "#/components/responses/put_script#200" } } - } - }, - "/{index}/_field_caps": { - "get": { + }, + "post": { "tags": [ - "field_caps" + "put_script" ], - "summary": "Returns the information about the capabilities of fields among multiple indices.", - "description": "Returns the information about the capabilities of fields among multiple indices.", + "summary": "Creates or updates a script.", + "description": "Creates or updates a script.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, - "operationId": "field-caps-2", + "operationId": "put-script-1", "parameters": [ { - "$ref": "#/components/parameters/field_caps#index" - }, - { - "$ref": "#/components/parameters/field_caps#allow_no_indices" - }, - { - "$ref": "#/components/parameters/field_caps#expand_wildcards" - }, - { - "$ref": "#/components/parameters/field_caps#fields" - }, - { - "$ref": "#/components/parameters/field_caps#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/field_caps#include_unmapped" - }, - { - "$ref": "#/components/parameters/field_caps#filters" + "$ref": "#/components/parameters/put_script#id" }, { - "$ref": "#/components/parameters/field_caps#types" + "$ref": "#/components/parameters/put_script#master_timeout" }, { - "$ref": "#/components/parameters/field_caps#include_empty_fields" + "$ref": "#/components/parameters/put_script#timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/field_caps" + "$ref": "#/components/requestBodies/put_script" }, "responses": { "200": { - "$ref": "#/components/responses/field_caps#200" + "$ref": "#/components/responses/put_script#200" } } }, - "post": { + "delete": { "tags": [ - "field_caps" + "delete_script" ], - "summary": "Returns the information about the capabilities of fields among multiple indices.", - "description": "Returns the information about the capabilities of fields among multiple indices.", + "summary": "Deletes a script.", + "description": "Deletes a script.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" }, - "operationId": "field-caps-3", + "operationId": "delete-script", "parameters": [ { - "$ref": "#/components/parameters/field_caps#index" - }, - { - "$ref": "#/components/parameters/field_caps#allow_no_indices" - }, - { - "$ref": "#/components/parameters/field_caps#expand_wildcards" - }, - { - "$ref": "#/components/parameters/field_caps#fields" - }, - { - "$ref": "#/components/parameters/field_caps#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/field_caps#include_unmapped" - }, - { - "$ref": "#/components/parameters/field_caps#filters" + "in": "path", + "name": "id", + "description": "Identifier for the stored script or search template.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/field_caps#types" + "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" }, { - "$ref": "#/components/parameters/field_caps#include_empty_fields" + "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" } ], - "requestBody": { - "$ref": "#/components/requestBodies/field_caps" - }, "responses": { "200": { - "$ref": "#/components/responses/field_caps#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } } }, - "/{index}/_graph/explore": { + "/_enrich/policy/{name}": { "get": { "tags": [ - "graph.explore" + "enrich.get_policy" ], - "summary": "Explore extracted and summarized information about the documents and terms in an index.", - "description": "Explore extracted and summarized information about the documents and terms in an index.", + "summary": "Gets information about an enrich policy.", + "description": "Gets information about an enrich policy.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" }, - "operationId": "graph-explore", + "operationId": "enrich-get-policy", "parameters": [ { - "$ref": "#/components/parameters/graph.explore#index" - }, - { - "$ref": "#/components/parameters/graph.explore#routing" - }, - { - "$ref": "#/components/parameters/graph.explore#timeout" + "$ref": "#/components/parameters/enrich.get_policy#name" } ], - "requestBody": { - "$ref": "#/components/requestBodies/graph.explore" - }, "responses": { "200": { - "$ref": "#/components/responses/graph.explore#200" + "$ref": "#/components/responses/enrich.get_policy#200" } } }, - "post": { + "put": { "tags": [ - "graph.explore" + "enrich.put_policy" ], - "summary": "Explore extracted and summarized information about the documents and terms in an index.", - "description": "Explore extracted and summarized information about the documents and terms in an index.", + "summary": "Creates a new enrich policy.", + "description": "Creates a new enrich policy.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html" }, - "operationId": "graph-explore-1", + "operationId": "enrich-put-policy", "parameters": [ { - "$ref": "#/components/parameters/graph.explore#index" - }, - { - "$ref": "#/components/parameters/graph.explore#routing" - }, - { - "$ref": "#/components/parameters/graph.explore#timeout" + "in": "path", + "name": "name", + "description": "Name of the enrich policy to create or update.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" } ], "requestBody": { - "$ref": "#/components/requestBodies/graph.explore" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "geo_match": { + "$ref": "#/components/schemas/enrich._types:Policy" + }, + "match": { + "$ref": "#/components/schemas/enrich._types:Policy" + }, + "range": { + "$ref": "#/components/schemas/enrich._types:Policy" + } + } + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/graph.explore#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } - } - }, - "/{index}/_doc": { - "post": { + }, + "delete": { "tags": [ - "index" + "enrich.delete_policy" ], - "summary": "Creates or updates a document in an index.", - "description": "Creates or updates a document in an index.", + "summary": "Deletes an existing enrich policy and its enrich index.", + "description": "Deletes an existing enrich policy and its enrich index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html" }, - "operationId": "index-2", + "operationId": "enrich-delete-policy", "parameters": [ { - "$ref": "#/components/parameters/index#index" - }, - { - "$ref": "#/components/parameters/index#if_primary_term" - }, - { - "$ref": "#/components/parameters/index#if_seq_no" - }, - { - "$ref": "#/components/parameters/index#op_type" - }, - { - "$ref": "#/components/parameters/index#pipeline" - }, - { - "$ref": "#/components/parameters/index#refresh" - }, - { - "$ref": "#/components/parameters/index#routing" - }, - { - "$ref": "#/components/parameters/index#timeout" - }, - { - "$ref": "#/components/parameters/index#version" - }, - { - "$ref": "#/components/parameters/index#version_type" - }, - { - "$ref": "#/components/parameters/index#wait_for_active_shards" - }, - { - "$ref": "#/components/parameters/index#require_alias" + "in": "path", + "name": "name", + "description": "Enrich policy to delete.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" } ], - "requestBody": { - "$ref": "#/components/requestBodies/index" - }, "responses": { "200": { - "$ref": "#/components/responses/index#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } } }, - "/{index}/_block/{block}": { + "/_enrich/policy/{name}/_execute": { "put": { "tags": [ - "indices.add_block" + "enrich.execute_policy" ], - "summary": "Adds a block to an index.", - "description": "Adds a block to an index.", + "summary": "Creates the enrich index for an existing enrich policy.", + "description": "Creates the enrich index for an existing enrich policy.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html" }, - "operationId": "indices-add-block", + "operationId": "enrich-execute-policy", "parameters": [ { "in": "path", - "name": "index", - "description": "A comma separated list of indices to add a block to", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:IndexName" - }, - "style": "simple" - }, - { - "in": "path", - "name": "block", - "description": "The block to add (one of read, write, read_only or metadata)", + "name": "name", + "description": "Enrich policy to execute.", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/indices.add_block:IndicesBlockOptions" + "$ref": "#/components/schemas/_types:Name" }, "style": "simple" }, { "in": "query", - "name": "allow_no_indices", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "expand_wildcards", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" - }, - "style": "form" - }, - { - "in": "query", - "name": "ignore_unavailable", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "wait_for_completion", + "description": "If `true`, the request blocks other enrich policy execution requests until complete.", "deprecated": false, "schema": { "type": "boolean" }, "style": "form" - }, - { - "in": "query", - "name": "master_timeout", - "description": "Specify timeout for connection to master", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" - }, - { - "in": "query", - "name": "timeout", - "description": "Explicit operation timeout", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" } ], "responses": { @@ -4598,24 +4622,13 @@ "schema": { "type": "object", "properties": { - "acknowledged": { - "type": "boolean" - }, - "shards_acknowledged": { - "type": "boolean" + "status": { + "$ref": "#/components/schemas/enrich.execute_policy:ExecuteEnrichPolicyStatus" }, - "indices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/indices.add_block:IndicesBlockStatus" - } + "task_id": { + "$ref": "#/components/schemas/_types:TaskId" } - }, - "required": [ - "acknowledged", - "shards_acknowledged", - "indices" - ] + } } } } @@ -4623,143 +4636,370 @@ } } }, - "/_analyze": { + "/_enrich/policy": { "get": { "tags": [ - "indices.analyze" + "enrich.get_policy" ], - "summary": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "summary": "Gets information about an enrich policy.", + "description": "Gets information about an enrich policy.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" - }, - "operationId": "indices-analyze", - "requestBody": { - "$ref": "#/components/requestBodies/indices.analyze" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" }, + "operationId": "enrich-get-policy-1", "responses": { "200": { - "$ref": "#/components/responses/indices.analyze#200" + "$ref": "#/components/responses/enrich.get_policy#200" } } - }, - "post": { + } + }, + "/_enrich/_stats": { + "get": { "tags": [ - "indices.analyze" + "enrich.stats" ], - "summary": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "summary": "Gets enrich coordinator statistics and information about enrich policies that are currently executing.", + "description": "Gets enrich coordinator statistics and information about enrich policies that are currently executing.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" - }, - "operationId": "indices-analyze-1", - "requestBody": { - "$ref": "#/components/requestBodies/indices.analyze" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html" }, + "operationId": "enrich-stats", "responses": { "200": { - "$ref": "#/components/responses/indices.analyze#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "coordinator_stats": { + "description": "Objects containing information about each coordinating ingest node for configured enrich processors.", + "type": "array", + "items": { + "$ref": "#/components/schemas/enrich.stats:CoordinatorStats" + } + }, + "executing_policies": { + "description": "Objects containing information about each enrich policy that is currently executing.", + "type": "array", + "items": { + "$ref": "#/components/schemas/enrich.stats:ExecutingPolicy" + } + }, + "cache_stats": { + "description": "Objects containing information about the enrich cache stats on each ingest node.", + "type": "array", + "items": { + "$ref": "#/components/schemas/enrich.stats:CacheStats" + } + } + }, + "required": [ + "coordinator_stats", + "executing_policies" + ] + } + } + } } } } }, - "/{index}/_analyze": { + "/_eql/search/{id}": { "get": { "tags": [ - "indices.analyze" + "eql.get" ], - "summary": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + "summary": "Returns async results from previously executed Event Query Language (EQL) search", + "description": "Returns async results from previously executed Event Query Language (EQL) search", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-search-api.html" }, - "operationId": "indices-analyze-2", + "operationId": "eql-get", "parameters": [ { - "$ref": "#/components/parameters/indices.analyze#index" + "in": "path", + "name": "id", + "description": "Identifier for the search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "keep_alive", + "description": "Period for which the search and its results are stored on the cluster.\nDefaults to the keep_alive value set by the search’s EQL search API request.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion_timeout", + "description": "Timeout duration to wait for the request to finish.\nDefaults 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": { + "$ref": "#/components/schemas/eql._types:EqlSearchResponseBase" + } + } + } + } + } + }, + "delete": { + "tags": [ + "eql.delete" + ], + "summary": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", + "description": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" + }, + "operationId": "eql-delete", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the search to delete.\nA search ID is provided in the EQL search API's response for an async search.\nA search ID is also provided if the request’s `keep_on_completion` parameter is `true`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + } + } + }, + "/_eql/search/status/{id}": { + "get": { + "tags": [ + "eql.get_status" + ], + "summary": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", + "description": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-status-api.html" + }, + "operationId": "eql-get-status", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "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": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "is_partial": { + "description": "If true, the search request is still executing. If false, the search is completed.", + "type": "boolean" + }, + "is_running": { + "description": "If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts.", + "type": "boolean" + }, + "start_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "expiration_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "completion_status": { + "description": "For a completed search shows the http status code of the completed search.", + "type": "number" + } + }, + "required": [ + "id", + "is_partial", + "is_running" + ] + } + } + } + } + } + } + }, + "/{index}/_eql/search": { + "get": { + "tags": [ + "eql.search" + ], + "summary": "Returns results matching a query expressed in Event Query Language (EQL)", + "description": "Returns results matching a query expressed in Event Query Language (EQL)", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" + }, + "operationId": "eql-search", + "parameters": [ + { + "$ref": "#/components/parameters/eql.search#index" + }, + { + "$ref": "#/components/parameters/eql.search#allow_no_indices" + }, + { + "$ref": "#/components/parameters/eql.search#expand_wildcards" + }, + { + "$ref": "#/components/parameters/eql.search#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/eql.search#keep_alive" + }, + { + "$ref": "#/components/parameters/eql.search#keep_on_completion" + }, + { + "$ref": "#/components/parameters/eql.search#wait_for_completion_timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.analyze" + "$ref": "#/components/requestBodies/eql.search" }, "responses": { "200": { - "$ref": "#/components/responses/indices.analyze#200" + "$ref": "#/components/responses/eql.search#200" } } }, "post": { "tags": [ - "indices.analyze" + "eql.search" ], - "summary": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "summary": "Returns results matching a query expressed in Event Query Language (EQL)", + "description": "Returns results matching a query expressed in Event Query Language (EQL)", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" }, - "operationId": "indices-analyze-3", + "operationId": "eql-search-1", "parameters": [ { - "$ref": "#/components/parameters/indices.analyze#index" + "$ref": "#/components/parameters/eql.search#index" + }, + { + "$ref": "#/components/parameters/eql.search#allow_no_indices" + }, + { + "$ref": "#/components/parameters/eql.search#expand_wildcards" + }, + { + "$ref": "#/components/parameters/eql.search#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/eql.search#keep_alive" + }, + { + "$ref": "#/components/parameters/eql.search#keep_on_completion" + }, + { + "$ref": "#/components/parameters/eql.search#wait_for_completion_timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.analyze" + "$ref": "#/components/requestBodies/eql.search" }, "responses": { "200": { - "$ref": "#/components/responses/indices.analyze#200" + "$ref": "#/components/responses/eql.search#200" } } } }, - "/{index}": { + "/{index}/_source/{id}": { "get": { "tags": [ - "indices.get" + "get_source" ], - "summary": "Returns information about one or more indices.", - "description": "Returns information about one or more indices.", + "summary": "Returns the source of a document.", + "description": "Returns the source of a document.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, - "operationId": "indices-get", + "operationId": "get-source", "parameters": [ { "in": "path", "name": "index", - "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard expressions (*) are supported.", + "description": "Name of the index that contains the document.", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Indices" + "$ref": "#/components/schemas/_types:IndexName" }, "style": "simple" }, { - "in": "query", - "name": "allow_no_indices", - "description": "If false, the request returns an error if any wildcard expression, index alias, or _all value targets only\nmissing or closed indices. This behavior applies even if the request targets other open indices. For example,\na request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.", + "in": "path", + "name": "id", + "description": "Unique identifier of the document.", + "required": true, "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Id" }, - "style": "form" + "style": "simple" }, { "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.", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on. Random by default.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" + "type": "string" }, "style": "form" }, { "in": "query", - "name": "flat_settings", - "description": "If true, returns settings in flat format.", + "name": "realtime", + "description": "Boolean) If true, the request is real-time as opposed to near-real-time.", "deprecated": false, "schema": { "type": "boolean" @@ -4768,8 +5008,8 @@ }, { "in": "query", - "name": "ignore_unavailable", - "description": "If false, requests that target a missing index return an error.", + "name": "refresh", + "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", "deprecated": false, "schema": { "type": "boolean" @@ -4778,213 +5018,134 @@ }, { "in": "query", - "name": "include_defaults", - "description": "If true, return all default settings in the response.", + "name": "routing", + "description": "Target the specified primary shard.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Routing" }, "style": "form" }, { "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.", + "name": "_source", + "description": "True or false to return the _source field or not, or a list of fields to return.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" }, "style": "form" }, { "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.", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude in the response.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:Fields" }, "style": "form" }, { "in": "query", - "name": "features", - "description": "Return only information on specified index features", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/indices.get:Features" + "$ref": "#/components/schemas/_types:Fields" }, "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/indices._types:IndexState" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "indices.create" - ], - "summary": "Creates an index with optional settings and mappings.", - "description": "Creates an index with optional settings and mappings.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html" - }, - "operationId": "indices-create", - "parameters": [ - { - "in": "path", - "name": "index", - "description": "Name of the index you wish to create.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:IndexName" - }, - "style": "simple" }, { "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.", + "name": "stored_fields", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:Fields" }, "style": "form" }, { "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.", + "name": "version", + "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:VersionNumber" }, "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`).", + "name": "version_type", + "description": "Specific version type: internal, external, external_gte.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:WaitForActiveShards" + "$ref": "#/components/schemas/_types:VersionType" }, "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aliases": { - "description": "Aliases for the index.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/indices._types:Alias" - } - }, - "mappings": { - "$ref": "#/components/schemas/_types.mapping:TypeMapping" - }, - "settings": { - "$ref": "#/components/schemas/indices._types:IndexSettings" - } - } - } - } - } - }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "index": { - "$ref": "#/components/schemas/_types:IndexName" - }, - "shards_acknowledged": { - "type": "boolean" - }, - "acknowledged": { - "type": "boolean" - } - }, - "required": [ - "index", - "shards_acknowledged", - "acknowledged" - ] + "type": "object" } } } } } }, - "delete": { + "head": { "tags": [ - "indices.delete" + "exists_source" ], - "summary": "Deletes an index.", - "description": "Deletes an index.", + "summary": "Returns information about whether a document source exists in an index.", + "description": "Returns information about whether a document source exists in an index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" }, - "operationId": "indices-delete", + "operationId": "exists-source", "parameters": [ { "in": "path", "name": "index", - "description": "Comma-separated list of indices to delete.\nYou cannot specify index aliases.\nBy default, this parameter does not support wildcards (`*`) or `_all`.\nTo use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`.", + "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Indices" + "$ref": "#/components/schemas/_types:IndexName" }, "style": "simple" }, { - "in": "query", - "name": "allow_no_indices", - "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "in": "path", + "name": "id", + "description": "Identifier of the document.", + "required": true, "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Id" }, - "style": "form" + "style": "simple" }, { "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`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" + "type": "string" }, "style": "form" }, { "in": "query", - "name": "ignore_unavailable", - "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "name": "realtime", + "description": "If true, the request is real-time as opposed to near-real-time.", "deprecated": false, "schema": { "type": "boolean" @@ -4993,117 +5154,71 @@ }, { "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.", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "type": "boolean" }, "style": "form" }, { "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.", + "name": "routing", + "description": "Target the specified primary shard.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:Routing" }, "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:IndicesResponseBase" - } - } - } - } - } - }, - "head": { - "tags": [ - "indices.exists" - ], - "summary": "Returns information about whether a particular index exists.", - "description": "Returns information about whether a particular index exists.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html" - }, - "operationId": "indices-exists", - "parameters": [ - { - "in": "path", - "name": "index", - "description": "Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`).", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Indices" - }, - "style": "simple" }, { "in": "query", - "name": "allow_no_indices", - "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "name": "_source", + "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" }, "style": "form" }, { "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`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude in the response.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" + "$ref": "#/components/schemas/_types:Fields" }, "style": "form" }, { "in": "query", - "name": "flat_settings", - "description": "If `true`, returns settings in flat format.", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Fields" }, "style": "form" }, { "in": "query", - "name": "ignore_unavailable", - "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "name": "version", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:VersionNumber" }, "style": "form" }, { "in": "query", - "name": "include_defaults", - "description": "If `true`, return all default settings in the response.", + "name": "version_type", + "description": "Specific version type: `external`, `external_gte`.", "deprecated": false, "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "local", - "description": "If `true`, the request retrieves information from the local node only.", - "deprecated": false, - "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:VersionType" }, "style": "form" } @@ -5118,476 +5233,528 @@ } } }, - "/_data_stream/{name}": { + "/{index}/_explain/{id}": { "get": { "tags": [ - "indices.get_data_stream" + "explain" ], - "summary": "Returns data streams.", - "description": "Returns data streams.", + "summary": "Returns information about why a specific matches (or doesn't match) a query.", + "description": "Returns information about why a specific matches (or doesn't match) a query.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" }, - "operationId": "indices-get-data-stream-1", + "operationId": "explain", "parameters": [ { - "$ref": "#/components/parameters/indices.get_data_stream#name" + "$ref": "#/components/parameters/explain#index" }, { - "$ref": "#/components/parameters/indices.get_data_stream#expand_wildcards" + "$ref": "#/components/parameters/explain#id" }, { - "$ref": "#/components/parameters/indices.get_data_stream#include_defaults" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/indices.get_data_stream#200" - } - } - }, - "put": { - "tags": [ - "indices.create_data_stream" - ], - "summary": "Creates a data stream", - "description": "Creates a data stream", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" - }, - "operationId": "indices-create-data-stream", - "parameters": [ + "$ref": "#/components/parameters/explain#analyzer" + }, { - "in": "path", - "name": "name", - "description": "Name of the data stream, which must meet the following criteria:\nLowercase only;\nCannot include `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character;\nCannot start with `-`, `_`, `+`, or `.ds-`;\nCannot be `.` or `..`;\nCannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DataStreamName" - }, - "style": "simple" + "$ref": "#/components/parameters/explain#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/explain#default_operator" + }, + { + "$ref": "#/components/parameters/explain#df" + }, + { + "$ref": "#/components/parameters/explain#lenient" + }, + { + "$ref": "#/components/parameters/explain#preference" + }, + { + "$ref": "#/components/parameters/explain#routing" + }, + { + "$ref": "#/components/parameters/explain#_source" + }, + { + "$ref": "#/components/parameters/explain#_source_excludes" + }, + { + "$ref": "#/components/parameters/explain#_source_includes" + }, + { + "$ref": "#/components/parameters/explain#stored_fields" + }, + { + "$ref": "#/components/parameters/explain#q" } ], + "requestBody": { + "$ref": "#/components/requestBodies/explain" + }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/explain#200" } } }, - "delete": { + "post": { "tags": [ - "indices.delete_data_stream" + "explain" ], - "summary": "Deletes a data stream.", - "description": "Deletes a data stream.", + "summary": "Returns information about why a specific matches (or doesn't match) a query.", + "description": "Returns information about why a specific matches (or doesn't match) a query.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" }, - "operationId": "indices-delete-data-stream", + "operationId": "explain-1", "parameters": [ { - "in": "path", - "name": "name", - "description": "Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DataStreamNames" - }, - "style": "simple" + "$ref": "#/components/parameters/explain#index" }, { - "in": "query", - "name": "expand_wildcards", - "description": "Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" - }, - "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } - } - } - } - }, - "/_data_stream/_stats": { - "get": { - "tags": [ - "indices.data_streams_stats" - ], - "summary": "Provides statistics on operations happening in a data stream.", - "description": "Provides statistics on operations happening in a data stream.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" - }, - "operationId": "indices-data-streams-stats", - "parameters": [ + "$ref": "#/components/parameters/explain#id" + }, { - "$ref": "#/components/parameters/indices.data_streams_stats#expand_wildcards" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/indices.data_streams_stats#200" - } - } - } - }, - "/_data_stream/{name}/_stats": { - "get": { - "tags": [ - "indices.data_streams_stats" - ], - "summary": "Provides statistics on operations happening in a data stream.", - "description": "Provides statistics on operations happening in a data stream.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" - }, - "operationId": "indices-data-streams-stats-1", - "parameters": [ + "$ref": "#/components/parameters/explain#analyzer" + }, { - "$ref": "#/components/parameters/indices.data_streams_stats#name" + "$ref": "#/components/parameters/explain#analyze_wildcard" }, { - "$ref": "#/components/parameters/indices.data_streams_stats#expand_wildcards" + "$ref": "#/components/parameters/explain#default_operator" + }, + { + "$ref": "#/components/parameters/explain#df" + }, + { + "$ref": "#/components/parameters/explain#lenient" + }, + { + "$ref": "#/components/parameters/explain#preference" + }, + { + "$ref": "#/components/parameters/explain#routing" + }, + { + "$ref": "#/components/parameters/explain#_source" + }, + { + "$ref": "#/components/parameters/explain#_source_excludes" + }, + { + "$ref": "#/components/parameters/explain#_source_includes" + }, + { + "$ref": "#/components/parameters/explain#stored_fields" + }, + { + "$ref": "#/components/parameters/explain#q" } ], + "requestBody": { + "$ref": "#/components/requestBodies/explain" + }, "responses": { "200": { - "$ref": "#/components/responses/indices.data_streams_stats#200" + "$ref": "#/components/responses/explain#200" } } } }, - "/{index}/_alias/{name}": { + "/_field_caps": { "get": { "tags": [ - "indices.get_alias" + "field_caps" ], - "summary": "Returns an alias.", - "description": "Returns an alias.", + "summary": "Returns the information about the capabilities of fields among multiple indices.", + "description": "Returns the information about the capabilities of fields among multiple indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, - "operationId": "indices-get-alias-2", + "operationId": "field-caps", "parameters": [ { - "$ref": "#/components/parameters/indices.get_alias#index" + "$ref": "#/components/parameters/field_caps#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.get_alias#name" + "$ref": "#/components/parameters/field_caps#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" + "$ref": "#/components/parameters/field_caps#fields" }, { - "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" + "$ref": "#/components/parameters/field_caps#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + "$ref": "#/components/parameters/field_caps#include_unmapped" }, { - "$ref": "#/components/parameters/indices.get_alias#local" + "$ref": "#/components/parameters/field_caps#filters" + }, + { + "$ref": "#/components/parameters/field_caps#types" + }, + { + "$ref": "#/components/parameters/field_caps#include_empty_fields" } ], + "requestBody": { + "$ref": "#/components/requestBodies/field_caps" + }, "responses": { "200": { - "$ref": "#/components/responses/indices.get_alias#200" + "$ref": "#/components/responses/field_caps#200" } } }, - "put": { + "post": { "tags": [ - "indices.put_alias" + "field_caps" ], - "summary": "Creates or updates an alias.", - "description": "Creates or updates an alias.", + "summary": "Returns the information about the capabilities of fields among multiple indices.", + "description": "Returns the information about the capabilities of fields among multiple indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, - "operationId": "indices-put-alias", + "operationId": "field-caps-1", "parameters": [ { - "$ref": "#/components/parameters/indices.put_alias#index" + "$ref": "#/components/parameters/field_caps#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.put_alias#name" + "$ref": "#/components/parameters/field_caps#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.put_alias#master_timeout" + "$ref": "#/components/parameters/field_caps#fields" }, { - "$ref": "#/components/parameters/indices.put_alias#timeout" + "$ref": "#/components/parameters/field_caps#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/field_caps#include_unmapped" + }, + { + "$ref": "#/components/parameters/field_caps#filters" + }, + { + "$ref": "#/components/parameters/field_caps#types" + }, + { + "$ref": "#/components/parameters/field_caps#include_empty_fields" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.put_alias" + "$ref": "#/components/requestBodies/field_caps" }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_alias#200" + "$ref": "#/components/responses/field_caps#200" } } - }, - "post": { + } + }, + "/{index}/_field_caps": { + "get": { "tags": [ - "indices.put_alias" + "field_caps" ], - "summary": "Creates or updates an alias.", - "description": "Creates or updates an alias.", + "summary": "Returns the information about the capabilities of fields among multiple indices.", + "description": "Returns the information about the capabilities of fields among multiple indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, - "operationId": "indices-put-alias-1", + "operationId": "field-caps-2", "parameters": [ { - "$ref": "#/components/parameters/indices.put_alias#index" + "$ref": "#/components/parameters/field_caps#index" }, { - "$ref": "#/components/parameters/indices.put_alias#name" + "$ref": "#/components/parameters/field_caps#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.put_alias#master_timeout" + "$ref": "#/components/parameters/field_caps#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.put_alias#timeout" + "$ref": "#/components/parameters/field_caps#fields" + }, + { + "$ref": "#/components/parameters/field_caps#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/field_caps#include_unmapped" + }, + { + "$ref": "#/components/parameters/field_caps#filters" + }, + { + "$ref": "#/components/parameters/field_caps#types" + }, + { + "$ref": "#/components/parameters/field_caps#include_empty_fields" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.put_alias" + "$ref": "#/components/requestBodies/field_caps" }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_alias#200" + "$ref": "#/components/responses/field_caps#200" } } }, - "delete": { + "post": { "tags": [ - "indices.delete_alias" + "field_caps" ], - "summary": "Deletes an alias.", - "description": "Deletes an alias.", + "summary": "Returns the information about the capabilities of fields among multiple indices.", + "description": "Returns the information about the capabilities of fields among multiple indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, - "operationId": "indices-delete-alias", + "operationId": "field-caps-3", "parameters": [ { - "$ref": "#/components/parameters/indices.delete_alias#index" + "$ref": "#/components/parameters/field_caps#index" }, { - "$ref": "#/components/parameters/indices.delete_alias#name" + "$ref": "#/components/parameters/field_caps#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.delete_alias#master_timeout" + "$ref": "#/components/parameters/field_caps#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.delete_alias#timeout" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/indices.delete_alias#200" - } - } - }, - "head": { - "tags": [ - "indices.exists_alias" - ], - "summary": "Returns information about whether a particular alias exists.", - "description": "Returns information about whether a particular alias exists.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" - }, - "operationId": "indices-exists-alias-1", - "parameters": [ - { - "$ref": "#/components/parameters/indices.exists_alias#index" + "$ref": "#/components/parameters/field_caps#fields" }, { - "$ref": "#/components/parameters/indices.exists_alias#name" + "$ref": "#/components/parameters/field_caps#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.exists_alias#allow_no_indices" + "$ref": "#/components/parameters/field_caps#include_unmapped" }, { - "$ref": "#/components/parameters/indices.exists_alias#expand_wildcards" + "$ref": "#/components/parameters/field_caps#filters" }, { - "$ref": "#/components/parameters/indices.exists_alias#ignore_unavailable" + "$ref": "#/components/parameters/field_caps#types" }, { - "$ref": "#/components/parameters/indices.exists_alias#local" + "$ref": "#/components/parameters/field_caps#include_empty_fields" } ], + "requestBody": { + "$ref": "#/components/requestBodies/field_caps" + }, "responses": { "200": { - "$ref": "#/components/responses/indices.exists_alias#200" + "$ref": "#/components/responses/field_caps#200" } } } }, - "/{index}/_aliases/{name}": { - "put": { + "/{index}/_graph/explore": { + "get": { "tags": [ - "indices.put_alias" + "graph.explore" ], - "summary": "Creates or updates an alias.", - "description": "Creates or updates an alias.", + "summary": "Explore extracted and summarized information about the documents and terms in an index.", + "description": "Explore extracted and summarized information about the documents and terms in an index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html" }, - "operationId": "indices-put-alias-2", + "operationId": "graph-explore", "parameters": [ { - "$ref": "#/components/parameters/indices.put_alias#index" - }, - { - "$ref": "#/components/parameters/indices.put_alias#name" + "$ref": "#/components/parameters/graph.explore#index" }, { - "$ref": "#/components/parameters/indices.put_alias#master_timeout" + "$ref": "#/components/parameters/graph.explore#routing" }, { - "$ref": "#/components/parameters/indices.put_alias#timeout" + "$ref": "#/components/parameters/graph.explore#timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.put_alias" + "$ref": "#/components/requestBodies/graph.explore" }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_alias#200" + "$ref": "#/components/responses/graph.explore#200" } } }, "post": { "tags": [ - "indices.put_alias" + "graph.explore" ], - "summary": "Creates or updates an alias.", - "description": "Creates or updates an alias.", + "summary": "Explore extracted and summarized information about the documents and terms in an index.", + "description": "Explore extracted and summarized information about the documents and terms in an index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html" }, - "operationId": "indices-put-alias-3", + "operationId": "graph-explore-1", "parameters": [ { - "$ref": "#/components/parameters/indices.put_alias#index" - }, - { - "$ref": "#/components/parameters/indices.put_alias#name" + "$ref": "#/components/parameters/graph.explore#index" }, { - "$ref": "#/components/parameters/indices.put_alias#master_timeout" + "$ref": "#/components/parameters/graph.explore#routing" }, { - "$ref": "#/components/parameters/indices.put_alias#timeout" + "$ref": "#/components/parameters/graph.explore#timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.put_alias" + "$ref": "#/components/requestBodies/graph.explore" }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_alias#200" + "$ref": "#/components/responses/graph.explore#200" } } - }, - "delete": { + } + }, + "/{index}/_doc": { + "post": { "tags": [ - "indices.delete_alias" + "index" ], - "summary": "Deletes an alias.", - "description": "Deletes an alias.", + "summary": "Creates or updates a document in an index.", + "description": "Creates or updates a document in an index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" }, - "operationId": "indices-delete-alias-1", + "operationId": "index-2", "parameters": [ { - "$ref": "#/components/parameters/indices.delete_alias#index" + "$ref": "#/components/parameters/index#index" }, { - "$ref": "#/components/parameters/indices.delete_alias#name" + "$ref": "#/components/parameters/index#if_primary_term" }, { - "$ref": "#/components/parameters/indices.delete_alias#master_timeout" + "$ref": "#/components/parameters/index#if_seq_no" }, { - "$ref": "#/components/parameters/indices.delete_alias#timeout" + "$ref": "#/components/parameters/index#op_type" + }, + { + "$ref": "#/components/parameters/index#pipeline" + }, + { + "$ref": "#/components/parameters/index#refresh" + }, + { + "$ref": "#/components/parameters/index#routing" + }, + { + "$ref": "#/components/parameters/index#timeout" + }, + { + "$ref": "#/components/parameters/index#version" + }, + { + "$ref": "#/components/parameters/index#version_type" + }, + { + "$ref": "#/components/parameters/index#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/index#require_alias" } ], + "requestBody": { + "$ref": "#/components/requestBodies/index" + }, "responses": { "200": { - "$ref": "#/components/responses/indices.delete_alias#200" + "$ref": "#/components/responses/index#200" } } } }, - "/_data_stream/{name}/_lifecycle": { - "get": { + "/{index}/_block/{block}": { + "put": { "tags": [ - "indices.get_data_lifecycle" + "indices.add_block" ], - "summary": "Returns the data stream lifecycle of the selected data streams.", - "description": "Returns the data stream lifecycle of the selected data streams.", + "summary": "Adds a block to an index.", + "description": "Adds a block to an index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html" }, - "operationId": "indices-get-data-lifecycle", + "operationId": "indices-add-block", "parameters": [ { "in": "path", - "name": "name", - "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", + "name": "index", + "description": "A comma separated list of indices to add a block to", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:DataStreamNames" + "$ref": "#/components/schemas/_types:IndexName" }, "style": "simple" }, { - "in": "query", - "name": "expand_wildcards", - "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "in": "path", + "name": "block", + "description": "The block to add (one of read, write, read_only or metadata)", + "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" + "$ref": "#/components/schemas/indices.add_block:IndicesBlockOptions" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "deprecated": false, + "schema": { + "type": "boolean" }, "style": "form" }, { "in": "query", - "name": "include_defaults", - "description": "If `true`, return all default settings in the response.", + "name": "expand_wildcards", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "deprecated": false, "schema": { "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Explicit operation timeout", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], "responses": { @@ -5598,58 +5765,208 @@ "schema": { "type": "object", "properties": { - "data_streams": { + "acknowledged": { + "type": "boolean" + }, + "shards_acknowledged": { + "type": "boolean" + }, + "indices": { "type": "array", "items": { - "$ref": "#/components/schemas/indices.get_data_lifecycle:DataStreamWithLifecycle" + "$ref": "#/components/schemas/indices.add_block:IndicesBlockStatus" } } }, "required": [ - "data_streams" + "acknowledged", + "shards_acknowledged", + "indices" ] } } } } } + } + }, + "/_analyze": { + "get": { + "tags": [ + "indices.analyze" + ], + "summary": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + }, + "operationId": "indices-analyze", + "requestBody": { + "$ref": "#/components/requestBodies/indices.analyze" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.analyze#200" + } + } }, - "put": { + "post": { "tags": [ - "indices.put_data_lifecycle" + "indices.analyze" ], - "summary": "Updates the data stream lifecycle of the selected data streams.", - "description": "Updates the data stream lifecycle of the selected data streams.", + "summary": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" }, - "operationId": "indices-put-data-lifecycle", + "operationId": "indices-analyze-1", + "requestBody": { + "$ref": "#/components/requestBodies/indices.analyze" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.analyze#200" + } + } + } + }, + "/{index}/_analyze": { + "get": { + "tags": [ + "indices.analyze" + ], + "summary": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + }, + "operationId": "indices-analyze-2", + "parameters": [ + { + "$ref": "#/components/parameters/indices.analyze#index" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.analyze" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.analyze#200" + } + } + }, + "post": { + "tags": [ + "indices.analyze" + ], + "summary": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + }, + "operationId": "indices-analyze-3", + "parameters": [ + { + "$ref": "#/components/parameters/indices.analyze#index" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.analyze" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.analyze#200" + } + } + } + }, + "/{index}": { + "get": { + "tags": [ + "indices.get" + ], + "summary": "Returns information about one or more indices.", + "description": "Returns information about one or more indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html" + }, + "operationId": "indices-get", "parameters": [ { "in": "path", - "name": "name", - "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", + "name": "index", + "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard expressions (*) are supported.", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:DataStreamNames" + "$ref": "#/components/schemas/_types:Indices" }, "style": "simple" }, + { + "in": "query", + "name": "allow_no_indices", + "description": "If false, the request returns an error if any wildcard expression, index alias, or _all value targets only\nmissing or closed indices. This behavior applies even if the request targets other open indices. For example,\na request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, { "in": "query", "name": "expand_wildcards", - "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `hidden`, `open`, `closed`, `none`.", + "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.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:ExpandWildcards" }, "style": "form" }, + { + "in": "query", + "name": "flat_settings", + "description": "If true, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If false, requests that target a missing index return an error.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "include_defaults", + "description": "If true, return all default settings in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "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": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, { "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.", + "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" @@ -5658,81 +5975,67 @@ }, { "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.", + "name": "features", + "description": "Return only information on specified index features", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/indices.get:Features" }, "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data_retention": { - "$ref": "#/components/schemas/_types:Duration" - }, - "downsampling": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" - } - } - } - } - } - }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:IndexState" + } } } } } } }, - "delete": { + "put": { "tags": [ - "indices.delete_data_lifecycle" + "indices.create" ], - "summary": "Deletes the data stream lifecycle of the selected data streams.", - "description": "Deletes the data stream lifecycle of the selected data streams.", + "summary": "Creates an index with optional settings and mappings.", + "description": "Creates an index with optional settings and mappings.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html" }, - "operationId": "indices-delete-data-lifecycle", + "operationId": "indices-create", "parameters": [ { "in": "path", - "name": "name", - "description": "A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams", + "name": "index", + "description": "Name of the index you wish to create.", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:DataStreamNames" + "$ref": "#/components/schemas/_types:IndexName" }, "style": "simple" }, { "in": "query", - "name": "expand_wildcards", - "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "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:ExpandWildcards" + "$ref": "#/components/schemas/_types:Duration" }, "style": "form" }, { "in": "query", - "name": "master_timeout", - "description": "Specify timeout for connection to master", + "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" @@ -5741,143 +6044,124 @@ }, { "in": "query", - "name": "timeout", - "description": "Explicit timestamp for the document", + "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:Duration" + "$ref": "#/components/schemas/_types:WaitForActiveShards" }, "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aliases": { + "description": "Aliases for the index.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + } + } + } + } + } + }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "shards_acknowledged": { + "type": "boolean" + }, + "acknowledged": { + "type": "boolean" + } + }, + "required": [ + "index", + "shards_acknowledged", + "acknowledged" + ] } } } } } - } - }, - "/_index_template/{name}": { - "get": { - "tags": [ - "indices.get_index_template" - ], - "summary": "Returns an index template.", - "description": "Returns an index template.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" - }, - "operationId": "indices-get-index-template-1", - "parameters": [ - { - "$ref": "#/components/parameters/indices.get_index_template#name" - }, - { - "$ref": "#/components/parameters/indices.get_index_template#local" - }, - { - "$ref": "#/components/parameters/indices.get_index_template#flat_settings" - }, - { - "$ref": "#/components/parameters/indices.get_index_template#master_timeout" - }, - { - "$ref": "#/components/parameters/indices.get_index_template#include_defaults" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/indices.get_index_template#200" - } - } }, - "put": { + "delete": { "tags": [ - "indices.put_index_template" + "indices.delete" ], - "summary": "Creates or updates an index template.", - "description": "Creates or updates an index template.", + "summary": "Deletes an index.", + "description": "Deletes an index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html" }, - "operationId": "indices-put-index-template", + "operationId": "indices-delete", "parameters": [ { - "$ref": "#/components/parameters/indices.put_index_template#name" + "in": "path", + "name": "index", + "description": "Comma-separated list of indices to delete.\nYou cannot specify index aliases.\nBy default, this parameter does not support wildcards (`*`) or `_all`.\nTo use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/indices.put_index_template#create" - } - ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.put_index_template" - }, - "responses": { - "200": { - "$ref": "#/components/responses/indices.put_index_template#200" - } - } - }, - "post": { - "tags": [ - "indices.put_index_template" - ], - "summary": "Creates or updates an index template.", - "description": "Creates or updates an index template.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" - }, - "operationId": "indices-put-index-template-1", - "parameters": [ - { - "$ref": "#/components/parameters/indices.put_index_template#name" + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.put_index_template#create" - } - ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.put_index_template" - }, - "responses": { - "200": { - "$ref": "#/components/responses/indices.put_index_template#200" - } - } - }, - "delete": { - "tags": [ - "indices.delete_index_template" - ], - "summary": "Deletes an index template.", - "description": "Deletes an index template.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html" - }, - "operationId": "indices-delete-index-template", - "parameters": [ + "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`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, { - "in": "path", - "name": "name", - "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", - "required": true, + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Names" + "type": "boolean" }, - "style": "simple" + "style": "form" }, { "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.", + "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" @@ -5887,7 +6171,7 @@ { "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.", + "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" @@ -5901,7 +6185,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + "$ref": "#/components/schemas/_types:IndicesResponseBase" } } } @@ -5910,155 +6194,190 @@ }, "head": { "tags": [ - "indices.exists_index_template" + "indices.exists" ], - "summary": "Returns information about whether a particular index template exists.", - "description": "Returns information about whether a particular index template exists.", + "summary": "Returns information about whether a particular index exists.", + "description": "Returns information about whether a particular index exists.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html" }, - "operationId": "indices-exists-index-template", + "operationId": "indices-exists", "parameters": [ { "in": "path", - "name": "name", - "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`).", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Name" + "$ref": "#/components/schemas/_types:Indices" }, "style": "simple" }, { "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.", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "type": "boolean" }, "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": {} - } - } - } - } - }, - "/_alias/{name}": { - "get": { - "tags": [ - "indices.get_alias" - ], - "summary": "Returns an alias.", - "description": "Returns an alias.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" - }, - "operationId": "indices-get-alias-1", - "parameters": [ + }, { - "$ref": "#/components/parameters/indices.get_alias#name" + "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`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" + "in": "query", + "name": "flat_settings", + "description": "If `true`, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + "in": "query", + "name": "include_defaults", + "description": "If `true`, return all default settings in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.get_alias#local" + "in": "query", + "name": "local", + "description": "If `true`, the request retrieves information from the local node only.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.get_alias#200" + "description": "", + "content": { + "application/json": {} + } } } - }, - "head": { + } + }, + "/_data_stream/{name}": { + "get": { "tags": [ - "indices.exists_alias" + "indices.get_data_stream" ], - "summary": "Returns information about whether a particular alias exists.", - "description": "Returns information about whether a particular alias exists.", + "summary": "Returns data streams.", + "description": "Returns data streams.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, - "operationId": "indices-exists-alias", + "operationId": "indices-get-data-stream-1", "parameters": [ { - "$ref": "#/components/parameters/indices.exists_alias#name" - }, - { - "$ref": "#/components/parameters/indices.exists_alias#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.exists_alias#expand_wildcards" + "$ref": "#/components/parameters/indices.get_data_stream#name" }, { - "$ref": "#/components/parameters/indices.exists_alias#ignore_unavailable" + "$ref": "#/components/parameters/indices.get_data_stream#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.exists_alias#local" + "$ref": "#/components/parameters/indices.get_data_stream#include_defaults" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.exists_alias#200" + "$ref": "#/components/responses/indices.get_data_stream#200" } } - } - }, - "/{index}/_lifecycle/explain": { - "get": { + }, + "put": { "tags": [ - "indices.explain_data_lifecycle" + "indices.create_data_stream" ], - "summary": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.", - "description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.", + "summary": "Creates a data stream", + "description": "Creates a data stream", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, - "operationId": "indices-explain-data-lifecycle", + "operationId": "indices-create-data-stream", "parameters": [ { "in": "path", - "name": "index", - "description": "The name of the index to explain", + "name": "name", + "description": "Name of the data stream, which must meet the following criteria:\nLowercase only;\nCannot include `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character;\nCannot start with `-`, `_`, `+`, or `.ds-`;\nCannot be `.` or `..`;\nCannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Indices" + "$ref": "#/components/schemas/_types:DataStreamName" }, "style": "simple" - }, + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + } + }, + "delete": { + "tags": [ + "indices.delete_data_stream" + ], + "summary": "Deletes a data stream.", + "description": "Deletes a data stream.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-delete-data-stream", + "parameters": [ { - "in": "query", - "name": "include_defaults", - "description": "indicates if the API should return the default values the system uses for the index's lifecycle", + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported.", + "required": true, "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:DataStreamNames" }, - "style": "form" + "style": "simple" }, { "in": "query", - "name": "master_timeout", - "description": "Specify timeout for connection to master", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:ExpandWildcards" }, "style": "form" } @@ -6069,18 +6388,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "indices": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/indices.explain_data_lifecycle:DataStreamLifecycleExplain" - } - } - }, - "required": [ - "indices" - ] + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" } } } @@ -6088,39 +6396,56 @@ } } }, - "/_alias": { + "/_data_stream/_stats": { "get": { "tags": [ - "indices.get_alias" + "indices.data_streams_stats" ], - "summary": "Returns an alias.", - "description": "Returns an alias.", + "summary": "Provides statistics on operations happening in a data stream.", + "description": "Provides statistics on operations happening in a data stream.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, - "operationId": "indices-get-alias", + "operationId": "indices-data-streams-stats", "parameters": [ { - "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" - }, + "$ref": "#/components/parameters/indices.data_streams_stats#expand_wildcards" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.data_streams_stats#200" + } + } + } + }, + "/_data_stream/{name}/_stats": { + "get": { + "tags": [ + "indices.data_streams_stats" + ], + "summary": "Provides statistics on operations happening in a data stream.", + "description": "Provides statistics on operations happening in a data stream.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-data-streams-stats-1", + "parameters": [ { - "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + "$ref": "#/components/parameters/indices.data_streams_stats#name" }, { - "$ref": "#/components/parameters/indices.get_alias#local" + "$ref": "#/components/parameters/indices.data_streams_stats#expand_wildcards" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.get_alias#200" + "$ref": "#/components/responses/indices.data_streams_stats#200" } } } }, - "/{index}/_alias": { + "/{index}/_alias/{name}": { "get": { "tags": [ "indices.get_alias" @@ -6130,11 +6455,14 @@ "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-get-alias-3", + "operationId": "indices-get-alias-2", "parameters": [ { "$ref": "#/components/parameters/indices.get_alias#index" }, + { + "$ref": "#/components/parameters/indices.get_alias#name" + }, { "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" }, @@ -6153,508 +6481,585 @@ "$ref": "#/components/responses/indices.get_alias#200" } } - } - }, - "/_data_stream": { - "get": { + }, + "put": { "tags": [ - "indices.get_data_stream" + "indices.put_alias" ], - "summary": "Returns data streams.", - "description": "Returns data streams.", + "summary": "Creates or updates an alias.", + "description": "Creates or updates an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-get-data-stream", + "operationId": "indices-put-alias", "parameters": [ { - "$ref": "#/components/parameters/indices.get_data_stream#expand_wildcards" + "$ref": "#/components/parameters/indices.put_alias#index" }, { - "$ref": "#/components/parameters/indices.get_data_stream#include_defaults" + "$ref": "#/components/parameters/indices.put_alias#name" + }, + { + "$ref": "#/components/parameters/indices.put_alias#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_alias#timeout" } ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_alias" + }, "responses": { "200": { - "$ref": "#/components/responses/indices.get_data_stream#200" + "$ref": "#/components/responses/indices.put_alias#200" } } - } - }, - "/_index_template": { - "get": { + }, + "post": { "tags": [ - "indices.get_index_template" + "indices.put_alias" ], - "summary": "Returns an index template.", - "description": "Returns an index template.", + "summary": "Creates or updates an alias.", + "description": "Creates or updates an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-get-index-template", + "operationId": "indices-put-alias-1", "parameters": [ { - "$ref": "#/components/parameters/indices.get_index_template#local" + "$ref": "#/components/parameters/indices.put_alias#index" }, { - "$ref": "#/components/parameters/indices.get_index_template#flat_settings" + "$ref": "#/components/parameters/indices.put_alias#name" }, { - "$ref": "#/components/parameters/indices.get_index_template#master_timeout" + "$ref": "#/components/parameters/indices.put_alias#master_timeout" }, { - "$ref": "#/components/parameters/indices.get_index_template#include_defaults" + "$ref": "#/components/parameters/indices.put_alias#timeout" } ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_alias" + }, "responses": { "200": { - "$ref": "#/components/responses/indices.get_index_template#200" + "$ref": "#/components/responses/indices.put_alias#200" } } - } - }, - "/_mapping": { - "get": { + }, + "delete": { "tags": [ - "indices.get_mapping" + "indices.delete_alias" ], - "summary": "Returns mappings for one or more indices.", - "description": "Returns mappings for one or more indices.", + "summary": "Deletes an alias.", + "description": "Deletes an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-get-mapping", + "operationId": "indices-delete-alias", "parameters": [ { - "$ref": "#/components/parameters/indices.get_mapping#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.get_mapping#expand_wildcards" + "$ref": "#/components/parameters/indices.delete_alias#index" }, { - "$ref": "#/components/parameters/indices.get_mapping#ignore_unavailable" + "$ref": "#/components/parameters/indices.delete_alias#name" }, { - "$ref": "#/components/parameters/indices.get_mapping#local" + "$ref": "#/components/parameters/indices.delete_alias#master_timeout" }, { - "$ref": "#/components/parameters/indices.get_mapping#master_timeout" + "$ref": "#/components/parameters/indices.delete_alias#timeout" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.get_mapping#200" + "$ref": "#/components/responses/indices.delete_alias#200" } } - } - }, - "/{index}/_mapping": { - "get": { + }, + "head": { "tags": [ - "indices.get_mapping" + "indices.exists_alias" ], - "summary": "Returns mappings for one or more indices.", - "description": "Returns mappings for one or more indices.", + "summary": "Returns information about whether a particular alias exists.", + "description": "Returns information about whether a particular alias exists.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-get-mapping-1", + "operationId": "indices-exists-alias-1", "parameters": [ { - "$ref": "#/components/parameters/indices.get_mapping#index" + "$ref": "#/components/parameters/indices.exists_alias#index" }, { - "$ref": "#/components/parameters/indices.get_mapping#allow_no_indices" + "$ref": "#/components/parameters/indices.exists_alias#name" }, { - "$ref": "#/components/parameters/indices.get_mapping#expand_wildcards" + "$ref": "#/components/parameters/indices.exists_alias#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.get_mapping#ignore_unavailable" + "$ref": "#/components/parameters/indices.exists_alias#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.get_mapping#local" + "$ref": "#/components/parameters/indices.exists_alias#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.get_mapping#master_timeout" + "$ref": "#/components/parameters/indices.exists_alias#local" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.get_mapping#200" + "$ref": "#/components/responses/indices.exists_alias#200" } } - }, + } + }, + "/{index}/_aliases/{name}": { "put": { "tags": [ - "indices.put_mapping" + "indices.put_alias" ], - "summary": "Updates the index mappings.", - "description": "Updates the index mappings.", + "summary": "Creates or updates an alias.", + "description": "Creates or updates an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-put-mapping", + "operationId": "indices-put-alias-2", "parameters": [ { - "$ref": "#/components/parameters/indices.put_mapping#index" - }, - { - "$ref": "#/components/parameters/indices.put_mapping#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.put_mapping#expand_wildcards" - }, - { - "$ref": "#/components/parameters/indices.put_mapping#ignore_unavailable" + "$ref": "#/components/parameters/indices.put_alias#index" }, { - "$ref": "#/components/parameters/indices.put_mapping#master_timeout" + "$ref": "#/components/parameters/indices.put_alias#name" }, { - "$ref": "#/components/parameters/indices.put_mapping#timeout" + "$ref": "#/components/parameters/indices.put_alias#master_timeout" }, { - "$ref": "#/components/parameters/indices.put_mapping#write_index_only" + "$ref": "#/components/parameters/indices.put_alias#timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.put_mapping" + "$ref": "#/components/requestBodies/indices.put_alias" }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_mapping#200" + "$ref": "#/components/responses/indices.put_alias#200" } } }, "post": { "tags": [ - "indices.put_mapping" + "indices.put_alias" ], - "summary": "Updates the index mappings.", - "description": "Updates the index mappings.", + "summary": "Creates or updates an alias.", + "description": "Creates or updates an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-put-mapping-1", + "operationId": "indices-put-alias-3", "parameters": [ { - "$ref": "#/components/parameters/indices.put_mapping#index" - }, - { - "$ref": "#/components/parameters/indices.put_mapping#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.put_mapping#expand_wildcards" - }, - { - "$ref": "#/components/parameters/indices.put_mapping#ignore_unavailable" + "$ref": "#/components/parameters/indices.put_alias#index" }, { - "$ref": "#/components/parameters/indices.put_mapping#master_timeout" + "$ref": "#/components/parameters/indices.put_alias#name" }, { - "$ref": "#/components/parameters/indices.put_mapping#timeout" + "$ref": "#/components/parameters/indices.put_alias#master_timeout" }, { - "$ref": "#/components/parameters/indices.put_mapping#write_index_only" + "$ref": "#/components/parameters/indices.put_alias#timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.put_mapping" + "$ref": "#/components/requestBodies/indices.put_alias" }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_mapping#200" + "$ref": "#/components/responses/indices.put_alias#200" } } - } - }, - "/_settings": { - "get": { + }, + "delete": { "tags": [ - "indices.get_settings" + "indices.delete_alias" ], - "summary": "Returns settings for one or more indices.", - "description": "Returns settings for one or more indices.", + "summary": "Deletes an alias.", + "description": "Deletes an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-get-settings", + "operationId": "indices-delete-alias-1", "parameters": [ { - "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" - }, - { - "$ref": "#/components/parameters/indices.get_settings#flat_settings" - }, - { - "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + "$ref": "#/components/parameters/indices.delete_alias#index" }, { - "$ref": "#/components/parameters/indices.get_settings#include_defaults" + "$ref": "#/components/parameters/indices.delete_alias#name" }, { - "$ref": "#/components/parameters/indices.get_settings#local" + "$ref": "#/components/parameters/indices.delete_alias#master_timeout" }, { - "$ref": "#/components/parameters/indices.get_settings#master_timeout" + "$ref": "#/components/parameters/indices.delete_alias#timeout" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.get_settings#200" + "$ref": "#/components/responses/indices.delete_alias#200" } } - }, - "put": { + } + }, + "/_data_stream/{name}/_lifecycle": { + "get": { "tags": [ - "indices.put_settings" + "indices.get_data_lifecycle" ], - "summary": "Updates the index settings.", - "description": "Updates the index settings.", + "summary": "Returns the data stream lifecycle of the selected data streams.", + "description": "Returns the data stream lifecycle of the selected data streams.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html" }, - "operationId": "indices-put-settings", + "operationId": "indices-get-data-lifecycle", "parameters": [ { - "$ref": "#/components/parameters/indices.put_settings#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.put_settings#expand_wildcards" - }, - { - "$ref": "#/components/parameters/indices.put_settings#flat_settings" - }, - { - "$ref": "#/components/parameters/indices.put_settings#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/indices.put_settings#master_timeout" + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamNames" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/indices.put_settings#preserve_existing" + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.put_settings#timeout" + "in": "query", + "name": "include_defaults", + "description": "If `true`, return all default settings in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.put_settings" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_settings#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.get_data_lifecycle:DataStreamWithLifecycle" + } + } + }, + "required": [ + "data_streams" + ] + } + } + } } } - } - }, - "/{index}/_settings": { - "get": { + }, + "put": { "tags": [ - "indices.get_settings" + "indices.put_data_lifecycle" ], - "summary": "Returns settings for one or more indices.", - "description": "Returns settings for one or more indices.", + "summary": "Updates the data stream lifecycle of the selected data streams.", + "description": "Updates the data stream lifecycle of the selected data streams.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html" }, - "operationId": "indices-get-settings-1", + "operationId": "indices-put-data-lifecycle", "parameters": [ { - "$ref": "#/components/parameters/indices.get_settings#index" - }, - { - "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" - }, - { - "$ref": "#/components/parameters/indices.get_settings#flat_settings" - }, - { - "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamNames" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/indices.get_settings#include_defaults" + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `hidden`, `open`, `closed`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.get_settings#local" + "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" }, { - "$ref": "#/components/parameters/indices.get_settings#master_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" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data_retention": { + "$ref": "#/components/schemas/_types:Duration" + }, + "downsampling": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" + } + } + } + } + } + }, "responses": { "200": { - "$ref": "#/components/responses/indices.get_settings#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } }, - "put": { + "delete": { "tags": [ - "indices.put_settings" + "indices.delete_data_lifecycle" ], - "summary": "Updates the index settings.", - "description": "Updates the index settings.", + "summary": "Deletes the data stream lifecycle of the selected data streams.", + "description": "Deletes the data stream lifecycle of the selected data streams.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html" }, - "operationId": "indices-put-settings-1", + "operationId": "indices-delete-data-lifecycle", "parameters": [ { - "$ref": "#/components/parameters/indices.put_settings#index" - }, - { - "$ref": "#/components/parameters/indices.put_settings#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.put_settings#expand_wildcards" - }, - { - "$ref": "#/components/parameters/indices.put_settings#flat_settings" - }, - { - "$ref": "#/components/parameters/indices.put_settings#ignore_unavailable" + "in": "path", + "name": "name", + "description": "A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamNames" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/indices.put_settings#master_timeout" + "in": "query", + "name": "expand_wildcards", + "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.put_settings#preserve_existing" + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.put_settings#timeout" + "in": "query", + "name": "timeout", + "description": "Explicit timestamp for the document", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.put_settings" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_settings#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } } }, - "/{index}/_settings/{name}": { + "/_index_template/{name}": { "get": { "tags": [ - "indices.get_settings" + "indices.get_index_template" ], - "summary": "Returns settings for one or more indices.", - "description": "Returns settings for one or more indices.", + "summary": "Returns an index template.", + "description": "Returns an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" }, - "operationId": "indices-get-settings-2", + "operationId": "indices-get-index-template-1", "parameters": [ { - "$ref": "#/components/parameters/indices.get_settings#index" - }, - { - "$ref": "#/components/parameters/indices.get_settings#name" - }, - { - "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" - }, - { - "$ref": "#/components/parameters/indices.get_settings#flat_settings" + "$ref": "#/components/parameters/indices.get_index_template#name" }, { - "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + "$ref": "#/components/parameters/indices.get_index_template#local" }, { - "$ref": "#/components/parameters/indices.get_settings#include_defaults" + "$ref": "#/components/parameters/indices.get_index_template#flat_settings" }, { - "$ref": "#/components/parameters/indices.get_settings#local" + "$ref": "#/components/parameters/indices.get_index_template#master_timeout" }, { - "$ref": "#/components/parameters/indices.get_settings#master_timeout" + "$ref": "#/components/parameters/indices.get_index_template#include_defaults" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.get_settings#200" + "$ref": "#/components/responses/indices.get_index_template#200" } } - } - }, - "/_settings/{name}": { - "get": { + }, + "put": { "tags": [ - "indices.get_settings" + "indices.put_index_template" ], - "summary": "Returns settings for one or more indices.", - "description": "Returns settings for one or more indices.", + "summary": "Creates or updates an index template.", + "description": "Creates or updates an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" }, - "operationId": "indices-get-settings-3", + "operationId": "indices-put-index-template", "parameters": [ { - "$ref": "#/components/parameters/indices.get_settings#name" - }, - { - "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" - }, - { - "$ref": "#/components/parameters/indices.get_settings#flat_settings" - }, - { - "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + "$ref": "#/components/parameters/indices.put_index_template#name" }, { - "$ref": "#/components/parameters/indices.get_settings#include_defaults" - }, + "$ref": "#/components/parameters/indices.put_index_template#create" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_index_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_index_template#200" + } + } + }, + "post": { + "tags": [ + "indices.put_index_template" + ], + "summary": "Creates or updates an index template.", + "description": "Creates or updates an index template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" + }, + "operationId": "indices-put-index-template-1", + "parameters": [ { - "$ref": "#/components/parameters/indices.get_settings#local" + "$ref": "#/components/parameters/indices.put_index_template#name" }, { - "$ref": "#/components/parameters/indices.get_settings#master_timeout" + "$ref": "#/components/parameters/indices.put_index_template#create" } ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_index_template" + }, "responses": { "200": { - "$ref": "#/components/responses/indices.get_settings#200" + "$ref": "#/components/responses/indices.put_index_template#200" } } - } - }, - "/_data_stream/_migrate/{name}": { - "post": { + }, + "delete": { "tags": [ - "indices.migrate_to_data_stream" + "indices.delete_index_template" ], - "summary": "Migrates an alias to a data stream", - "description": "Migrates an alias to a data stream", + "summary": "Deletes an index template.", + "description": "Deletes an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html" }, - "operationId": "indices-migrate-to-data-stream", + "operationId": "indices-delete-index-template", "parameters": [ { "in": "path", "name": "name", - "description": "Name of the index alias to convert to a data stream.", + "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:IndexName" + "$ref": "#/components/schemas/_types:Names" }, "style": "simple" + }, + { + "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": { @@ -6669,1055 +7074,1049 @@ } } } - } - }, - "/_data_stream/_modify": { - "post": { + }, + "head": { "tags": [ - "indices.modify_data_stream" + "indices.exists_index_template" ], - "summary": "Modifies a data stream", - "description": "Modifies a data stream", + "summary": "Returns information about whether a particular index template exists.", + "description": "Returns information about whether a particular index template exists.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html" }, - "operationId": "indices-modify-data-stream", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "description": "Actions to perform.", - "type": "array", - "items": { - "$ref": "#/components/schemas/indices.modify_data_stream:Action" - } - } - }, - "required": [ - "actions" - ] - } - } + "operationId": "indices-exists-index-template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" }, - "required": true - }, + { + "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": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } + "application/json": {} } } } } }, - "/_template/{name}": { - "put": { + "/_alias/{name}": { + "get": { "tags": [ - "indices.put_template" + "indices.get_alias" ], - "summary": "Creates or updates an index template.", - "description": "Creates or updates an index template.", + "summary": "Returns an alias.", + "description": "Returns an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-put-template", + "operationId": "indices-get-alias-1", "parameters": [ { - "$ref": "#/components/parameters/indices.put_template#name" - }, - { - "$ref": "#/components/parameters/indices.put_template#create" + "$ref": "#/components/parameters/indices.get_alias#name" }, { - "$ref": "#/components/parameters/indices.put_template#flat_settings" + "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.put_template#master_timeout" + "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.put_template#timeout" + "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.put_template#order" + "$ref": "#/components/parameters/indices.get_alias#local" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.put_template" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_template#200" + "$ref": "#/components/responses/indices.get_alias#200" } } }, - "post": { + "head": { "tags": [ - "indices.put_template" + "indices.exists_alias" ], - "summary": "Creates or updates an index template.", - "description": "Creates or updates an index template.", + "summary": "Returns information about whether a particular alias exists.", + "description": "Returns information about whether a particular alias exists.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-put-template-1", + "operationId": "indices-exists-alias", "parameters": [ { - "$ref": "#/components/parameters/indices.put_template#name" - }, - { - "$ref": "#/components/parameters/indices.put_template#create" + "$ref": "#/components/parameters/indices.exists_alias#name" }, { - "$ref": "#/components/parameters/indices.put_template#flat_settings" + "$ref": "#/components/parameters/indices.exists_alias#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.put_template#master_timeout" + "$ref": "#/components/parameters/indices.exists_alias#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.put_template#timeout" + "$ref": "#/components/parameters/indices.exists_alias#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.put_template#order" + "$ref": "#/components/parameters/indices.exists_alias#local" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.put_template" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.put_template#200" + "$ref": "#/components/responses/indices.exists_alias#200" } } } }, - "/_refresh": { + "/{index}/_lifecycle/explain": { "get": { "tags": [ - "indices.refresh" + "indices.explain_data_lifecycle" ], - "summary": "Performs the refresh operation in one or more indices.", - "description": "Performs the refresh operation in one or more indices.", + "summary": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.", + "description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html" }, - "operationId": "indices-refresh-1", + "operationId": "indices-explain-data-lifecycle", "parameters": [ { - "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + "in": "path", + "name": "index", + "description": "The name of the index to explain", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + "in": "query", + "name": "include_defaults", + "description": "indicates if the API should return the default values the system uses for the index's lifecycle", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.refresh#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "indices": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices.explain_data_lifecycle:DataStreamLifecycleExplain" + } + } + }, + "required": [ + "indices" + ] + } + } + } } } - }, - "post": { + } + }, + "/_alias": { + "get": { "tags": [ - "indices.refresh" + "indices.get_alias" ], - "summary": "Performs the refresh operation in one or more indices.", - "description": "Performs the refresh operation in one or more indices.", + "summary": "Returns an alias.", + "description": "Returns an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-refresh", + "operationId": "indices-get-alias", "parameters": [ { - "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" - } + "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_alias#local" + } ], "responses": { "200": { - "$ref": "#/components/responses/indices.refresh#200" + "$ref": "#/components/responses/indices.get_alias#200" } } } }, - "/{index}/_refresh": { + "/{index}/_alias": { "get": { "tags": [ - "indices.refresh" + "indices.get_alias" ], - "summary": "Performs the refresh operation in one or more indices.", - "description": "Performs the refresh operation in one or more indices.", + "summary": "Returns an alias.", + "description": "Returns an alias.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, - "operationId": "indices-refresh-3", + "operationId": "indices-get-alias-3", "parameters": [ { - "$ref": "#/components/parameters/indices.refresh#index" + "$ref": "#/components/parameters/indices.get_alias#index" }, { - "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" + "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_alias#local" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.refresh#200" + "$ref": "#/components/responses/indices.get_alias#200" } } - }, - "post": { + } + }, + "/_data_stream": { + "get": { "tags": [ - "indices.refresh" + "indices.get_data_stream" ], - "summary": "Performs the refresh operation in one or more indices.", - "description": "Performs the refresh operation in one or more indices.", + "summary": "Returns data streams.", + "description": "Returns data streams.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, - "operationId": "indices-refresh-2", + "operationId": "indices-get-data-stream", "parameters": [ { - "$ref": "#/components/parameters/indices.refresh#index" - }, - { - "$ref": "#/components/parameters/indices.refresh#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + "$ref": "#/components/parameters/indices.get_data_stream#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" + "$ref": "#/components/parameters/indices.get_data_stream#include_defaults" } ], "responses": { "200": { - "$ref": "#/components/responses/indices.refresh#200" + "$ref": "#/components/responses/indices.get_data_stream#200" } } } }, - "/_resolve/index/{name}": { + "/_index_template": { "get": { "tags": [ - "indices.resolve_index" + "indices.get_index_template" ], - "summary": "Returns information about any matching indices, aliases, and data streams", - "description": "Returns information about any matching indices, aliases, and data streams", + "summary": "Returns an index template.", + "description": "Returns an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" }, - "operationId": "indices-resolve-index", + "operationId": "indices-get-index-template", "parameters": [ { - "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" + "$ref": "#/components/parameters/indices.get_index_template#local" }, { - "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`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" - }, - "style": "form" + "$ref": "#/components/parameters/indices.get_index_template#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#include_defaults" } ], "responses": { "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" - ] - } - } - } + "$ref": "#/components/responses/indices.get_index_template#200" } } } }, - "/{alias}/_rollover": { - "post": { + "/_mapping": { + "get": { "tags": [ - "indices.rollover" + "indices.get_mapping" ], - "summary": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", - "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "summary": "Returns mappings for one or more indices.", + "description": "Returns mappings for one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" }, - "operationId": "indices-rollover", + "operationId": "indices-get-mapping", "parameters": [ { - "$ref": "#/components/parameters/indices.rollover#alias" + "$ref": "#/components/parameters/indices.get_mapping#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.rollover#dry_run" + "$ref": "#/components/parameters/indices.get_mapping#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.rollover#master_timeout" + "$ref": "#/components/parameters/indices.get_mapping#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.rollover#timeout" + "$ref": "#/components/parameters/indices.get_mapping#local" }, { - "$ref": "#/components/parameters/indices.rollover#wait_for_active_shards" + "$ref": "#/components/parameters/indices.get_mapping#master_timeout" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.rollover" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.rollover#200" + "$ref": "#/components/responses/indices.get_mapping#200" } } } }, - "/{alias}/_rollover/{new_index}": { - "post": { + "/{index}/_mapping": { + "get": { "tags": [ - "indices.rollover" + "indices.get_mapping" ], - "summary": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", - "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "summary": "Returns mappings for one or more indices.", + "description": "Returns mappings for one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" }, - "operationId": "indices-rollover-1", + "operationId": "indices-get-mapping-1", "parameters": [ { - "$ref": "#/components/parameters/indices.rollover#alias" + "$ref": "#/components/parameters/indices.get_mapping#index" }, { - "$ref": "#/components/parameters/indices.rollover#new_index" + "$ref": "#/components/parameters/indices.get_mapping#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.rollover#dry_run" + "$ref": "#/components/parameters/indices.get_mapping#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.rollover#master_timeout" + "$ref": "#/components/parameters/indices.get_mapping#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.rollover#timeout" + "$ref": "#/components/parameters/indices.get_mapping#local" }, { - "$ref": "#/components/parameters/indices.rollover#wait_for_active_shards" + "$ref": "#/components/parameters/indices.get_mapping#master_timeout" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.rollover" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.rollover#200" + "$ref": "#/components/responses/indices.get_mapping#200" } } - } - }, - "/_index_template/_simulate_index/{name}": { - "post": { + }, + "put": { "tags": [ - "indices.simulate_index_template" + "indices.put_mapping" ], - "summary": "Simulate matching the given index name against the index templates in the system", - "description": "Simulate matching the given index name against the index templates in the system", + "summary": "Updates the index mappings.", + "description": "Updates the index mappings.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, - "operationId": "indices-simulate-index-template", + "operationId": "indices-put-mapping", "parameters": [ { - "in": "path", - "name": "name", - "description": "Name of the index to simulate", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Name" - }, - "style": "simple" + "$ref": "#/components/parameters/indices.put_mapping#index" }, { - "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" + "$ref": "#/components/parameters/indices.put_mapping#allow_no_indices" }, { - "in": "query", - "name": "include_defaults", - "description": "If true, returns all relevant default configurations for the index template.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/indices.put_mapping#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#timeout" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#write_index_only" } ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_mapping" + }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "overlapping": { - "type": "array", - "items": { - "$ref": "#/components/schemas/indices.simulate_template:Overlapping" - } - }, - "template": { - "$ref": "#/components/schemas/indices.simulate_template:Template" - } - }, - "required": [ - "template" - ] - } - } - } + "$ref": "#/components/responses/indices.put_mapping#200" } } - } - }, - "/_index_template/_simulate": { + }, "post": { "tags": [ - "indices.simulate_template" + "indices.put_mapping" ], - "summary": "Simulate resolving the given template name or body", - "description": "Simulate resolving the given template name or body", + "summary": "Updates the index mappings.", + "description": "Updates the index mappings.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, - "operationId": "indices-simulate-template", + "operationId": "indices-put-mapping-1", "parameters": [ { - "$ref": "#/components/parameters/indices.simulate_template#create" + "$ref": "#/components/parameters/indices.put_mapping#index" }, { - "$ref": "#/components/parameters/indices.simulate_template#master_timeout" + "$ref": "#/components/parameters/indices.put_mapping#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.simulate_template#include_defaults" + "$ref": "#/components/parameters/indices.put_mapping#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#timeout" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#write_index_only" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.simulate_template" + "$ref": "#/components/requestBodies/indices.put_mapping" }, "responses": { "200": { - "$ref": "#/components/responses/indices.simulate_template#200" + "$ref": "#/components/responses/indices.put_mapping#200" } } } }, - "/_index_template/_simulate/{name}": { - "post": { + "/_settings": { + "get": { "tags": [ - "indices.simulate_template" + "indices.get_settings" ], - "summary": "Simulate resolving the given template name or body", - "description": "Simulate resolving the given template name or body", + "summary": "Returns settings for one or more indices.", + "description": "Returns settings for one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, - "operationId": "indices-simulate-template-1", + "operationId": "indices-get-settings", "parameters": [ { - "$ref": "#/components/parameters/indices.simulate_template#name" + "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.simulate_template#create" + "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.simulate_template#master_timeout" + "$ref": "#/components/parameters/indices.get_settings#flat_settings" }, { - "$ref": "#/components/parameters/indices.simulate_template#include_defaults" + "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_settings#include_defaults" + }, + { + "$ref": "#/components/parameters/indices.get_settings#local" + }, + { + "$ref": "#/components/parameters/indices.get_settings#master_timeout" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.simulate_template" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.simulate_template#200" + "$ref": "#/components/responses/indices.get_settings#200" } } - } - }, - "/_aliases": { - "post": { + }, + "put": { "tags": [ - "indices.update_aliases" + "indices.put_settings" ], - "summary": "Updates index aliases.", - "description": "Updates index aliases.", + "summary": "Updates the index settings.", + "description": "Updates the index settings.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, - "operationId": "indices-update-aliases", + "operationId": "indices-put-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" + "$ref": "#/components/parameters/indices.put_settings#allow_no_indices" }, { - "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" + "$ref": "#/components/parameters/indices.put_settings#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.put_settings#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.put_settings#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.put_settings#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_settings#preserve_existing" + }, + { + "$ref": "#/components/parameters/indices.put_settings#timeout" } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "description": "Actions to perform.", - "type": "array", - "items": { - "$ref": "#/components/schemas/indices.update_aliases:Action" - } - } - } - } - } - }, - "required": true + "$ref": "#/components/requestBodies/indices.put_settings" }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/indices.put_settings#200" } } } }, - "/_validate/query": { + "/{index}/_settings": { "get": { "tags": [ - "indices.validate_query" + "indices.get_settings" ], - "summary": "Allows a user to validate a potentially expensive query without executing it.", - "description": "Allows a user to validate a potentially expensive query without executing it.", + "summary": "Returns settings for one or more indices.", + "description": "Returns settings for one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, - "operationId": "indices-validate-query", + "operationId": "indices-get-settings-1", "parameters": [ { - "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.validate_query#all_shards" - }, - { - "$ref": "#/components/parameters/indices.validate_query#analyzer" - }, - { - "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" - }, - { - "$ref": "#/components/parameters/indices.validate_query#default_operator" + "$ref": "#/components/parameters/indices.get_settings#index" }, { - "$ref": "#/components/parameters/indices.validate_query#df" + "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.validate_query#explain" + "$ref": "#/components/parameters/indices.get_settings#flat_settings" }, { - "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.validate_query#lenient" + "$ref": "#/components/parameters/indices.get_settings#include_defaults" }, { - "$ref": "#/components/parameters/indices.validate_query#rewrite" + "$ref": "#/components/parameters/indices.get_settings#local" }, { - "$ref": "#/components/parameters/indices.validate_query#q" + "$ref": "#/components/parameters/indices.get_settings#master_timeout" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.validate_query" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.validate_query#200" + "$ref": "#/components/responses/indices.get_settings#200" } } }, - "post": { + "put": { "tags": [ - "indices.validate_query" + "indices.put_settings" ], - "summary": "Allows a user to validate a potentially expensive query without executing it.", - "description": "Allows a user to validate a potentially expensive query without executing it.", + "summary": "Updates the index settings.", + "description": "Updates the index settings.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, - "operationId": "indices-validate-query-1", + "operationId": "indices-put-settings-1", "parameters": [ { - "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.validate_query#all_shards" - }, - { - "$ref": "#/components/parameters/indices.validate_query#analyzer" - }, - { - "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" - }, - { - "$ref": "#/components/parameters/indices.validate_query#default_operator" + "$ref": "#/components/parameters/indices.put_settings#index" }, { - "$ref": "#/components/parameters/indices.validate_query#df" + "$ref": "#/components/parameters/indices.put_settings#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + "$ref": "#/components/parameters/indices.put_settings#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.validate_query#explain" + "$ref": "#/components/parameters/indices.put_settings#flat_settings" }, { - "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + "$ref": "#/components/parameters/indices.put_settings#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.validate_query#lenient" + "$ref": "#/components/parameters/indices.put_settings#master_timeout" }, { - "$ref": "#/components/parameters/indices.validate_query#rewrite" + "$ref": "#/components/parameters/indices.put_settings#preserve_existing" }, { - "$ref": "#/components/parameters/indices.validate_query#q" + "$ref": "#/components/parameters/indices.put_settings#timeout" } ], "requestBody": { - "$ref": "#/components/requestBodies/indices.validate_query" + "$ref": "#/components/requestBodies/indices.put_settings" }, "responses": { "200": { - "$ref": "#/components/responses/indices.validate_query#200" + "$ref": "#/components/responses/indices.put_settings#200" } } } }, - "/{index}/_validate/query": { + "/{index}/_settings/{name}": { "get": { "tags": [ - "indices.validate_query" + "indices.get_settings" ], - "summary": "Allows a user to validate a potentially expensive query without executing it.", - "description": "Allows a user to validate a potentially expensive query without executing it.", + "summary": "Returns settings for one or more indices.", + "description": "Returns settings for one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, - "operationId": "indices-validate-query-2", + "operationId": "indices-get-settings-2", "parameters": [ { - "$ref": "#/components/parameters/indices.validate_query#index" - }, - { - "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.validate_query#all_shards" - }, - { - "$ref": "#/components/parameters/indices.validate_query#analyzer" - }, - { - "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + "$ref": "#/components/parameters/indices.get_settings#index" }, { - "$ref": "#/components/parameters/indices.validate_query#default_operator" + "$ref": "#/components/parameters/indices.get_settings#name" }, { - "$ref": "#/components/parameters/indices.validate_query#df" + "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.validate_query#explain" + "$ref": "#/components/parameters/indices.get_settings#flat_settings" }, { - "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.validate_query#lenient" + "$ref": "#/components/parameters/indices.get_settings#include_defaults" }, { - "$ref": "#/components/parameters/indices.validate_query#rewrite" + "$ref": "#/components/parameters/indices.get_settings#local" }, { - "$ref": "#/components/parameters/indices.validate_query#q" + "$ref": "#/components/parameters/indices.get_settings#master_timeout" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.validate_query" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.validate_query#200" + "$ref": "#/components/responses/indices.get_settings#200" } } - }, - "post": { + } + }, + "/_settings/{name}": { + "get": { "tags": [ - "indices.validate_query" + "indices.get_settings" ], - "summary": "Allows a user to validate a potentially expensive query without executing it.", - "description": "Allows a user to validate a potentially expensive query without executing it.", + "summary": "Returns settings for one or more indices.", + "description": "Returns settings for one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, - "operationId": "indices-validate-query-3", + "operationId": "indices-get-settings-3", "parameters": [ { - "$ref": "#/components/parameters/indices.validate_query#index" - }, - { - "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" - }, - { - "$ref": "#/components/parameters/indices.validate_query#all_shards" - }, - { - "$ref": "#/components/parameters/indices.validate_query#analyzer" - }, - { - "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" - }, - { - "$ref": "#/components/parameters/indices.validate_query#default_operator" + "$ref": "#/components/parameters/indices.get_settings#name" }, { - "$ref": "#/components/parameters/indices.validate_query#df" + "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" }, { - "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" }, { - "$ref": "#/components/parameters/indices.validate_query#explain" + "$ref": "#/components/parameters/indices.get_settings#flat_settings" }, { - "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" }, { - "$ref": "#/components/parameters/indices.validate_query#lenient" + "$ref": "#/components/parameters/indices.get_settings#include_defaults" }, { - "$ref": "#/components/parameters/indices.validate_query#rewrite" + "$ref": "#/components/parameters/indices.get_settings#local" }, { - "$ref": "#/components/parameters/indices.validate_query#q" + "$ref": "#/components/parameters/indices.get_settings#master_timeout" } ], - "requestBody": { - "$ref": "#/components/requestBodies/indices.validate_query" - }, "responses": { "200": { - "$ref": "#/components/responses/indices.validate_query#200" + "$ref": "#/components/responses/indices.get_settings#200" } } } }, - "/_inference/{inference_id}": { - "get": { + "/_data_stream/_migrate/{name}": { + "post": { "tags": [ - "inference.get_model" + "indices.migrate_to_data_stream" ], - "summary": "Get a model in the Inference API", - "description": "Get a model in the Inference API", + "summary": "Migrates an alias to a data stream", + "description": "Migrates an alias to a data stream", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, - "operationId": "inference-get-model", + "operationId": "indices-migrate-to-data-stream", "parameters": [ { - "$ref": "#/components/parameters/inference.get_model#inference_id" + "in": "path", + "name": "name", + "description": "Name of the index alias to convert to a data stream.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" } ], "responses": { "200": { - "$ref": "#/components/responses/inference.get_model#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } - }, - "put": { + } + }, + "/_data_stream/_modify": { + "post": { "tags": [ - "inference.put_model" + "indices.modify_data_stream" ], - "summary": "Configure a model for use in the Inference API", - "description": "Configure a model for use in the Inference API", + "summary": "Modifies a data stream", + "description": "Modifies a data stream", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, - "operationId": "inference-put-model", - "parameters": [ - { - "$ref": "#/components/parameters/inference.put_model#inference_id" - } - ], + "operationId": "indices-modify-data-stream", "requestBody": { - "$ref": "#/components/requestBodies/inference.put_model" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "description": "Actions to perform.", + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.modify_data_stream:Action" + } + } + }, + "required": [ + "actions" + ] + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/inference.put_model#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } - }, - "post": { + } + }, + "/_template/{name}": { + "put": { "tags": [ - "inference.inference" + "indices.put_template" ], - "summary": "Perform inference on a model", - "description": "Perform inference on a model", + "summary": "Creates or updates an index template.", + "description": "Creates or updates an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" }, - "operationId": "inference-inference", + "operationId": "indices-put-template", "parameters": [ { - "$ref": "#/components/parameters/inference.inference#inference_id" + "$ref": "#/components/parameters/indices.put_template#name" + }, + { + "$ref": "#/components/parameters/indices.put_template#create" + }, + { + "$ref": "#/components/parameters/indices.put_template#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.put_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_template#timeout" + }, + { + "$ref": "#/components/parameters/indices.put_template#order" } ], "requestBody": { - "$ref": "#/components/requestBodies/inference.inference" + "$ref": "#/components/requestBodies/indices.put_template" }, "responses": { "200": { - "$ref": "#/components/responses/inference.inference#200" + "$ref": "#/components/responses/indices.put_template#200" } } }, - "delete": { + "post": { "tags": [ - "inference.delete_model" + "indices.put_template" ], - "summary": "Delete model in the Inference API", - "description": "Delete model in the Inference API", + "summary": "Creates or updates an index template.", + "description": "Creates or updates an index template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" }, - "operationId": "inference-delete-model", + "operationId": "indices-put-template-1", "parameters": [ { - "$ref": "#/components/parameters/inference.delete_model#inference_id" + "$ref": "#/components/parameters/indices.put_template#name" + }, + { + "$ref": "#/components/parameters/indices.put_template#create" + }, + { + "$ref": "#/components/parameters/indices.put_template#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.put_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_template#timeout" + }, + { + "$ref": "#/components/parameters/indices.put_template#order" } ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_template" + }, "responses": { "200": { - "$ref": "#/components/responses/inference.delete_model#200" + "$ref": "#/components/responses/indices.put_template#200" } } } }, - "/_inference/{task_type}/{inference_id}": { + "/_refresh": { "get": { "tags": [ - "inference.get_model" + "indices.refresh" ], - "summary": "Get a model in the Inference API", - "description": "Get a model in the Inference API", + "summary": "Performs the refresh operation in one or more indices.", + "description": "Performs the refresh operation in one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, - "operationId": "inference-get-model-1", + "operationId": "indices-refresh-1", "parameters": [ { - "$ref": "#/components/parameters/inference.get_model#task_type" + "$ref": "#/components/parameters/indices.refresh#allow_no_indices" }, { - "$ref": "#/components/parameters/inference.get_model#inference_id" + "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" } ], "responses": { "200": { - "$ref": "#/components/responses/inference.get_model#200" + "$ref": "#/components/responses/indices.refresh#200" } } }, - "put": { + "post": { "tags": [ - "inference.put_model" + "indices.refresh" ], - "summary": "Configure a model for use in the Inference API", - "description": "Configure a model for use in the Inference API", + "summary": "Performs the refresh operation in one or more indices.", + "description": "Performs the refresh operation in one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, - "operationId": "inference-put-model-1", + "operationId": "indices-refresh", "parameters": [ { - "$ref": "#/components/parameters/inference.put_model#task_type" + "$ref": "#/components/parameters/indices.refresh#allow_no_indices" }, { - "$ref": "#/components/parameters/inference.put_model#inference_id" + "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" } ], - "requestBody": { - "$ref": "#/components/requestBodies/inference.put_model" - }, "responses": { "200": { - "$ref": "#/components/responses/inference.put_model#200" + "$ref": "#/components/responses/indices.refresh#200" } } - }, - "post": { + } + }, + "/{index}/_refresh": { + "get": { "tags": [ - "inference.inference" + "indices.refresh" ], - "summary": "Perform inference on a model", - "description": "Perform inference on a model", + "summary": "Performs the refresh operation in one or more indices.", + "description": "Performs the refresh operation in one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, - "operationId": "inference-inference-1", + "operationId": "indices-refresh-3", "parameters": [ { - "$ref": "#/components/parameters/inference.inference#task_type" + "$ref": "#/components/parameters/indices.refresh#index" }, { - "$ref": "#/components/parameters/inference.inference#inference_id" + "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" } ], - "requestBody": { - "$ref": "#/components/requestBodies/inference.inference" - }, "responses": { "200": { - "$ref": "#/components/responses/inference.inference#200" + "$ref": "#/components/responses/indices.refresh#200" } } }, - "delete": { + "post": { "tags": [ - "inference.delete_model" + "indices.refresh" ], - "summary": "Delete model in the Inference API", - "description": "Delete model in the Inference API", + "summary": "Performs the refresh operation in one or more indices.", + "description": "Performs the refresh operation in one or more indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, - "operationId": "inference-delete-model-1", + "operationId": "indices-refresh-2", "parameters": [ { - "$ref": "#/components/parameters/inference.delete_model#task_type" + "$ref": "#/components/parameters/indices.refresh#index" }, { - "$ref": "#/components/parameters/inference.delete_model#inference_id" + "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" } ], "responses": { "200": { - "$ref": "#/components/responses/inference.delete_model#200" + "$ref": "#/components/responses/indices.refresh#200" } } } }, - "/": { + "/_resolve/index/{name}": { "get": { "tags": [ - "info" + "indices.resolve_index" ], - "summary": "Returns basic information about the cluster.", - "description": "Returns basic information about the cluster.", + "summary": "Returns information about any matching indices, aliases, and data streams", + "description": "Returns information about any matching indices, aliases, and data streams", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html" }, - "operationId": "info", + "operationId": "indices-resolve-index", + "parameters": [ + { + "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" + }, + { + "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`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + } + ], "responses": { "200": { "description": "", @@ -7726,102 +8125,136 @@ "schema": { "type": "object", "properties": { - "cluster_name": { - "$ref": "#/components/schemas/_types:Name" - }, - "cluster_uuid": { - "$ref": "#/components/schemas/_types:Uuid" - }, - "name": { - "$ref": "#/components/schemas/_types:Name" + "indices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.resolve_index:ResolveIndexItem" + } }, - "tagline": { - "type": "string" + "aliases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.resolve_index:ResolveIndexAliasItem" + } }, - "version": { - "$ref": "#/components/schemas/_types:ElasticsearchVersionInfo" + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.resolve_index:ResolveIndexDataStreamsItem" + } } }, "required": [ - "cluster_name", - "cluster_uuid", - "name", - "tagline", - "version" + "indices", + "aliases", + "data_streams" ] } } } } } - }, - "head": { + } + }, + "/{alias}/_rollover": { + "post": { "tags": [ - "ping" + "indices.rollover" ], - "summary": "Returns whether the cluster is running.", - "description": "Returns whether the cluster is running.", + "summary": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" + }, + "operationId": "indices-rollover", + "parameters": [ + { + "$ref": "#/components/parameters/indices.rollover#alias" + }, + { + "$ref": "#/components/parameters/indices.rollover#dry_run" + }, + { + "$ref": "#/components/parameters/indices.rollover#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.rollover#timeout" + }, + { + "$ref": "#/components/parameters/indices.rollover#wait_for_active_shards" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.rollover" }, - "operationId": "ping", "responses": { "200": { - "description": "", - "content": { - "application/json": {} - } + "$ref": "#/components/responses/indices.rollover#200" } } } }, - "/_ingest/pipeline/{id}": { - "get": { + "/{alias}/_rollover/{new_index}": { + "post": { "tags": [ - "ingest.get_pipeline" + "indices.rollover" ], - "summary": "Returns a pipeline.", - "description": "Returns a pipeline.", + "summary": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" }, - "operationId": "ingest-get-pipeline-1", + "operationId": "indices-rollover-1", "parameters": [ { - "$ref": "#/components/parameters/ingest.get_pipeline#id" + "$ref": "#/components/parameters/indices.rollover#alias" }, { - "$ref": "#/components/parameters/ingest.get_pipeline#master_timeout" + "$ref": "#/components/parameters/indices.rollover#new_index" }, { - "$ref": "#/components/parameters/ingest.get_pipeline#summary" + "$ref": "#/components/parameters/indices.rollover#dry_run" + }, + { + "$ref": "#/components/parameters/indices.rollover#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.rollover#timeout" + }, + { + "$ref": "#/components/parameters/indices.rollover#wait_for_active_shards" } ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.rollover" + }, "responses": { "200": { - "$ref": "#/components/responses/ingest.get_pipeline#200" + "$ref": "#/components/responses/indices.rollover#200" } } - }, - "put": { + } + }, + "/_index_template/_simulate_index/{name}": { + "post": { "tags": [ - "ingest.put_pipeline" + "indices.simulate_index_template" ], - "summary": "Creates or updates a pipeline.", - "description": "Creates or updates a pipeline.", + "summary": "Simulate matching the given index name against the index templates in the system", + "description": "Simulate matching the given index name against the index templates in the system", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html" }, - "operationId": "ingest-put-pipeline", + "operationId": "indices-simulate-index-template", "parameters": [ { "in": "path", - "name": "id", - "description": "ID of the ingest pipeline to create or update.", + "name": "name", + "description": "Name of the index to simulate", "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Id" + "$ref": "#/components/schemas/_types:Name" }, "style": "simple" }, @@ -7837,186 +8270,169 @@ }, { "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": "if_version", - "description": "Required version for optimistic concurrency control for pipeline updates", + "name": "include_defaults", + "description": "If true, returns all relevant default configurations for the index template.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:VersionNumber" + "type": "boolean" }, "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "_meta": { - "$ref": "#/components/schemas/_types:Metadata" - }, - "description": { - "description": "Description of the ingest pipeline.", - "type": "string" - }, - "on_failure": { - "description": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ingest._types:ProcessorContainer" - } - }, - "processors": { - "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ingest._types:ProcessorContainer" - } - }, - "version": { - "$ref": "#/components/schemas/_types:VersionNumber" - } - } - } - } - }, - "required": true - }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + "type": "object", + "properties": { + "overlapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.simulate_template:Overlapping" + } + }, + "template": { + "$ref": "#/components/schemas/indices.simulate_template:Template" + } + }, + "required": [ + "template" + ] } } } } } - }, - "delete": { + } + }, + "/_index_template/_simulate": { + "post": { "tags": [ - "ingest.delete_pipeline" + "indices.simulate_template" ], - "summary": "Deletes a pipeline.", - "description": "Deletes a pipeline.", + "summary": "Simulate resolving the given template name or body", + "description": "Simulate resolving the given template name or body", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" }, - "operationId": "ingest-delete-pipeline", + "operationId": "indices-simulate-template", "parameters": [ { - "in": "path", - "name": "id", - "description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request.\nTo delete all ingest pipelines in a cluster, use a value of `*`.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/indices.simulate_template#create" }, { - "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" + "$ref": "#/components/parameters/indices.simulate_template#master_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" + "$ref": "#/components/parameters/indices.simulate_template#include_defaults" } ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.simulate_template" + }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/indices.simulate_template#200" } } } }, - "/_ingest/pipeline": { - "get": { + "/_index_template/_simulate/{name}": { + "post": { "tags": [ - "ingest.get_pipeline" + "indices.simulate_template" ], - "summary": "Returns a pipeline.", - "description": "Returns a pipeline.", + "summary": "Simulate resolving the given template name or body", + "description": "Simulate resolving the given template name or body", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" }, - "operationId": "ingest-get-pipeline", + "operationId": "indices-simulate-template-1", "parameters": [ { - "$ref": "#/components/parameters/ingest.get_pipeline#master_timeout" + "$ref": "#/components/parameters/indices.simulate_template#name" }, { - "$ref": "#/components/parameters/ingest.get_pipeline#summary" + "$ref": "#/components/parameters/indices.simulate_template#create" + }, + { + "$ref": "#/components/parameters/indices.simulate_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.simulate_template#include_defaults" } ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.simulate_template" + }, "responses": { "200": { - "$ref": "#/components/responses/ingest.get_pipeline#200" + "$ref": "#/components/responses/indices.simulate_template#200" } } } }, - "/_ingest/processor/grok": { - "get": { + "/_aliases": { + "post": { "tags": [ - "ingest.processor_grok" + "indices.update_aliases" ], - "summary": "Returns a list of the built-in patterns.", - "description": "Returns a list of the built-in patterns.", + "summary": "Updates index aliases.", + "description": "Updates index aliases.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-update-aliases", + "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" + }, + { + "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" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "description": "Actions to perform.", + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.update_aliases:Action" + } + } + } + } + } + }, + "required": true }, - "operationId": "ingest-processor-grok", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "patterns": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "patterns" - ] + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" } } } @@ -8024,488 +8440,551 @@ } } }, - "/_ingest/pipeline/_simulate": { + "/_validate/query": { "get": { "tags": [ - "ingest.simulate" + "indices.validate_query" ], - "summary": "Allows to simulate a pipeline with example documents.", - "description": "Allows to simulate a pipeline with example documents.", + "summary": "Allows a user to validate a potentially expensive query without executing it.", + "description": "Allows a user to validate a potentially expensive query without executing it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, - "operationId": "ingest-simulate", + "operationId": "indices-validate-query", "parameters": [ { - "$ref": "#/components/parameters/ingest.simulate#verbose" + "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.validate_query#all_shards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyzer" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/indices.validate_query#default_operator" + }, + { + "$ref": "#/components/parameters/indices.validate_query#df" + }, + { + "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#explain" + }, + { + "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.validate_query#lenient" + }, + { + "$ref": "#/components/parameters/indices.validate_query#rewrite" + }, + { + "$ref": "#/components/parameters/indices.validate_query#q" } ], "requestBody": { - "$ref": "#/components/requestBodies/ingest.simulate" + "$ref": "#/components/requestBodies/indices.validate_query" }, "responses": { "200": { - "$ref": "#/components/responses/ingest.simulate#200" + "$ref": "#/components/responses/indices.validate_query#200" } } }, "post": { "tags": [ - "ingest.simulate" + "indices.validate_query" ], - "summary": "Allows to simulate a pipeline with example documents.", - "description": "Allows to simulate a pipeline with example documents.", + "summary": "Allows a user to validate a potentially expensive query without executing it.", + "description": "Allows a user to validate a potentially expensive query without executing it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, - "operationId": "ingest-simulate-1", + "operationId": "indices-validate-query-1", "parameters": [ { - "$ref": "#/components/parameters/ingest.simulate#verbose" + "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.validate_query#all_shards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyzer" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/indices.validate_query#default_operator" + }, + { + "$ref": "#/components/parameters/indices.validate_query#df" + }, + { + "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#explain" + }, + { + "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.validate_query#lenient" + }, + { + "$ref": "#/components/parameters/indices.validate_query#rewrite" + }, + { + "$ref": "#/components/parameters/indices.validate_query#q" } ], "requestBody": { - "$ref": "#/components/requestBodies/ingest.simulate" + "$ref": "#/components/requestBodies/indices.validate_query" }, "responses": { "200": { - "$ref": "#/components/responses/ingest.simulate#200" + "$ref": "#/components/responses/indices.validate_query#200" } } } }, - "/_ingest/pipeline/{id}/_simulate": { + "/{index}/_validate/query": { "get": { "tags": [ - "ingest.simulate" + "indices.validate_query" ], - "summary": "Allows to simulate a pipeline with example documents.", - "description": "Allows to simulate a pipeline with example documents.", + "summary": "Allows a user to validate a potentially expensive query without executing it.", + "description": "Allows a user to validate a potentially expensive query without executing it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, - "operationId": "ingest-simulate-2", + "operationId": "indices-validate-query-2", "parameters": [ { - "$ref": "#/components/parameters/ingest.simulate#id" + "$ref": "#/components/parameters/indices.validate_query#index" }, { - "$ref": "#/components/parameters/ingest.simulate#verbose" + "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.validate_query#all_shards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyzer" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/indices.validate_query#default_operator" + }, + { + "$ref": "#/components/parameters/indices.validate_query#df" + }, + { + "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#explain" + }, + { + "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.validate_query#lenient" + }, + { + "$ref": "#/components/parameters/indices.validate_query#rewrite" + }, + { + "$ref": "#/components/parameters/indices.validate_query#q" } ], "requestBody": { - "$ref": "#/components/requestBodies/ingest.simulate" + "$ref": "#/components/requestBodies/indices.validate_query" }, "responses": { "200": { - "$ref": "#/components/responses/ingest.simulate#200" + "$ref": "#/components/responses/indices.validate_query#200" } } }, "post": { "tags": [ - "ingest.simulate" + "indices.validate_query" ], - "summary": "Allows to simulate a pipeline with example documents.", - "description": "Allows to simulate a pipeline with example documents.", + "summary": "Allows a user to validate a potentially expensive query without executing it.", + "description": "Allows a user to validate a potentially expensive query without executing it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" }, - "operationId": "ingest-simulate-3", + "operationId": "indices-validate-query-3", "parameters": [ { - "$ref": "#/components/parameters/ingest.simulate#id" + "$ref": "#/components/parameters/indices.validate_query#index" }, { - "$ref": "#/components/parameters/ingest.simulate#verbose" + "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.validate_query#all_shards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyzer" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/indices.validate_query#default_operator" + }, + { + "$ref": "#/components/parameters/indices.validate_query#df" + }, + { + "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#explain" + }, + { + "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.validate_query#lenient" + }, + { + "$ref": "#/components/parameters/indices.validate_query#rewrite" + }, + { + "$ref": "#/components/parameters/indices.validate_query#q" } ], "requestBody": { - "$ref": "#/components/requestBodies/ingest.simulate" + "$ref": "#/components/requestBodies/indices.validate_query" }, "responses": { "200": { - "$ref": "#/components/responses/ingest.simulate#200" + "$ref": "#/components/responses/indices.validate_query#200" } } } }, - "/_license": { + "/_inference/{inference_id}": { "get": { "tags": [ - "license.get" + "inference.get_model" ], - "summary": "Retrieves licensing information for the cluster", - "description": "Retrieves licensing information for the cluster", + "summary": "Get a model in the Inference API", + "description": "Get a model in the Inference API", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" }, - "operationId": "license-get", + "operationId": "inference-get-model", "parameters": [ { - "in": "query", - "name": "accept_enterprise", - "description": "If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility.\nThis parameter is deprecated and will always be set to true in 8.x.", - "deprecated": true, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "local", - "description": "Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/inference.get_model#inference_id" } ], "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "license": { - "$ref": "#/components/schemas/license.get:LicenseInformation" - } - }, - "required": [ - "license" - ] - } - } - } + "$ref": "#/components/responses/inference.get_model#200" } } - } - }, - "/_logstash/pipeline/{id}": { - "get": { + }, + "put": { "tags": [ - "logstash.get_pipeline" + "inference.put_model" ], - "summary": "Retrieves Logstash Pipelines used by Central Management", - "description": "Retrieves Logstash Pipelines used by Central Management", + "summary": "Configure a model for use in the Inference API", + "description": "Configure a model for use in the Inference API", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html" }, - "operationId": "logstash-get-pipeline-1", + "operationId": "inference-put-model", "parameters": [ { - "$ref": "#/components/parameters/logstash.get_pipeline#id" + "$ref": "#/components/parameters/inference.put_model#inference_id" } ], + "requestBody": { + "$ref": "#/components/requestBodies/inference.put_model" + }, "responses": { "200": { - "$ref": "#/components/responses/logstash.get_pipeline#200" + "$ref": "#/components/responses/inference.put_model#200" } } }, - "put": { + "post": { "tags": [ - "logstash.put_pipeline" + "inference.inference" ], - "summary": "Adds and updates Logstash Pipelines used for Central Management", - "description": "Adds and updates Logstash Pipelines used for Central Management", + "summary": "Perform inference on a model", + "description": "Perform inference on a model", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html" }, - "operationId": "logstash-put-pipeline", + "operationId": "inference-inference", "parameters": [ { - "in": "path", - "name": "id", - "description": "Identifier for the pipeline.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/inference.inference#inference_id" } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/logstash._types:Pipeline" - } - } - }, - "required": true + "$ref": "#/components/requestBodies/inference.inference" }, "responses": { "200": { - "description": "", - "content": { - "application/json": {} - } + "$ref": "#/components/responses/inference.inference#200" } } }, "delete": { "tags": [ - "logstash.delete_pipeline" + "inference.delete_model" ], - "summary": "Deletes Logstash Pipelines used by Central Management", - "description": "Deletes Logstash Pipelines used by Central Management", + "summary": "Delete model in the Inference API", + "description": "Delete model in the Inference API", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html" }, - "operationId": "logstash-delete-pipeline", + "operationId": "inference-delete-model", "parameters": [ { - "in": "path", - "name": "id", - "description": "Identifier for the pipeline.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/inference.delete_model#inference_id" } ], "responses": { "200": { - "description": "", - "content": { - "application/json": {} - } + "$ref": "#/components/responses/inference.delete_model#200" } } } }, - "/_logstash/pipeline": { + "/_inference/{task_type}/{inference_id}": { "get": { "tags": [ - "logstash.get_pipeline" + "inference.get_model" ], - "summary": "Retrieves Logstash Pipelines used by Central Management", - "description": "Retrieves Logstash Pipelines used by Central Management", + "summary": "Get a model in the Inference API", + "description": "Get a model in the Inference API", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" }, - "operationId": "logstash-get-pipeline", + "operationId": "inference-get-model-1", + "parameters": [ + { + "$ref": "#/components/parameters/inference.get_model#task_type" + }, + { + "$ref": "#/components/parameters/inference.get_model#inference_id" + } + ], "responses": { "200": { - "$ref": "#/components/responses/logstash.get_pipeline#200" + "$ref": "#/components/responses/inference.get_model#200" } } - } - }, - "/_mget": { - "get": { + }, + "put": { "tags": [ - "mget" + "inference.put_model" ], - "summary": "Allows to get multiple documents in one request.", - "description": "Allows to get multiple documents in one request.", + "summary": "Configure a model for use in the Inference API", + "description": "Configure a model for use in the Inference API", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html" }, - "operationId": "mget", + "operationId": "inference-put-model-1", "parameters": [ { - "$ref": "#/components/parameters/mget#preference" - }, - { - "$ref": "#/components/parameters/mget#realtime" - }, - { - "$ref": "#/components/parameters/mget#refresh" - }, - { - "$ref": "#/components/parameters/mget#routing" - }, - { - "$ref": "#/components/parameters/mget#_source" - }, - { - "$ref": "#/components/parameters/mget#_source_excludes" - }, - { - "$ref": "#/components/parameters/mget#_source_includes" + "$ref": "#/components/parameters/inference.put_model#task_type" }, { - "$ref": "#/components/parameters/mget#stored_fields" + "$ref": "#/components/parameters/inference.put_model#inference_id" } ], "requestBody": { - "$ref": "#/components/requestBodies/mget" + "$ref": "#/components/requestBodies/inference.put_model" }, "responses": { "200": { - "$ref": "#/components/responses/mget#200" + "$ref": "#/components/responses/inference.put_model#200" } } }, "post": { "tags": [ - "mget" + "inference.inference" ], - "summary": "Allows to get multiple documents in one request.", - "description": "Allows to get multiple documents in one request.", + "summary": "Perform inference on a model", + "description": "Perform inference on a model", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html" }, - "operationId": "mget-1", + "operationId": "inference-inference-1", "parameters": [ { - "$ref": "#/components/parameters/mget#preference" - }, - { - "$ref": "#/components/parameters/mget#realtime" - }, - { - "$ref": "#/components/parameters/mget#refresh" - }, - { - "$ref": "#/components/parameters/mget#routing" - }, - { - "$ref": "#/components/parameters/mget#_source" - }, - { - "$ref": "#/components/parameters/mget#_source_excludes" - }, - { - "$ref": "#/components/parameters/mget#_source_includes" + "$ref": "#/components/parameters/inference.inference#task_type" }, { - "$ref": "#/components/parameters/mget#stored_fields" + "$ref": "#/components/parameters/inference.inference#inference_id" } ], "requestBody": { - "$ref": "#/components/requestBodies/mget" + "$ref": "#/components/requestBodies/inference.inference" }, "responses": { "200": { - "$ref": "#/components/responses/mget#200" + "$ref": "#/components/responses/inference.inference#200" } } - } - }, - "/{index}/_mget": { - "get": { + }, + "delete": { "tags": [ - "mget" + "inference.delete_model" ], - "summary": "Allows to get multiple documents in one request.", - "description": "Allows to get multiple documents in one request.", + "summary": "Delete model in the Inference API", + "description": "Delete model in the Inference API", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html" }, - "operationId": "mget-2", + "operationId": "inference-delete-model-1", "parameters": [ { - "$ref": "#/components/parameters/mget#index" - }, - { - "$ref": "#/components/parameters/mget#preference" - }, - { - "$ref": "#/components/parameters/mget#realtime" - }, - { - "$ref": "#/components/parameters/mget#refresh" - }, - { - "$ref": "#/components/parameters/mget#routing" - }, - { - "$ref": "#/components/parameters/mget#_source" - }, - { - "$ref": "#/components/parameters/mget#_source_excludes" - }, - { - "$ref": "#/components/parameters/mget#_source_includes" + "$ref": "#/components/parameters/inference.delete_model#task_type" }, { - "$ref": "#/components/parameters/mget#stored_fields" + "$ref": "#/components/parameters/inference.delete_model#inference_id" } ], - "requestBody": { - "$ref": "#/components/requestBodies/mget" + "responses": { + "200": { + "$ref": "#/components/responses/inference.delete_model#200" + } + } + } + }, + "/": { + "get": { + "tags": [ + "info" + ], + "summary": "Returns basic information about the cluster.", + "description": "Returns basic information about the cluster.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" }, + "operationId": "info", "responses": { "200": { - "$ref": "#/components/responses/mget#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cluster_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "cluster_uuid": { + "$ref": "#/components/schemas/_types:Uuid" + }, + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "tagline": { + "type": "string" + }, + "version": { + "$ref": "#/components/schemas/_types:ElasticsearchVersionInfo" + } + }, + "required": [ + "cluster_name", + "cluster_uuid", + "name", + "tagline", + "version" + ] + } + } + } } } }, - "post": { + "head": { "tags": [ - "mget" + "ping" ], - "summary": "Allows to get multiple documents in one request.", - "description": "Allows to get multiple documents in one request.", + "summary": "Returns whether the cluster is running.", + "description": "Returns whether the cluster is running.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" }, - "operationId": "mget-3", + "operationId": "ping", + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + } + } + }, + "/_ingest/pipeline/{id}": { + "get": { + "tags": [ + "ingest.get_pipeline" + ], + "summary": "Returns a pipeline.", + "description": "Returns a pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html" + }, + "operationId": "ingest-get-pipeline-1", "parameters": [ { - "$ref": "#/components/parameters/mget#index" - }, - { - "$ref": "#/components/parameters/mget#preference" - }, - { - "$ref": "#/components/parameters/mget#realtime" - }, - { - "$ref": "#/components/parameters/mget#refresh" - }, - { - "$ref": "#/components/parameters/mget#routing" - }, - { - "$ref": "#/components/parameters/mget#_source" - }, - { - "$ref": "#/components/parameters/mget#_source_excludes" + "$ref": "#/components/parameters/ingest.get_pipeline#id" }, { - "$ref": "#/components/parameters/mget#_source_includes" + "$ref": "#/components/parameters/ingest.get_pipeline#master_timeout" }, { - "$ref": "#/components/parameters/mget#stored_fields" + "$ref": "#/components/parameters/ingest.get_pipeline#summary" } ], - "requestBody": { - "$ref": "#/components/requestBodies/mget" - }, "responses": { "200": { - "$ref": "#/components/responses/mget#200" + "$ref": "#/components/responses/ingest.get_pipeline#200" } } - } - }, - "/_ml/anomaly_detectors/{job_id}/_close": { - "post": { + }, + "put": { "tags": [ - "ml.close_job" + "ingest.put_pipeline" ], - "summary": "Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.", - "description": "Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.", + "summary": "Creates or updates a pipeline.", + "description": "Creates or updates a pipeline.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" }, - "operationId": "ml-close-job", + "operationId": "ingest-put-pipeline", "parameters": [ { "in": "path", - "name": "job_id", - "description": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", + "name": "id", + "description": "ID of the ingest pipeline to create or update.", "required": true, "deprecated": false, "schema": { @@ -8515,31 +8994,31 @@ }, { "in": "query", - "name": "allow_no_match", - "description": "Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs 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.", + "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": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Duration" }, "style": "form" }, { "in": "query", - "name": "force", - "description": "Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.\nIf you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.", + "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": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Duration" }, "style": "form" }, { "in": "query", - "name": "timeout", - "description": "Controls the time to wait until a job has closed.", + "name": "if_version", + "description": "Required version for optimistic concurrency control for pipeline updates", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:VersionNumber" }, "style": "form" } @@ -8550,21 +9029,35 @@ "schema": { "type": "object", "properties": { - "allow_no_match": { - "description": "Refer to the description for the `allow_no_match` query parameter.", - "type": "boolean" + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" }, - "force": { - "description": "Refer to the descriptiion for the `force` query parameter.", - "type": "boolean" + "description": { + "description": "Description of the ingest pipeline.", + "type": "string" }, - "timeout": { - "$ref": "#/components/schemas/_types:Duration" + "on_failure": { + "description": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest._types:ProcessorContainer" + } + }, + "processors": { + "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest._types:ProcessorContainer" + } + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" } } } } - } + }, + "required": true }, "responses": { "200": { @@ -8572,98 +9065,107 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "closed": { - "type": "boolean" - } - }, - "required": [ - "closed" - ] + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" } } } } } - } - }, - "/_ml/calendars/{calendar_id}": { - "get": { + }, + "delete": { "tags": [ - "ml.get_calendars" + "ingest.delete_pipeline" ], - "summary": "Retrieves configuration information for calendars.", - "description": "Retrieves configuration information for calendars.", + "summary": "Deletes a pipeline.", + "description": "Deletes a pipeline.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html" }, - "operationId": "ml-get-calendars-2", + "operationId": "ingest-delete-pipeline", "parameters": [ { - "$ref": "#/components/parameters/ml.get_calendars#calendar_id" + "in": "path", + "name": "id", + "description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request.\nTo delete all ingest pipelines in a cluster, use a value of `*`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/ml.get_calendars#from" + "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" }, { - "$ref": "#/components/parameters/ml.get_calendars#size" + "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" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.get_calendars" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_calendars#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } - }, - "put": { + } + }, + "/_ingest/pipeline": { + "get": { "tags": [ - "ml.put_calendar" + "ingest.get_pipeline" ], - "summary": "Instantiates a calendar.", - "description": "Instantiates a calendar.", + "summary": "Returns a pipeline.", + "description": "Returns a pipeline.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html" }, - "operationId": "ml-put-calendar", + "operationId": "ingest-get-pipeline", "parameters": [ { - "in": "path", - "name": "calendar_id", - "description": "A string that uniquely identifies a calendar.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ingest.get_pipeline#master_timeout" + }, + { + "$ref": "#/components/parameters/ingest.get_pipeline#summary" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "job_ids": { - "description": "An array of anomaly detection job identifiers.", - "type": "array", - "items": { - "$ref": "#/components/schemas/_types:Id" - } - }, - "description": { - "description": "A description of the calendar.", - "type": "string" - } - } - } - } + "responses": { + "200": { + "$ref": "#/components/responses/ingest.get_pipeline#200" } + } + } + }, + "/_ingest/processor/grok": { + "get": { + "tags": [ + "ingest.processor_grok" + ], + "summary": "Returns a list of the built-in patterns.", + "description": "Returns a list of the built-in patterns.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" }, + "operationId": "ingest-processor-grok", "responses": { "200": { "description": "", @@ -8672,239 +9174,160 @@ "schema": { "type": "object", "properties": { - "calendar_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "description": { - "description": "A description of the calendar.", - "type": "string" - }, - "job_ids": { - "$ref": "#/components/schemas/_types:Ids" + "patterns": { + "type": "object", + "additionalProperties": { + "type": "string" + } } }, "required": [ - "calendar_id", - "job_ids" + "patterns" ] } } } } } - }, - "post": { + } + }, + "/_ingest/pipeline/_simulate": { + "get": { "tags": [ - "ml.get_calendars" + "ingest.simulate" ], - "summary": "Retrieves configuration information for calendars.", - "description": "Retrieves configuration information for calendars.", + "summary": "Allows to simulate a pipeline with example documents.", + "description": "Allows to simulate a pipeline with example documents.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" }, - "operationId": "ml-get-calendars-3", + "operationId": "ingest-simulate", "parameters": [ { - "$ref": "#/components/parameters/ml.get_calendars#calendar_id" - }, - { - "$ref": "#/components/parameters/ml.get_calendars#from" - }, - { - "$ref": "#/components/parameters/ml.get_calendars#size" + "$ref": "#/components/parameters/ingest.simulate#verbose" } ], "requestBody": { - "$ref": "#/components/requestBodies/ml.get_calendars" + "$ref": "#/components/requestBodies/ingest.simulate" }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_calendars#200" + "$ref": "#/components/responses/ingest.simulate#200" } } }, - "delete": { + "post": { "tags": [ - "ml.delete_calendar" + "ingest.simulate" ], - "summary": "Deletes a calendar.", - "description": "Deletes a calendar.", + "summary": "Allows to simulate a pipeline with example documents.", + "description": "Allows to simulate a pipeline with example documents.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" }, - "operationId": "ml-delete-calendar", + "operationId": "ingest-simulate-1", "parameters": [ { - "in": "path", - "name": "calendar_id", - "description": "A string that uniquely identifies a calendar.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ingest.simulate#verbose" } ], + "requestBody": { + "$ref": "#/components/requestBodies/ingest.simulate" + }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/ingest.simulate#200" } } } }, - "/_ml/calendars/{calendar_id}/events/{event_id}": { - "delete": { + "/_ingest/pipeline/{id}/_simulate": { + "get": { "tags": [ - "ml.delete_calendar_event" + "ingest.simulate" ], - "summary": "Deletes scheduled events from a calendar.", - "description": "Deletes scheduled events from a calendar.", + "summary": "Allows to simulate a pipeline with example documents.", + "description": "Allows to simulate a pipeline with example documents.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" }, - "operationId": "ml-delete-calendar-event", + "operationId": "ingest-simulate-2", "parameters": [ { - "in": "path", - "name": "calendar_id", - "description": "A string that uniquely identifies a calendar.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ingest.simulate#id" }, { - "in": "path", - "name": "event_id", - "description": "Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ingest.simulate#verbose" } ], + "requestBody": { + "$ref": "#/components/requestBodies/ingest.simulate" + }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/ingest.simulate#200" } } - } - }, - "/_ml/calendars/{calendar_id}/jobs/{job_id}": { - "put": { + }, + "post": { "tags": [ - "ml.put_calendar_job" + "ingest.simulate" ], - "summary": "Adds an anomaly detection job to a calendar.", - "description": "Adds an anomaly detection job to a calendar.", + "summary": "Allows to simulate a pipeline with example documents.", + "description": "Allows to simulate a pipeline with example documents.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" }, - "operationId": "ml-put-calendar-job", + "operationId": "ingest-simulate-3", "parameters": [ { - "in": "path", - "name": "calendar_id", - "description": "A string that uniquely identifies a calendar.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ingest.simulate#id" }, { - "in": "path", - "name": "job_id", - "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ingest.simulate#verbose" } ], + "requestBody": { + "$ref": "#/components/requestBodies/ingest.simulate" + }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "calendar_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "description": { - "description": "A description of the calendar.", - "type": "string" - }, - "job_ids": { - "$ref": "#/components/schemas/_types:Ids" - } - }, - "required": [ - "calendar_id", - "job_ids" - ] - } - } - } + "$ref": "#/components/responses/ingest.simulate#200" } } - }, - "delete": { + } + }, + "/_license": { + "get": { "tags": [ - "ml.delete_calendar_job" + "license.get" ], - "summary": "Deletes anomaly detection jobs from a calendar.", - "description": "Deletes anomaly detection jobs from a calendar.", + "summary": "Retrieves licensing information for the cluster", + "description": "Retrieves licensing information for the cluster", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html" }, - "operationId": "ml-delete-calendar-job", + "operationId": "license-get", "parameters": [ { - "in": "path", - "name": "calendar_id", - "description": "A string that uniquely identifies a calendar.", - "required": true, - "deprecated": false, + "in": "query", + "name": "accept_enterprise", + "description": "If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility.\nThis parameter is deprecated and will always be set to true in 8.x.", + "deprecated": true, "schema": { - "$ref": "#/components/schemas/_types:Id" + "type": "boolean" }, - "style": "simple" + "style": "form" }, { - "in": "path", - "name": "job_id", - "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a\ncomma-separated list of jobs or groups.", - "required": true, + "in": "query", + "name": "local", + "description": "Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Ids" + "type": "boolean" }, - "style": "simple" + "style": "form" } ], "responses": { @@ -8915,20 +9338,12 @@ "schema": { "type": "object", "properties": { - "calendar_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "description": { - "description": "A description of the calendar.", - "type": "string" - }, - "job_ids": { - "$ref": "#/components/schemas/_types:Ids" + "license": { + "$ref": "#/components/schemas/license.get:LicenseInformation" } }, "required": [ - "calendar_id", - "job_ids" + "license" ] } } @@ -8937,55 +9352,43 @@ } } }, - "/_ml/data_frame/analytics/{id}": { + "/_logstash/pipeline/{id}": { "get": { "tags": [ - "ml.get_data_frame_analytics" + "logstash.get_pipeline" ], - "summary": "Retrieves configuration information for data frame analytics jobs.", - "description": "Retrieves configuration information for data frame analytics jobs.", + "summary": "Retrieves Logstash Pipelines used by Central Management", + "description": "Retrieves Logstash Pipelines used by Central Management", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html" }, - "operationId": "ml-get-data-frame-analytics", + "operationId": "logstash-get-pipeline-1", "parameters": [ { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#id" - }, - { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#allow_no_match" - }, - { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#from" - }, - { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#size" - }, - { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#exclude_generated" + "$ref": "#/components/parameters/logstash.get_pipeline#id" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_data_frame_analytics#200" + "$ref": "#/components/responses/logstash.get_pipeline#200" } } }, "put": { "tags": [ - "ml.put_data_frame_analytics" + "logstash.put_pipeline" ], - "summary": "Instantiates a data frame analytics job.", - "description": "Instantiates a data frame analytics job.", + "summary": "Adds and updates Logstash Pipelines used for Central Management", + "description": "Adds and updates Logstash Pipelines used for Central Management", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html" }, - "operationId": "ml-put-data-frame-analytics", + "operationId": "logstash-put-pipeline", "parameters": [ { "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.", + "description": "Identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -8998,51 +9401,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "allow_lazy_start": { - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" - }, - "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", - "type": "boolean" - }, - "analysis": { - "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" - }, - "analyzed_fields": { - "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" - }, - "description": { - "description": "A description of the job.", - "type": "string" - }, - "dest": { - "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" - }, - "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.", - "type": "number" - }, - "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\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", - "type": "string" - }, - "source": { - "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" - }, - "headers": { - "$ref": "#/components/schemas/_types:HttpHeaders" - }, - "version": { - "$ref": "#/components/schemas/_types:VersionString" - } - }, - "required": [ - "analysis", - "dest", - "source" - ] + "$ref": "#/components/schemas/logstash._types:Pipeline" } } }, @@ -9052,369 +9411,268 @@ "200": { "description": "", "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "authorization": { - "$ref": "#/components/schemas/ml._types:DataframeAnalyticsAuthorization" - }, - "allow_lazy_start": { - "type": "boolean" - }, - "analysis": { - "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" - }, - "analyzed_fields": { - "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" - }, - "create_time": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, - "description": { - "type": "string" - }, - "dest": { - "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" - }, - "id": { - "$ref": "#/components/schemas/_types:Id" - }, - "max_num_threads": { - "type": "number" - }, - "model_memory_limit": { - "type": "string" - }, - "source": { - "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" - }, - "version": { - "$ref": "#/components/schemas/_types:VersionString" - } - }, - "required": [ - "allow_lazy_start", - "analysis", - "create_time", - "dest", - "id", - "max_num_threads", - "model_memory_limit", - "source", - "version" - ] - } - } + "application/json": {} } } } }, "delete": { "tags": [ - "ml.delete_data_frame_analytics" + "logstash.delete_pipeline" ], - "summary": "Deletes an existing data frame analytics job.", - "description": "Deletes an existing data frame analytics job.", + "summary": "Deletes Logstash Pipelines used by Central Management", + "description": "Deletes Logstash Pipelines used by Central Management", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html" }, - "operationId": "ml-delete-data-frame-analytics", + "operationId": "logstash-delete-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the data frame analytics job.", + "description": "Identifier for the pipeline.", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Id" }, "style": "simple" - }, - { - "in": "query", - "name": "force", - "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "timeout", - "description": "The time to wait for the job to be deleted.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" } ], "responses": { "200": { "description": "", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } + "application/json": {} } } } } }, - "/_ml/datafeeds/{datafeed_id}": { + "/_logstash/pipeline": { "get": { "tags": [ - "ml.get_datafeeds" + "logstash.get_pipeline" ], - "summary": "Retrieves configuration information for datafeeds.", - "description": "Retrieves configuration information for datafeeds.", + "summary": "Retrieves Logstash Pipelines used by Central Management", + "description": "Retrieves Logstash Pipelines used by Central Management", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html" }, - "operationId": "ml-get-datafeeds", + "operationId": "logstash-get-pipeline", + "responses": { + "200": { + "$ref": "#/components/responses/logstash.get_pipeline#200" + } + } + } + }, + "/_mget": { + "get": { + "tags": [ + "mget" + ], + "summary": "Allows to get multiple documents in one request.", + "description": "Allows to get multiple documents in one request.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + }, + "operationId": "mget", "parameters": [ { - "$ref": "#/components/parameters/ml.get_datafeeds#datafeed_id" + "$ref": "#/components/parameters/mget#preference" }, { - "$ref": "#/components/parameters/ml.get_datafeeds#allow_no_match" + "$ref": "#/components/parameters/mget#realtime" }, { - "$ref": "#/components/parameters/ml.get_datafeeds#exclude_generated" + "$ref": "#/components/parameters/mget#refresh" + }, + { + "$ref": "#/components/parameters/mget#routing" + }, + { + "$ref": "#/components/parameters/mget#_source" + }, + { + "$ref": "#/components/parameters/mget#_source_excludes" + }, + { + "$ref": "#/components/parameters/mget#_source_includes" + }, + { + "$ref": "#/components/parameters/mget#stored_fields" } ], + "requestBody": { + "$ref": "#/components/requestBodies/mget" + }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_datafeeds#200" + "$ref": "#/components/responses/mget#200" } } }, - "put": { + "post": { "tags": [ - "ml.put_datafeed" + "mget" ], - "summary": "Instantiates a datafeed.", - "description": "Instantiates a datafeed.", + "summary": "Allows to get multiple documents in one request.", + "description": "Allows to get multiple documents in one request.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" }, - "operationId": "ml-put-datafeed", + "operationId": "mget-1", "parameters": [ { - "in": "path", - "name": "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.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/mget#preference" }, { - "in": "query", - "name": "allow_no_indices", - "description": "If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`\nstring or when no indices are specified.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/mget#realtime" }, { - "in": "query", - "name": "expand_wildcards", - "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" - }, - "style": "form" + "$ref": "#/components/parameters/mget#refresh" }, { - "in": "query", - "name": "ignore_throttled", - "description": "If true, concrete, expanded, or aliased indices are ignored when frozen.", - "deprecated": true, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/mget#routing" }, { - "in": "query", - "name": "ignore_unavailable", - "description": "If true, unavailable indices (missing or closed) are ignored.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/mget#_source" + }, + { + "$ref": "#/components/parameters/mget#_source_excludes" + }, + { + "$ref": "#/components/parameters/mget#_source_includes" + }, + { + "$ref": "#/components/parameters/mget#stored_fields" } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "description": "If set, the datafeed performs aggregation searches.\nSupport for aggregations is limited and should be used only with low cardinality data.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" - } - }, - "chunking_config": { - "$ref": "#/components/schemas/ml._types:ChunkingConfig" - }, - "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" - }, - "frequency": { - "$ref": "#/components/schemas/_types:Duration" - }, - "indices": { - "$ref": "#/components/schemas/_types:Indices" - }, - "indices_options": { - "$ref": "#/components/schemas/_types:IndicesOptions" - }, - "job_id": { - "$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), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", - "type": "number" - }, - "query": { - "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" - }, - "query_delay": { - "$ref": "#/components/schemas/_types:Duration" - }, - "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping:RuntimeFields" - }, - "script_fields": { - "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe 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.\nThe maximum value is the value of `index.max_result_window`, which is 10,000 by default.", - "type": "number" - }, - "headers": { - "$ref": "#/components/schemas/_types:HttpHeaders" - } - } - } - } + "$ref": "#/components/requestBodies/mget" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mget#200" + } + } + } + }, + "/{index}/_mget": { + "get": { + "tags": [ + "mget" + ], + "summary": "Allows to get multiple documents in one request.", + "description": "Allows to get multiple documents in one request.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + }, + "operationId": "mget-2", + "parameters": [ + { + "$ref": "#/components/parameters/mget#index" }, - "required": true + { + "$ref": "#/components/parameters/mget#preference" + }, + { + "$ref": "#/components/parameters/mget#realtime" + }, + { + "$ref": "#/components/parameters/mget#refresh" + }, + { + "$ref": "#/components/parameters/mget#routing" + }, + { + "$ref": "#/components/parameters/mget#_source" + }, + { + "$ref": "#/components/parameters/mget#_source_excludes" + }, + { + "$ref": "#/components/parameters/mget#_source_includes" + }, + { + "$ref": "#/components/parameters/mget#stored_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mget" }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" - } - }, - "authorization": { - "$ref": "#/components/schemas/ml._types:DatafeedAuthorization" - }, - "chunking_config": { - "$ref": "#/components/schemas/ml._types:ChunkingConfig" - }, - "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" - }, - "datafeed_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "frequency": { - "$ref": "#/components/schemas/_types:Duration" - }, - "indices": { - "type": "array", - "items": { - "type": "string" - } - }, - "job_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "indices_options": { - "$ref": "#/components/schemas/_types:IndicesOptions" - }, - "max_empty_searches": { - "type": "number" - }, - "query": { - "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" - }, - "query_delay": { - "$ref": "#/components/schemas/_types:Duration" - }, - "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping:RuntimeFields" - }, - "script_fields": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/_types:ScriptField" - } - }, - "scroll_size": { - "type": "number" - } - }, - "required": [ - "chunking_config", - "datafeed_id", - "indices", - "job_id", - "query", - "query_delay", - "scroll_size" - ] - } - } - } + "$ref": "#/components/responses/mget#200" } } }, - "delete": { + "post": { "tags": [ - "ml.delete_datafeed" + "mget" ], - "summary": "Deletes an existing datafeed.", - "description": "Deletes an existing datafeed.", + "summary": "Allows to get multiple documents in one request.", + "description": "Allows to get multiple documents in one request.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" }, - "operationId": "ml-delete-datafeed", + "operationId": "mget-3", + "parameters": [ + { + "$ref": "#/components/parameters/mget#index" + }, + { + "$ref": "#/components/parameters/mget#preference" + }, + { + "$ref": "#/components/parameters/mget#realtime" + }, + { + "$ref": "#/components/parameters/mget#refresh" + }, + { + "$ref": "#/components/parameters/mget#routing" + }, + { + "$ref": "#/components/parameters/mget#_source" + }, + { + "$ref": "#/components/parameters/mget#_source_excludes" + }, + { + "$ref": "#/components/parameters/mget#_source_includes" + }, + { + "$ref": "#/components/parameters/mget#stored_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mget" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mget#200" + } + } + } + }, + "/_ml/anomaly_detectors/{job_id}/_close": { + "post": { + "tags": [ + "ml.close_job" + ], + "summary": "Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.", + "description": "Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html" + }, + "operationId": "ml-close-job", "parameters": [ { "in": "path", - "name": "datafeed_id", - "description": "A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It must start and end with alphanumeric\ncharacters.", + "name": "job_id", + "description": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", "required": true, "deprecated": false, "schema": { @@ -9422,24 +9680,74 @@ }, "style": "simple" }, + { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs 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" + }, { "in": "query", "name": "force", - "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", + "description": "Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.\nIf you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.", "deprecated": false, "schema": { "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the time to wait until a job has closed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_no_match": { + "description": "Refer to the description for the `allow_no_match` query parameter.", + "type": "boolean" + }, + "force": { + "description": "Refer to the descriptiion for the `force` query parameter.", + "type": "boolean" + }, + "timeout": { + "$ref": "#/components/schemas/_types:Duration" + } + } + } + } + } + }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + "type": "object", + "properties": { + "closed": { + "type": "boolean" + } + }, + "required": [ + "closed" + ] } } } @@ -9447,49 +9755,52 @@ } } }, - "/_ml/filters/{filter_id}": { + "/_ml/calendars/{calendar_id}": { "get": { "tags": [ - "ml.get_filters" + "ml.get_calendars" ], - "summary": "Retrieves filters.", - "description": "Retrieves filters.", + "summary": "Retrieves configuration information for calendars.", + "description": "Retrieves configuration information for calendars.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, - "operationId": "ml-get-filters-1", + "operationId": "ml-get-calendars-2", "parameters": [ { - "$ref": "#/components/parameters/ml.get_filters#filter_id" + "$ref": "#/components/parameters/ml.get_calendars#calendar_id" }, { - "$ref": "#/components/parameters/ml.get_filters#from" + "$ref": "#/components/parameters/ml.get_calendars#from" }, { - "$ref": "#/components/parameters/ml.get_filters#size" + "$ref": "#/components/parameters/ml.get_calendars#size" } ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_calendars" + }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_filters#200" + "$ref": "#/components/responses/ml.get_calendars#200" } } }, "put": { "tags": [ - "ml.put_filter" + "ml.put_calendar" ], - "summary": "Instantiates a filter.", - "description": "Instantiates a filter.", + "summary": "Instantiates a calendar.", + "description": "Instantiates a calendar.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html" }, - "operationId": "ml-put-filter", + "operationId": "ml-put-calendar", "parameters": [ { "in": "path", - "name": "filter_id", - "description": "A string that uniquely identifies a filter.", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", "required": true, "deprecated": false, "schema": { @@ -9504,22 +9815,21 @@ "schema": { "type": "object", "properties": { - "description": { - "description": "A description of the filter.", - "type": "string" - }, - "items": { - "description": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.", + "job_ids": { + "description": "An array of anomaly detection job identifiers.", "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/_types:Id" } + }, + "description": { + "description": "A description of the calendar.", + "type": "string" } } } } - }, - "required": true + } }, "responses": { "200": { @@ -9529,23 +9839,20 @@ "schema": { "type": "object", "properties": { + "calendar_id": { + "$ref": "#/components/schemas/_types:Id" + }, "description": { + "description": "A description of the calendar.", "type": "string" }, - "filter_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "items": { - "type": "array", - "items": { - "type": "string" - } + "job_ids": { + "$ref": "#/components/schemas/_types:Ids" } }, "required": [ - "description", - "filter_id", - "items" + "calendar_id", + "job_ids" ] } } @@ -9553,21 +9860,51 @@ } } }, + "post": { + "tags": [ + "ml.get_calendars" + ], + "summary": "Retrieves configuration information for calendars.", + "description": "Retrieves configuration information for calendars.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + }, + "operationId": "ml-get-calendars-3", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_calendars#calendar_id" + }, + { + "$ref": "#/components/parameters/ml.get_calendars#from" + }, + { + "$ref": "#/components/parameters/ml.get_calendars#size" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_calendars" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_calendars#200" + } + } + }, "delete": { "tags": [ - "ml.delete_filter" + "ml.delete_calendar" ], - "summary": "Deletes a filter.", - "description": "Deletes a filter.", + "summary": "Deletes a calendar.", + "description": "Deletes a calendar.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html" }, - "operationId": "ml-delete-filter", + "operationId": "ml-delete-calendar", "parameters": [ { "in": "path", - "name": "filter_id", - "description": "A string that uniquely identifies a filter.", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", "required": true, "deprecated": false, "schema": { @@ -9590,49 +9927,82 @@ } } }, - "/_ml/anomaly_detectors/{job_id}": { - "get": { + "/_ml/calendars/{calendar_id}/events/{event_id}": { + "delete": { "tags": [ - "ml.get_jobs" + "ml.delete_calendar_event" ], - "summary": "Retrieves configuration information for anomaly detection jobs.", - "description": "Retrieves configuration information for anomaly detection jobs.", + "summary": "Deletes scheduled events from a calendar.", + "description": "Deletes scheduled events from a calendar.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html" }, - "operationId": "ml-get-jobs", + "operationId": "ml-delete-calendar-event", "parameters": [ { - "$ref": "#/components/parameters/ml.get_jobs#job_id" - }, - { - "$ref": "#/components/parameters/ml.get_jobs#allow_no_match" + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/ml.get_jobs#exclude_generated" + "in": "path", + "name": "event_id", + "description": "Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_jobs#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } - }, + } + }, + "/_ml/calendars/{calendar_id}/jobs/{job_id}": { "put": { "tags": [ - "ml.put_job" + "ml.put_calendar_job" ], - "summary": "Instantiates an anomaly detection job.", - "description": "Instantiates an anomaly detection job.", + "summary": "Adds an anomaly detection job to a calendar.", + "description": "Adds an anomaly detection job to a calendar.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html" }, - "operationId": "ml-put-job", + "operationId": "ml-put-calendar-job", "parameters": [ { "in": "path", - "name": "job_id", - "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "job_id", + "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", "required": true, "deprecated": false, "schema": { @@ -9641,77 +10011,6 @@ "style": "simple" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "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. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", - "type": "boolean" - }, - "analysis_config": { - "$ref": "#/components/schemas/ml._types:AnalysisConfig" - }, - "analysis_limits": { - "$ref": "#/components/schemas/ml._types:AnalysisLimits" - }, - "background_persist_interval": { - "$ref": "#/components/schemas/_types:Duration" - }, - "custom_settings": { - "$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. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", - "type": "number" - }, - "data_description": { - "$ref": "#/components/schemas/ml._types:DataDescription" - }, - "datafeed_config": { - "$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" - } - }, - "model_plot_config": { - "$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. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", - "type": "number" - }, - "renormalization_window_days": { - "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", - "type": "number" - }, - "results_index_name": { - "$ref": "#/components/schemas/_types:IndexName" - }, - "results_retention_days": { - "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If 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. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", - "type": "number" - } - }, - "required": [ - "analysis_config", - "data_description" - ] - } - } - }, - "required": true - }, "responses": { "200": { "description": "", @@ -9720,82 +10019,20 @@ "schema": { "type": "object", "properties": { - "allow_lazy_open": { - "type": "boolean" - }, - "analysis_config": { - "$ref": "#/components/schemas/ml._types:AnalysisConfigRead" - }, - "analysis_limits": { - "$ref": "#/components/schemas/ml._types:AnalysisLimits" - }, - "background_persist_interval": { - "$ref": "#/components/schemas/_types:Duration" - }, - "create_time": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "custom_settings": { - "$ref": "#/components/schemas/ml._types:CustomSettings" - }, - "daily_model_snapshot_retention_after_days": { - "type": "number" - }, - "data_description": { - "$ref": "#/components/schemas/ml._types:DataDescription" - }, - "datafeed_config": { - "$ref": "#/components/schemas/ml._types:Datafeed" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string" - } - }, - "job_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "job_type": { - "type": "string" - }, - "job_version": { - "type": "string" - }, - "model_plot_config": { - "$ref": "#/components/schemas/ml._types:ModelPlotConfig" - }, - "model_snapshot_id": { + "calendar_id": { "$ref": "#/components/schemas/_types:Id" }, - "model_snapshot_retention_days": { - "type": "number" - }, - "renormalization_window_days": { - "type": "number" - }, - "results_index_name": { + "description": { + "description": "A description of the calendar.", "type": "string" }, - "results_retention_days": { - "type": "number" + "job_ids": { + "$ref": "#/components/schemas/_types:Ids" } }, "required": [ - "allow_lazy_open", - "analysis_config", - "analysis_limits", - "create_time", - "daily_model_snapshot_retention_after_days", - "data_description", - "job_id", - "job_type", - "job_version", - "model_snapshot_retention_days", - "results_index_name" + "calendar_id", + "job_ids" ] } } @@ -9805,19 +10042,19 @@ }, "delete": { "tags": [ - "ml.delete_job" + "ml.delete_calendar_job" ], - "summary": "Deletes an existing anomaly detection job.", - "description": "Deletes an existing anomaly detection job.", + "summary": "Deletes anomaly detection jobs from a calendar.", + "description": "Deletes anomaly detection jobs from a calendar.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html" }, - "operationId": "ml-delete-job", + "operationId": "ml-delete-calendar-job", "parameters": [ { "in": "path", - "name": "job_id", - "description": "Identifier for the anomaly detection job.", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", "required": true, "deprecated": false, "schema": { @@ -9826,34 +10063,15 @@ "style": "simple" }, { - "in": "query", - "name": "force", - "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "delete_user_annotations", - "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "wait_for_completion", - "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", + "in": "path", + "name": "job_id", + "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a\ncomma-separated list of jobs or groups.", + "required": true, "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Ids" }, - "style": "form" + "style": "simple" } ], "responses": { @@ -9862,7 +10080,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + "type": "object", + "properties": { + "calendar_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "description": { + "description": "A description of the calendar.", + "type": "string" + }, + "job_ids": { + "$ref": "#/components/schemas/_types:Ids" + } + }, + "required": [ + "calendar_id", + "job_ids" + ] } } } @@ -9870,90 +10104,61 @@ } } }, - "/_ml/trained_models/{model_id}": { + "/_ml/data_frame/analytics/{id}": { "get": { "tags": [ - "ml.get_trained_models" + "ml.get_data_frame_analytics" ], - "summary": "Retrieves configuration information for a trained inference model.", - "description": "Retrieves configuration information for a trained inference model.", + "summary": "Retrieves configuration information for data frame analytics jobs.", + "description": "Retrieves configuration information for data frame analytics jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" }, - "operationId": "ml-get-trained-models", + "operationId": "ml-get-data-frame-analytics", "parameters": [ { - "$ref": "#/components/parameters/ml.get_trained_models#model_id" - }, - { - "$ref": "#/components/parameters/ml.get_trained_models#allow_no_match" - }, - { - "$ref": "#/components/parameters/ml.get_trained_models#decompress_definition" - }, - { - "$ref": "#/components/parameters/ml.get_trained_models#exclude_generated" + "$ref": "#/components/parameters/ml.get_data_frame_analytics#id" }, { - "$ref": "#/components/parameters/ml.get_trained_models#from" + "$ref": "#/components/parameters/ml.get_data_frame_analytics#allow_no_match" }, { - "$ref": "#/components/parameters/ml.get_trained_models#include" + "$ref": "#/components/parameters/ml.get_data_frame_analytics#from" }, { - "$ref": "#/components/parameters/ml.get_trained_models#size" + "$ref": "#/components/parameters/ml.get_data_frame_analytics#size" }, { - "$ref": "#/components/parameters/ml.get_trained_models#tags" + "$ref": "#/components/parameters/ml.get_data_frame_analytics#exclude_generated" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_trained_models#200" + "$ref": "#/components/responses/ml.get_data_frame_analytics#200" } } }, "put": { "tags": [ - "ml.put_trained_model" + "ml.put_data_frame_analytics" ], - "summary": "Creates an inference trained model.", - "description": "Creates an inference trained model.", + "summary": "Instantiates a data frame analytics job.", + "description": "Instantiates a data frame analytics job.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html" }, - "operationId": "ml-put-trained-model", + "operationId": "ml-put-data-frame-analytics", "parameters": [ { "in": "path", - "name": "model_id", - "description": "The unique identifier of the trained model.", + "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" - }, - { - "in": "query", - "name": "defer_definition_decompression", - "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "wait_for_completion", - "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" } ], "requestBody": { @@ -9962,49 +10167,49 @@ "schema": { "type": "object", "properties": { - "compressed_definition": { - "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", - "type": "string" + "allow_lazy_start": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", + "type": "boolean" }, - "definition": { - "$ref": "#/components/schemas/ml.put_trained_model:Definition" + "analysis": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" + }, + "analyzed_fields": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" }, "description": { - "description": "A human-readable description of the inference trained model.", + "description": "A description of the job.", "type": "string" }, - "inference_config": { - "$ref": "#/components/schemas/ml._types:InferenceConfigCreateContainer" - }, - "input": { - "$ref": "#/components/schemas/ml.put_trained_model:Input" - }, - "metadata": { - "description": "An object map that contains metadata about the model.", - "type": "object" - }, - "model_type": { - "$ref": "#/components/schemas/ml._types:TrainedModelType" + "dest": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" }, - "model_size_bytes": { - "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", + "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.", "type": "number" }, - "platform_architecture": { - "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", + "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\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "type": "string" }, - "tags": { - "description": "An array of tags to organize the model.", - "type": "array", - "items": { - "type": "string" - } + "source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" }, - "prefix_strings": { - "$ref": "#/components/schemas/ml._types:TrainedModelPrefixStrings" + "headers": { + "$ref": "#/components/schemas/_types:HttpHeaders" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" } - } + }, + "required": [ + "analysis", + "dest", + "source" + ] } } }, @@ -10016,7 +10221,56 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ml._types:TrainedModelConfig" + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsAuthorization" + }, + "allow_lazy_start": { + "type": "boolean" + }, + "analysis": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" + }, + "analyzed_fields": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" + }, + "create_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "description": { + "type": "string" + }, + "dest": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_num_threads": { + "type": "number" + }, + "model_memory_limit": { + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "allow_lazy_start", + "analysis", + "create_time", + "dest", + "id", + "max_num_threads", + "model_memory_limit", + "source", + "version" + ] } } } @@ -10025,19 +10279,19 @@ }, "delete": { "tags": [ - "ml.delete_trained_model" + "ml.delete_data_frame_analytics" ], - "summary": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.", - "description": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.", + "summary": "Deletes an existing data frame analytics job.", + "description": "Deletes an existing data frame analytics job.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html" }, - "operationId": "ml-delete-trained-model", + "operationId": "ml-delete-data-frame-analytics", "parameters": [ { "in": "path", - "name": "model_id", - "description": "The unique identifier of the trained model.", + "name": "id", + "description": "Identifier for the data frame analytics job.", "required": true, "deprecated": false, "schema": { @@ -10048,12 +10302,22 @@ { "in": "query", "name": "force", - "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", + "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", "deprecated": false, "schema": { "type": "boolean" }, "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "The time to wait for the job to be deleted.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], "responses": { @@ -10070,79 +10334,49 @@ } } }, - "/_ml/trained_models/{model_id}/model_aliases/{model_alias}": { - "put": { + "/_ml/datafeeds/{datafeed_id}": { + "get": { "tags": [ - "ml.put_trained_model_alias" + "ml.get_datafeeds" ], - "summary": "Creates a new model alias (or reassigns an existing one) to refer to the trained model", - "description": "Creates a new model alias (or reassigns an existing one) to refer to the trained model", + "summary": "Retrieves configuration information for datafeeds.", + "description": "Retrieves configuration information for datafeeds.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" }, - "operationId": "ml-put-trained-model-alias", + "operationId": "ml-get-datafeeds", "parameters": [ { - "in": "path", - "name": "model_id", - "description": "The identifier for the trained model that the alias refers to.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ml.get_datafeeds#datafeed_id" }, { - "in": "path", - "name": "model_alias", - "description": "The alias to create or update. This value cannot end in numbers.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Name" - }, - "style": "simple" + "$ref": "#/components/parameters/ml.get_datafeeds#allow_no_match" }, { - "in": "query", - "name": "reassign", - "description": "Specifies whether the alias gets reassigned to the specified trained\nmodel if it is already assigned to a different model. If the alias is\nalready assigned and this parameter is false, the API returns an error.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_datafeeds#exclude_generated" } ], "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/ml.get_datafeeds#200" } } }, - "delete": { + "put": { "tags": [ - "ml.delete_trained_model_alias" + "ml.put_datafeed" ], - "summary": "Deletes a model alias that refers to the trained model", - "description": "Deletes a model alias that refers to the trained model", + "summary": "Instantiates a datafeed.", + "description": "Instantiates a datafeed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html" }, - "operationId": "ml-delete-trained-model-alias", + "operationId": "ml-put-datafeed", "parameters": [ { "in": "path", - "name": "model_id", - "description": "The trained model ID to which the model alias refers.", + "name": "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.", "required": true, "deprecated": false, "schema": { @@ -10151,124 +10385,105 @@ "style": "simple" }, { - "in": "path", - "name": "model_alias", - "description": "The model alias to delete.", - "required": true, + "in": "query", + "name": "allow_no_indices", + "description": "If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`\nstring or when no indices are specified.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Name" + "type": "boolean" }, - "style": "simple" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_throttled", + "description": "If true, concrete, expanded, or aliased indices are ignored when frozen.", + "deprecated": true, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If true, unavailable indices (missing or closed) are ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } - } - } - }, - "/_ml/anomaly_detectors/_estimate_model_memory": { - "post": { - "tags": [ - "ml.estimate_model_memory" ], - "summary": "Estimates the model memory", - "description": "Estimates the model memory", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html" - }, - "operationId": "ml-estimate-model-memory", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { - "analysis_config": { - "$ref": "#/components/schemas/ml._types:AnalysisConfig" - }, - "max_bucket_cardinality": { - "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", + "aggregations": { + "description": "If set, the datafeed performs aggregation searches.\nSupport for aggregations is limited and should be used only with low cardinality data.", "type": "object", "additionalProperties": { - "type": "number" + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" } }, - "overall_cardinality": { - "description": "Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.", - "type": "object", - "additionalProperties": { - "type": "number" - } - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "model_memory_estimate": { - "type": "string" - } + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" }, - "required": [ - "model_memory_estimate" - ] - } - } - } - } - } - } - }, - "/_ml/data_frame/_evaluate": { - "post": { - "tags": [ - "ml.evaluate_data_frame" - ], - "summary": "Evaluates the data frame analytics for an annotated index.", - "description": "Evaluates the data frame analytics for an annotated index.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html" - }, - "operationId": "ml-evaluate-data-frame", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "evaluation": { - "$ref": "#/components/schemas/ml._types:DataframeEvaluationContainer" + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" }, - "index": { - "$ref": "#/components/schemas/_types:IndexName" + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "job_id": { + "$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), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", + "type": "number" }, "query": { "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "script_fields": { + "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe 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.\nThe maximum value is the value of `index.max_result_window`, which is 10,000 by default.", + "type": "number" + }, + "headers": { + "$ref": "#/components/schemas/_types:HttpHeaders" } - }, - "required": [ - "evaluation", - "index" - ] + } } } }, @@ -10282,39 +10497,91 @@ "schema": { "type": "object", "properties": { - "classification": { - "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeClassificationSummary" + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } }, - "outlier_detection": { - "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeOutlierDetectionSummary" + "authorization": { + "$ref": "#/components/schemas/ml._types:DatafeedAuthorization" }, - "regression": { - "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeRegressionSummary" + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "datafeed_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "max_empty_searches": { + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "script_fields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "scroll_size": { + "type": "number" } - } + }, + "required": [ + "chunking_config", + "datafeed_id", + "indices", + "job_id", + "query", + "query_delay", + "scroll_size" + ] } } } } } - } - }, - "/_ml/anomaly_detectors/{job_id}/_flush": { - "post": { + }, + "delete": { "tags": [ - "ml.flush_job" + "ml.delete_datafeed" ], - "summary": "Forces any buffered data to be processed by the job.", - "description": "Forces any buffered data to be processed by the job.", + "summary": "Deletes an existing datafeed.", + "description": "Deletes an existing datafeed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html" }, - "operationId": "ml-flush-job", + "operationId": "ml-delete-datafeed", "parameters": [ { "in": "path", - "name": "job_id", - "description": "Identifier for the anomaly detection job.", + "name": "datafeed_id", + "description": "A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It must start and end with alphanumeric\ncharacters.", "required": true, "deprecated": false, "schema": { @@ -10324,101 +10591,22 @@ }, { "in": "query", - "name": "advance_time", - "description": "Specifies to advance to a particular time value. Results are generated\nand the model is updated for data from the specified time interval.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "style": "form" - }, - { - "in": "query", - "name": "calc_interim", - "description": "If true, calculates the interim results for the most recent bucket or all\nbuckets within the latency period.", + "name": "force", + "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", "deprecated": false, "schema": { "type": "boolean" }, "style": "form" - }, - { - "in": "query", - "name": "end", - "description": "When used in conjunction with `calc_interim` and `start`, specifies the\nrange of buckets on which to calculate interim results.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "style": "form" - }, - { - "in": "query", - "name": "skip_time", - "description": "Specifies to skip to a particular time value. Results are not generated\nand the model is not updated for data from the specified time interval.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "style": "form" - }, - { - "in": "query", - "name": "start", - "description": "When used in conjunction with `calc_interim`, specifies the range of\nbuckets on which to calculate interim results.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "advance_time": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "calc_interim": { - "description": "Refer to the description for the `calc_interim` query parameter.", - "type": "boolean" - }, - "end": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "skip_time": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "start": { - "$ref": "#/components/schemas/_types:DateTime" - } - } - } - } - } - }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "flushed": { - "type": "boolean" - }, - "last_finalized_bucket_end": { - "description": "Provides the timestamp (in milliseconds since the epoch) of the end of\nthe last bucket that was processed.", - "type": "number" - } - }, - "required": [ - "flushed" - ] + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" } } } @@ -10426,123 +10614,49 @@ } } }, - "/_ml/calendars/{calendar_id}/events": { + "/_ml/filters/{filter_id}": { "get": { "tags": [ - "ml.get_calendar_events" + "ml.get_filters" ], - "summary": "Retrieves information about the scheduled events in calendars.", - "description": "Retrieves information about the scheduled events in calendars.", + "summary": "Retrieves filters.", + "description": "Retrieves filters.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" }, - "operationId": "ml-get-calendar-events", + "operationId": "ml-get-filters-1", "parameters": [ { - "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" - }, - { - "in": "query", - "name": "end", - "description": "Specifies to get events with timestamps earlier than this time.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "style": "form" - }, - { - "in": "query", - "name": "from", - "description": "Skips the specified number of events.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" - }, - { - "in": "query", - "name": "job_id", - "description": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_filters#filter_id" }, { - "in": "query", - "name": "size", - "description": "Specifies the maximum number of events to obtain.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_filters#from" }, { - "in": "query", - "name": "start", - "description": "Specifies to get events with timestamps after this time.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_filters#size" } ], "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "number" - }, - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ml._types:CalendarEvent" - } - } - }, - "required": [ - "count", - "events" - ] - } - } - } + "$ref": "#/components/responses/ml.get_filters#200" } } }, - "post": { + "put": { "tags": [ - "ml.post_calendar_events" + "ml.put_filter" ], - "summary": "Posts scheduled events in a calendar.", - "description": "Posts scheduled events in a calendar.", + "summary": "Instantiates a filter.", + "description": "Instantiates a filter.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html" }, - "operationId": "ml-post-calendar-events", + "operationId": "ml-put-filter", "parameters": [ { "in": "path", - "name": "calendar_id", - "description": "A string that uniquely identifies a calendar.", + "name": "filter_id", + "description": "A string that uniquely identifies a filter.", "required": true, "deprecated": false, "schema": { @@ -10557,17 +10671,18 @@ "schema": { "type": "object", "properties": { - "events": { - "description": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", + "description": { + "description": "A description of the filter.", + "type": "string" + }, + "items": { + "description": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.", "type": "array", "items": { - "$ref": "#/components/schemas/ml._types:CalendarEvent" + "type": "string" } } - }, - "required": [ - "events" - ] + } } } }, @@ -10581,1391 +10696,1674 @@ "schema": { "type": "object", "properties": { - "events": { + "description": { + "type": "string" + }, + "filter_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/ml._types:CalendarEvent" + "type": "string" } } }, "required": [ - "events" + "description", + "filter_id", + "items" ] } } } } } - } - }, - "/_ml/calendars": { - "get": { + }, + "delete": { "tags": [ - "ml.get_calendars" + "ml.delete_filter" ], - "summary": "Retrieves configuration information for calendars.", - "description": "Retrieves configuration information for calendars.", + "summary": "Deletes a filter.", + "description": "Deletes a filter.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html" }, - "operationId": "ml-get-calendars", + "operationId": "ml-delete-filter", "parameters": [ { - "$ref": "#/components/parameters/ml.get_calendars#from" - }, - { - "$ref": "#/components/parameters/ml.get_calendars#size" + "in": "path", + "name": "filter_id", + "description": "A string that uniquely identifies a filter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.get_calendars" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_calendars#200" - } - } - }, - "post": { - "tags": [ - "ml.get_calendars" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + } + } + }, + "/_ml/anomaly_detectors/{job_id}": { + "get": { + "tags": [ + "ml.get_jobs" ], - "summary": "Retrieves configuration information for calendars.", - "description": "Retrieves configuration information for calendars.", + "summary": "Retrieves configuration information for anomaly detection jobs.", + "description": "Retrieves configuration information for anomaly detection jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" }, - "operationId": "ml-get-calendars-1", + "operationId": "ml-get-jobs", "parameters": [ { - "$ref": "#/components/parameters/ml.get_calendars#from" + "$ref": "#/components/parameters/ml.get_jobs#job_id" }, { - "$ref": "#/components/parameters/ml.get_calendars#size" + "$ref": "#/components/parameters/ml.get_jobs#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_jobs#exclude_generated" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.get_calendars" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_calendars#200" + "$ref": "#/components/responses/ml.get_jobs#200" } } - } - }, - "/_ml/data_frame/analytics": { - "get": { + }, + "put": { "tags": [ - "ml.get_data_frame_analytics" + "ml.put_job" ], - "summary": "Retrieves configuration information for data frame analytics jobs.", - "description": "Retrieves configuration information for data frame analytics jobs.", + "summary": "Instantiates an anomaly detection job.", + "description": "Instantiates an anomaly detection job.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html" }, - "operationId": "ml-get-data-frame-analytics-1", + "operationId": "ml-put-job", "parameters": [ { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#allow_no_match" - }, - { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#from" - }, - { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#size" - }, - { - "$ref": "#/components/parameters/ml.get_data_frame_analytics#exclude_generated" + "in": "path", + "name": "job_id", + "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "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. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", + "type": "boolean" + }, + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfig" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisLimits" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "custom_settings": { + "$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. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", + "type": "number" + }, + "data_description": { + "$ref": "#/components/schemas/ml._types:DataDescription" + }, + "datafeed_config": { + "$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" + } + }, + "model_plot_config": { + "$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. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", + "type": "number" + }, + "renormalization_window_days": { + "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", + "type": "number" + }, + "results_index_name": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "results_retention_days": { + "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If 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. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", + "type": "number" + } + }, + "required": [ + "analysis_config", + "data_description" + ] + } + } + }, + "required": true + }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_data_frame_analytics#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_lazy_open": { + "type": "boolean" + }, + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfigRead" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisLimits" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "create_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "custom_settings": { + "$ref": "#/components/schemas/ml._types:CustomSettings" + }, + "daily_model_snapshot_retention_after_days": { + "type": "number" + }, + "data_description": { + "$ref": "#/components/schemas/ml._types:DataDescription" + }, + "datafeed_config": { + "$ref": "#/components/schemas/ml._types:Datafeed" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "job_type": { + "type": "string" + }, + "job_version": { + "type": "string" + }, + "model_plot_config": { + "$ref": "#/components/schemas/ml._types:ModelPlotConfig" + }, + "model_snapshot_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "model_snapshot_retention_days": { + "type": "number" + }, + "renormalization_window_days": { + "type": "number" + }, + "results_index_name": { + "type": "string" + }, + "results_retention_days": { + "type": "number" + } + }, + "required": [ + "allow_lazy_open", + "analysis_config", + "analysis_limits", + "create_time", + "daily_model_snapshot_retention_after_days", + "data_description", + "job_id", + "job_type", + "job_version", + "model_snapshot_retention_days", + "results_index_name" + ] + } + } + } } } - } - }, - "/_ml/data_frame/analytics/_stats": { - "get": { + }, + "delete": { "tags": [ - "ml.get_data_frame_analytics_stats" + "ml.delete_job" ], - "summary": "Retrieves usage information for data frame analytics jobs.", - "description": "Retrieves usage information for data frame analytics jobs.", + "summary": "Deletes an existing anomaly detection job.", + "description": "Deletes an existing anomaly detection job.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html" }, - "operationId": "ml-get-data-frame-analytics-stats", + "operationId": "ml-delete-job", "parameters": [ { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#allow_no_match" + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#from" + "in": "query", + "name": "force", + "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#size" + "in": "query", + "name": "delete_user_annotations", + "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#verbose" + "in": "query", + "name": "wait_for_completion", + "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_data_frame_analytics_stats#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } } }, - "/_ml/data_frame/analytics/{id}/_stats": { + "/_ml/trained_models/{model_id}": { "get": { "tags": [ - "ml.get_data_frame_analytics_stats" + "ml.get_trained_models" ], - "summary": "Retrieves usage information for data frame analytics jobs.", - "description": "Retrieves usage information for data frame analytics jobs.", + "summary": "Retrieves configuration information for a trained inference model.", + "description": "Retrieves configuration information for a trained inference model.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" }, - "operationId": "ml-get-data-frame-analytics-stats-1", + "operationId": "ml-get-trained-models", "parameters": [ { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#id" + "$ref": "#/components/parameters/ml.get_trained_models#model_id" }, { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#allow_no_match" + "$ref": "#/components/parameters/ml.get_trained_models#allow_no_match" }, { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#from" + "$ref": "#/components/parameters/ml.get_trained_models#decompress_definition" }, { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#size" + "$ref": "#/components/parameters/ml.get_trained_models#exclude_generated" }, { - "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#verbose" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/ml.get_data_frame_analytics_stats#200" - } - } - } - }, - "/_ml/datafeeds/{datafeed_id}/_stats": { - "get": { - "tags": [ - "ml.get_datafeed_stats" - ], - "summary": "Retrieves usage information for datafeeds.", - "description": "Retrieves usage information for datafeeds.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" - }, - "operationId": "ml-get-datafeed-stats", - "parameters": [ + "$ref": "#/components/parameters/ml.get_trained_models#from" + }, { - "$ref": "#/components/parameters/ml.get_datafeed_stats#datafeed_id" + "$ref": "#/components/parameters/ml.get_trained_models#include" }, { - "$ref": "#/components/parameters/ml.get_datafeed_stats#allow_no_match" + "$ref": "#/components/parameters/ml.get_trained_models#size" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#tags" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_datafeed_stats#200" + "$ref": "#/components/responses/ml.get_trained_models#200" } } - } - }, - "/_ml/datafeeds/_stats": { - "get": { + }, + "put": { "tags": [ - "ml.get_datafeed_stats" + "ml.put_trained_model" ], - "summary": "Retrieves usage information for datafeeds.", - "description": "Retrieves usage information for datafeeds.", + "summary": "Creates an inference trained model.", + "description": "Creates an inference trained model.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html" }, - "operationId": "ml-get-datafeed-stats-1", + "operationId": "ml-put-trained-model", "parameters": [ { - "$ref": "#/components/parameters/ml.get_datafeed_stats#allow_no_match" + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "defer_definition_decompression", + "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "compressed_definition": { + "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", + "type": "string" + }, + "definition": { + "$ref": "#/components/schemas/ml.put_trained_model:Definition" + }, + "description": { + "description": "A human-readable description of the inference trained model.", + "type": "string" + }, + "inference_config": { + "$ref": "#/components/schemas/ml._types:InferenceConfigCreateContainer" + }, + "input": { + "$ref": "#/components/schemas/ml.put_trained_model:Input" + }, + "metadata": { + "description": "An object map that contains metadata about the model.", + "type": "object" + }, + "model_type": { + "$ref": "#/components/schemas/ml._types:TrainedModelType" + }, + "model_size_bytes": { + "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", + "type": "number" + }, + "platform_architecture": { + "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", + "type": "string" + }, + "tags": { + "description": "An array of tags to organize the model.", + "type": "array", + "items": { + "type": "string" + } + }, + "prefix_strings": { + "$ref": "#/components/schemas/ml._types:TrainedModelPrefixStrings" + } + } + } + } + }, + "required": true + }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_datafeed_stats#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ml._types:TrainedModelConfig" + } + } + } } } - } - }, - "/_ml/datafeeds": { - "get": { + }, + "delete": { "tags": [ - "ml.get_datafeeds" + "ml.delete_trained_model" ], - "summary": "Retrieves configuration information for datafeeds.", - "description": "Retrieves configuration information for datafeeds.", + "summary": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.", + "description": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html" }, - "operationId": "ml-get-datafeeds-1", + "operationId": "ml-delete-trained-model", "parameters": [ { - "$ref": "#/components/parameters/ml.get_datafeeds#allow_no_match" + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/ml.get_datafeeds#exclude_generated" + "in": "query", + "name": "force", + "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_datafeeds#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } } }, - "/_ml/filters": { - "get": { + "/_ml/trained_models/{model_id}/model_aliases/{model_alias}": { + "put": { "tags": [ - "ml.get_filters" + "ml.put_trained_model_alias" ], - "summary": "Retrieves filters.", - "description": "Retrieves filters.", + "summary": "Creates a new model alias (or reassigns an existing one) to refer to the trained model", + "description": "Creates a new model alias (or reassigns an existing one) to refer to the trained model", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html" }, - "operationId": "ml-get-filters", + "operationId": "ml-put-trained-model-alias", "parameters": [ { - "$ref": "#/components/parameters/ml.get_filters#from" + "in": "path", + "name": "model_id", + "description": "The identifier for the trained model that the alias refers to.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/ml.get_filters#size" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/ml.get_filters#200" - } - } - } - }, - "/_ml/anomaly_detectors/_stats": { - "get": { - "tags": [ - "ml.get_job_stats" - ], - "summary": "Retrieves usage information for anomaly detection jobs.", - "description": "Retrieves usage information for anomaly detection jobs.", - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" - }, - "operationId": "ml-get-job-stats", - "parameters": [ + "in": "path", + "name": "model_alias", + "description": "The alias to create or update. This value cannot end in numbers.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, { - "$ref": "#/components/parameters/ml.get_job_stats#allow_no_match" + "in": "query", + "name": "reassign", + "description": "Specifies whether the alias gets reassigned to the specified trained\nmodel if it is already assigned to a different model. If the alias is\nalready assigned and this parameter is false, the API returns an error.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_job_stats#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } - } - }, - "/_ml/anomaly_detectors/{job_id}/_stats": { - "get": { + }, + "delete": { "tags": [ - "ml.get_job_stats" + "ml.delete_trained_model_alias" ], - "summary": "Retrieves usage information for anomaly detection jobs.", - "description": "Retrieves usage information for anomaly detection jobs.", + "summary": "Deletes a model alias that refers to the trained model", + "description": "Deletes a model alias that refers to the trained model", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html" }, - "operationId": "ml-get-job-stats-1", + "operationId": "ml-delete-trained-model-alias", "parameters": [ { - "$ref": "#/components/parameters/ml.get_job_stats#job_id" + "in": "path", + "name": "model_id", + "description": "The trained model ID to which the model alias refers.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/ml.get_job_stats#allow_no_match" + "in": "path", + "name": "model_alias", + "description": "The model alias to delete.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_job_stats#200" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } } } } }, - "/_ml/anomaly_detectors": { - "get": { + "/_ml/anomaly_detectors/_estimate_model_memory": { + "post": { "tags": [ - "ml.get_jobs" + "ml.estimate_model_memory" ], - "summary": "Retrieves configuration information for anomaly detection jobs.", - "description": "Retrieves configuration information for anomaly detection jobs.", + "summary": "Estimates the model memory", + "description": "Estimates the model memory", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html" }, - "operationId": "ml-get-jobs-1", - "parameters": [ - { - "$ref": "#/components/parameters/ml.get_jobs#allow_no_match" + "operationId": "ml-estimate-model-memory", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfig" + }, + "max_bucket_cardinality": { + "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "overall_cardinality": { + "description": "Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.", + "type": "object", + "additionalProperties": { + "type": "number" + } + } + } + } + } }, - { - "$ref": "#/components/parameters/ml.get_jobs#exclude_generated" - } - ], + "required": true + }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_jobs#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "model_memory_estimate": { + "type": "string" + } + }, + "required": [ + "model_memory_estimate" + ] + } + } + } } } } }, - "/_ml/anomaly_detectors/{job_id}/results/overall_buckets": { - "get": { + "/_ml/data_frame/_evaluate": { + "post": { "tags": [ - "ml.get_overall_buckets" + "ml.evaluate_data_frame" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", - "description": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", + "summary": "Evaluates the data frame analytics for an annotated index.", + "description": "Evaluates the data frame analytics for an annotated index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html" }, - "operationId": "ml-get-overall-buckets", - "parameters": [ - { - "$ref": "#/components/parameters/ml.get_overall_buckets#job_id" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#allow_no_match" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#bucket_span" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#end" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#exclude_interim" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#overall_score" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#start" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#top_n" - } - ], + "operationId": "ml-evaluate-data-frame", "requestBody": { - "$ref": "#/components/requestBodies/ml.get_overall_buckets" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "evaluation": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationContainer" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "evaluation", + "index" + ] + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_overall_buckets#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "classification": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeClassificationSummary" + }, + "outlier_detection": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeOutlierDetectionSummary" + }, + "regression": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeRegressionSummary" + } + } + } + } + } } } - }, + } + }, + "/_ml/anomaly_detectors/{job_id}/_flush": { "post": { "tags": [ - "ml.get_overall_buckets" + "ml.flush_job" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", - "description": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", + "summary": "Forces any buffered data to be processed by the job.", + "description": "Forces any buffered data to be processed by the job.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html" }, - "operationId": "ml-get-overall-buckets-1", + "operationId": "ml-flush-job", "parameters": [ { - "$ref": "#/components/parameters/ml.get_overall_buckets#job_id" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#allow_no_match" - }, - { - "$ref": "#/components/parameters/ml.get_overall_buckets#bucket_span" + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/ml.get_overall_buckets#end" + "in": "query", + "name": "advance_time", + "description": "Specifies to advance to a particular time value. Results are generated\nand the model is updated for data from the specified time interval.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_overall_buckets#exclude_interim" + "in": "query", + "name": "calc_interim", + "description": "If true, calculates the interim results for the most recent bucket or all\nbuckets within the latency period.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_overall_buckets#overall_score" + "in": "query", + "name": "end", + "description": "When used in conjunction with `calc_interim` and `start`, specifies the\nrange of buckets on which to calculate interim results.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_overall_buckets#start" + "in": "query", + "name": "skip_time", + "description": "Specifies to skip to a particular time value. Results are not generated\nand the model is not updated for data from the specified time interval.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_overall_buckets#top_n" + "in": "query", + "name": "start", + "description": "When used in conjunction with `calc_interim`, specifies the range of\nbuckets on which to calculate interim results.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" } ], "requestBody": { - "$ref": "#/components/requestBodies/ml.get_overall_buckets" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "advance_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "calc_interim": { + "description": "Refer to the description for the `calc_interim` query parameter.", + "type": "boolean" + }, + "end": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "skip_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "start": { + "$ref": "#/components/schemas/_types:DateTime" + } + } + } + } + } }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_overall_buckets#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "flushed": { + "type": "boolean" + }, + "last_finalized_bucket_end": { + "description": "Provides the timestamp (in milliseconds since the epoch) of the end of\nthe last bucket that was processed.", + "type": "number" + } + }, + "required": [ + "flushed" + ] + } + } + } } } } }, - "/_ml/trained_models": { + "/_ml/calendars/{calendar_id}/events": { "get": { "tags": [ - "ml.get_trained_models" + "ml.get_calendar_events" ], - "summary": "Retrieves configuration information for a trained inference model.", - "description": "Retrieves configuration information for a trained inference model.", + "summary": "Retrieves information about the scheduled events in calendars.", + "description": "Retrieves information about the scheduled events in calendars.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html" }, - "operationId": "ml-get-trained-models-1", + "operationId": "ml-get-calendar-events", "parameters": [ { - "$ref": "#/components/parameters/ml.get_trained_models#allow_no_match" - }, - { - "$ref": "#/components/parameters/ml.get_trained_models#decompress_definition" + "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" }, { - "$ref": "#/components/parameters/ml.get_trained_models#exclude_generated" + "in": "query", + "name": "end", + "description": "Specifies to get events with timestamps earlier than this time.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_trained_models#from" + "in": "query", + "name": "from", + "description": "Skips the specified number of events.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_trained_models#include" + "in": "query", + "name": "job_id", + "description": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_trained_models#size" + "in": "query", + "name": "size", + "description": "Specifies the maximum number of events to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" }, { - "$ref": "#/components/parameters/ml.get_trained_models#tags" + "in": "query", + "name": "start", + "description": "Specifies to get events with timestamps after this time.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" } ], "responses": { "200": { - "$ref": "#/components/responses/ml.get_trained_models#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:CalendarEvent" + } + } + }, + "required": [ + "count", + "events" + ] + } + } + } } } - } - }, - "/_ml/trained_models/{model_id}/_stats": { - "get": { + }, + "post": { "tags": [ - "ml.get_trained_models_stats" + "ml.post_calendar_events" ], - "summary": "Retrieves usage information for trained inference models.", - "description": "Retrieves usage information for trained inference models.", + "summary": "Posts scheduled events in a calendar.", + "description": "Posts scheduled events in a calendar.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html" }, - "operationId": "ml-get-trained-models-stats", + "operationId": "ml-post-calendar-events", "parameters": [ { - "$ref": "#/components/parameters/ml.get_trained_models_stats#model_id" - }, - { - "$ref": "#/components/parameters/ml.get_trained_models_stats#allow_no_match" - }, - { - "$ref": "#/components/parameters/ml.get_trained_models_stats#from" - }, - { - "$ref": "#/components/parameters/ml.get_trained_models_stats#size" + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" } ], - "responses": { - "200": { - "$ref": "#/components/responses/ml.get_trained_models_stats#200" - } - } - } - }, - "/_ml/trained_models/_stats": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "events": { + "description": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:CalendarEvent" + } + } + }, + "required": [ + "events" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:CalendarEvent" + } + } + }, + "required": [ + "events" + ] + } + } + } + } + } + } + }, + "/_ml/calendars": { "get": { "tags": [ - "ml.get_trained_models_stats" + "ml.get_calendars" ], - "summary": "Retrieves usage information for trained inference models.", - "description": "Retrieves usage information for trained inference models.", + "summary": "Retrieves configuration information for calendars.", + "description": "Retrieves configuration information for calendars.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, - "operationId": "ml-get-trained-models-stats-1", + "operationId": "ml-get-calendars", "parameters": [ { - "$ref": "#/components/parameters/ml.get_trained_models_stats#allow_no_match" - }, - { - "$ref": "#/components/parameters/ml.get_trained_models_stats#from" + "$ref": "#/components/parameters/ml.get_calendars#from" }, { - "$ref": "#/components/parameters/ml.get_trained_models_stats#size" + "$ref": "#/components/parameters/ml.get_calendars#size" } ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_calendars" + }, "responses": { "200": { - "$ref": "#/components/responses/ml.get_trained_models_stats#200" + "$ref": "#/components/responses/ml.get_calendars#200" } } - } - }, - "/_ml/trained_models/{model_id}/_infer": { + }, "post": { "tags": [ - "ml.infer_trained_model" + "ml.get_calendars" ], - "summary": "Evaluate a trained model.", - "description": "Evaluate a trained model.", + "summary": "Retrieves configuration information for calendars.", + "description": "Retrieves configuration information for calendars.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, - "operationId": "ml-infer-trained-model", + "operationId": "ml-get-calendars-1", "parameters": [ { - "$ref": "#/components/parameters/ml.infer_trained_model#model_id" + "$ref": "#/components/parameters/ml.get_calendars#from" }, { - "$ref": "#/components/parameters/ml.infer_trained_model#timeout" + "$ref": "#/components/parameters/ml.get_calendars#size" } ], "requestBody": { - "$ref": "#/components/requestBodies/ml.infer_trained_model" + "$ref": "#/components/requestBodies/ml.get_calendars" }, "responses": { "200": { - "$ref": "#/components/responses/ml.infer_trained_model#200" + "$ref": "#/components/responses/ml.get_calendars#200" } } } }, - "/_ml/trained_models/{model_id}/deployment/_infer": { - "post": { + "/_ml/data_frame/analytics": { + "get": { "tags": [ - "ml.infer_trained_model" + "ml.get_data_frame_analytics" ], - "summary": "Evaluate a trained model.", - "description": "Evaluate a trained model.", + "summary": "Retrieves configuration information for data frame analytics jobs.", + "description": "Retrieves configuration information for data frame analytics jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" }, - "operationId": "ml-infer-trained-model-1", + "operationId": "ml-get-data-frame-analytics-1", "parameters": [ { - "$ref": "#/components/parameters/ml.infer_trained_model#model_id" + "$ref": "#/components/parameters/ml.get_data_frame_analytics#allow_no_match" }, { - "$ref": "#/components/parameters/ml.infer_trained_model#timeout" + "$ref": "#/components/parameters/ml.get_data_frame_analytics#from" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#size" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#exclude_generated" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.infer_trained_model" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.infer_trained_model#200" + "$ref": "#/components/responses/ml.get_data_frame_analytics#200" } } } }, - "/_ml/anomaly_detectors/{job_id}/_open": { - "post": { + "/_ml/data_frame/analytics/_stats": { + "get": { "tags": [ - "ml.open_job" + "ml.get_data_frame_analytics_stats" ], - "summary": "Opens one or more anomaly detection jobs.", - "description": "Opens one or more anomaly detection jobs.", + "summary": "Retrieves usage information for data frame analytics jobs.", + "description": "Retrieves usage information for data frame analytics jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" }, - "operationId": "ml-open-job", + "operationId": "ml-get-data-frame-analytics-stats", "parameters": [ { - "in": "path", - "name": "job_id", - "description": "Identifier for the anomaly detection job.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#allow_no_match" }, { - "in": "query", - "name": "timeout", - "description": "Controls the time to wait until a job has opened.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#from" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#size" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#verbose" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "timeout": { - "$ref": "#/components/schemas/_types:Duration" - } - } - } - } - } - }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "opened": { - "type": "boolean" - }, - "node": { - "$ref": "#/components/schemas/_types:NodeId" - } - }, - "required": [ - "opened", - "node" - ] - } - } - } + "$ref": "#/components/responses/ml.get_data_frame_analytics_stats#200" } } } }, - "/_ml/data_frame/analytics/_preview": { + "/_ml/data_frame/analytics/{id}/_stats": { "get": { "tags": [ - "ml.preview_data_frame_analytics" + "ml.get_data_frame_analytics_stats" ], - "summary": "Previews that will be analyzed given a data frame analytics config.", - "description": "Previews that will be analyzed given a data frame analytics config.", + "summary": "Retrieves usage information for data frame analytics jobs.", + "description": "Retrieves usage information for data frame analytics jobs.", "externalDocs": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" - }, - "operationId": "ml-preview-data-frame-analytics", - "requestBody": { - "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" }, + "operationId": "ml-get-data-frame-analytics-stats-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#id" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#from" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#size" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#verbose" + } + ], "responses": { "200": { - "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + "$ref": "#/components/responses/ml.get_data_frame_analytics_stats#200" } } - }, - "post": { + } + }, + "/_ml/datafeeds/{datafeed_id}/_stats": { + "get": { "tags": [ - "ml.preview_data_frame_analytics" + "ml.get_datafeed_stats" ], - "summary": "Previews that will be analyzed given a data frame analytics config.", - "description": "Previews that will be analyzed given a data frame analytics config.", + "summary": "Retrieves usage information for datafeeds.", + "description": "Retrieves usage information for datafeeds.", "externalDocs": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" - }, - "operationId": "ml-preview-data-frame-analytics-1", - "requestBody": { - "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" }, + "operationId": "ml-get-datafeed-stats", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_datafeed_stats#datafeed_id" + }, + { + "$ref": "#/components/parameters/ml.get_datafeed_stats#allow_no_match" + } + ], "responses": { "200": { - "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + "$ref": "#/components/responses/ml.get_datafeed_stats#200" } } } }, - "/_ml/data_frame/analytics/{id}/_preview": { + "/_ml/datafeeds/_stats": { "get": { "tags": [ - "ml.preview_data_frame_analytics" + "ml.get_datafeed_stats" ], - "summary": "Previews that will be analyzed given a data frame analytics config.", - "description": "Previews that will be analyzed given a data frame analytics config.", + "summary": "Retrieves usage information for datafeeds.", + "description": "Retrieves usage information for datafeeds.", "externalDocs": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" }, - "operationId": "ml-preview-data-frame-analytics-2", + "operationId": "ml-get-datafeed-stats-1", "parameters": [ { - "$ref": "#/components/parameters/ml.preview_data_frame_analytics#id" + "$ref": "#/components/parameters/ml.get_datafeed_stats#allow_no_match" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + "$ref": "#/components/responses/ml.get_datafeed_stats#200" } } - }, - "post": { + } + }, + "/_ml/datafeeds": { + "get": { "tags": [ - "ml.preview_data_frame_analytics" + "ml.get_datafeeds" ], - "summary": "Previews that will be analyzed given a data frame analytics config.", - "description": "Previews that will be analyzed given a data frame analytics config.", + "summary": "Retrieves configuration information for datafeeds.", + "description": "Retrieves configuration information for datafeeds.", "externalDocs": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" }, - "operationId": "ml-preview-data-frame-analytics-3", + "operationId": "ml-get-datafeeds-1", "parameters": [ { - "$ref": "#/components/parameters/ml.preview_data_frame_analytics#id" + "$ref": "#/components/parameters/ml.get_datafeeds#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_datafeeds#exclude_generated" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + "$ref": "#/components/responses/ml.get_datafeeds#200" } } } }, - "/_ml/datafeeds/{datafeed_id}/_preview": { + "/_ml/filters": { "get": { "tags": [ - "ml.preview_datafeed" + "ml.get_filters" ], - "summary": "Previews a datafeed.", - "description": "Previews a datafeed.", + "summary": "Retrieves filters.", + "description": "Retrieves filters.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" }, - "operationId": "ml-preview-datafeed", + "operationId": "ml-get-filters", "parameters": [ { - "$ref": "#/components/parameters/ml.preview_datafeed#datafeed_id" - }, - { - "$ref": "#/components/parameters/ml.preview_datafeed#start" + "$ref": "#/components/parameters/ml.get_filters#from" }, { - "$ref": "#/components/parameters/ml.preview_datafeed#end" + "$ref": "#/components/parameters/ml.get_filters#size" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.preview_datafeed" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.preview_datafeed#200" + "$ref": "#/components/responses/ml.get_filters#200" } } - }, - "post": { + } + }, + "/_ml/anomaly_detectors/_stats": { + "get": { "tags": [ - "ml.preview_datafeed" + "ml.get_job_stats" ], - "summary": "Previews a datafeed.", - "description": "Previews a datafeed.", + "summary": "Retrieves usage information for anomaly detection jobs.", + "description": "Retrieves usage information for anomaly detection jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" }, - "operationId": "ml-preview-datafeed-1", + "operationId": "ml-get-job-stats", "parameters": [ { - "$ref": "#/components/parameters/ml.preview_datafeed#datafeed_id" - }, - { - "$ref": "#/components/parameters/ml.preview_datafeed#start" - }, - { - "$ref": "#/components/parameters/ml.preview_datafeed#end" + "$ref": "#/components/parameters/ml.get_job_stats#allow_no_match" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.preview_datafeed" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.preview_datafeed#200" + "$ref": "#/components/responses/ml.get_job_stats#200" } } } }, - "/_ml/datafeeds/_preview": { + "/_ml/anomaly_detectors/{job_id}/_stats": { "get": { "tags": [ - "ml.preview_datafeed" + "ml.get_job_stats" ], - "summary": "Previews a datafeed.", - "description": "Previews a datafeed.", + "summary": "Retrieves usage information for anomaly detection jobs.", + "description": "Retrieves usage information for anomaly detection jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" }, - "operationId": "ml-preview-datafeed-2", + "operationId": "ml-get-job-stats-1", "parameters": [ { - "$ref": "#/components/parameters/ml.preview_datafeed#start" + "$ref": "#/components/parameters/ml.get_job_stats#job_id" }, { - "$ref": "#/components/parameters/ml.preview_datafeed#end" + "$ref": "#/components/parameters/ml.get_job_stats#allow_no_match" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.preview_datafeed" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.preview_datafeed#200" + "$ref": "#/components/responses/ml.get_job_stats#200" } } - }, - "post": { + } + }, + "/_ml/anomaly_detectors": { + "get": { "tags": [ - "ml.preview_datafeed" + "ml.get_jobs" ], - "summary": "Previews a datafeed.", - "description": "Previews a datafeed.", + "summary": "Retrieves configuration information for anomaly detection jobs.", + "description": "Retrieves configuration information for anomaly detection jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" }, - "operationId": "ml-preview-datafeed-3", + "operationId": "ml-get-jobs-1", "parameters": [ { - "$ref": "#/components/parameters/ml.preview_datafeed#start" + "$ref": "#/components/parameters/ml.get_jobs#allow_no_match" }, { - "$ref": "#/components/parameters/ml.preview_datafeed#end" + "$ref": "#/components/parameters/ml.get_jobs#exclude_generated" } ], - "requestBody": { - "$ref": "#/components/requestBodies/ml.preview_datafeed" - }, "responses": { "200": { - "$ref": "#/components/responses/ml.preview_datafeed#200" + "$ref": "#/components/responses/ml.get_jobs#200" } } } }, - "/_ml/trained_models/{model_id}/definition/{part}": { - "put": { + "/_ml/anomaly_detectors/{job_id}/results/overall_buckets": { + "get": { "tags": [ - "ml.put_trained_model_definition_part" + "ml.get_overall_buckets" ], - "summary": "Creates part of a trained model definition", - "description": "Creates part of a trained model definition", + "summary": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", + "description": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, - "operationId": "ml-put-trained-model-definition-part", + "operationId": "ml-get-overall-buckets", "parameters": [ { - "in": "path", - "name": "model_id", - "description": "The unique identifier of the trained model.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ml.get_overall_buckets#job_id" }, { - "in": "path", - "name": "part", - "description": "The definition part number. When the definition is loaded for inference the definition parts are streamed in the\norder of their part number. The first part must be `0` and the final part must be `total_parts - 1`.", - "required": true, - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "simple" + "$ref": "#/components/parameters/ml.get_overall_buckets#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#bucket_span" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#end" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#exclude_interim" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#overall_score" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#start" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#top_n" } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "definition": { - "description": "The definition part for the model. Must be a base64 encoded string.", - "type": "string" - }, - "total_definition_length": { - "description": "The total uncompressed definition length in bytes. Not base64 encoded.", - "type": "number" - }, - "total_parts": { - "description": "The total number of parts that will be uploaded. Must be greater than 0.", - "type": "number" - } - }, - "required": [ - "definition", - "total_definition_length", - "total_parts" - ] - } - } - }, - "required": true + "$ref": "#/components/requestBodies/ml.get_overall_buckets" }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/ml.get_overall_buckets#200" } } - } - }, - "/_ml/trained_models/{model_id}/vocabulary": { - "put": { + }, + "post": { "tags": [ - "ml.put_trained_model_vocabulary" + "ml.get_overall_buckets" ], - "summary": "Creates a trained model vocabulary", - "description": "Creates a trained model vocabulary", + "summary": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", + "description": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, - "operationId": "ml-put-trained-model-vocabulary", + "operationId": "ml-get-overall-buckets-1", "parameters": [ { - "in": "path", - "name": "model_id", - "description": "The unique identifier of the trained model.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ml.get_overall_buckets#job_id" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#bucket_span" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#end" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#exclude_interim" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#overall_score" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#start" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#top_n" } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "vocabulary": { - "description": "The model vocabulary, which must not be empty.", - "type": "array", - "items": { - "type": "string" - } - }, - "merges": { - "description": "The optional model merges if required by the tokenizer.", - "type": "array", - "items": { - "type": "string" - } - }, - "scores": { - "description": "The optional vocabulary value scores if required by the tokenizer.", - "type": "array", - "items": { - "type": "number" - } - } - }, - "required": [ - "vocabulary" - ] - } - } - }, - "required": true + "$ref": "#/components/requestBodies/ml.get_overall_buckets" }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/ml.get_overall_buckets#200" } } } }, - "/_ml/anomaly_detectors/{job_id}/_reset": { - "post": { + "/_ml/trained_models": { + "get": { "tags": [ - "ml.reset_job" + "ml.get_trained_models" ], - "summary": "Resets an existing anomaly detection job.", - "description": "Resets an existing anomaly detection job.", + "summary": "Retrieves configuration information for a trained inference model.", + "description": "Retrieves configuration information for a trained inference model.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" }, - "operationId": "ml-reset-job", + "operationId": "ml-get-trained-models-1", "parameters": [ { - "in": "path", - "name": "job_id", - "description": "The ID of the job to reset.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ml.get_trained_models#allow_no_match" }, { - "in": "query", - "name": "wait_for_completion", - "description": "Should this request wait until the operation has completed before\nreturning.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_trained_models#decompress_definition" }, { - "in": "query", - "name": "delete_user_annotations", - "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_trained_models#exclude_generated" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#from" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#include" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#size" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#tags" } ], "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" - } - } - } + "$ref": "#/components/responses/ml.get_trained_models#200" } } } }, - "/_ml/data_frame/analytics/{id}/_start": { - "post": { + "/_ml/trained_models/{model_id}/_stats": { + "get": { "tags": [ - "ml.start_data_frame_analytics" + "ml.get_trained_models_stats" ], - "summary": "Starts a data frame analytics job.", - "description": "Starts a data frame analytics job.", + "summary": "Retrieves usage information for trained inference models.", + "description": "Retrieves usage information for trained inference models.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" }, - "operationId": "ml-start-data-frame-analytics", + "operationId": "ml-get-trained-models-stats", "parameters": [ { - "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" + "$ref": "#/components/parameters/ml.get_trained_models_stats#model_id" }, { - "in": "query", - "name": "timeout", - "description": "Controls the amount of time to wait until the data frame analytics job\nstarts.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_trained_models_stats#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#from" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#size" } ], "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - }, - "node": { - "$ref": "#/components/schemas/_types:NodeId" - } - }, - "required": [ - "acknowledged", - "node" - ] - } - } - } + "$ref": "#/components/responses/ml.get_trained_models_stats#200" } } } }, - "/_ml/datafeeds/{datafeed_id}/_start": { - "post": { + "/_ml/trained_models/_stats": { + "get": { "tags": [ - "ml.start_datafeed" + "ml.get_trained_models_stats" ], - "summary": "Starts one or more datafeeds.", - "description": "Starts one or more datafeeds.", + "summary": "Retrieves usage information for trained inference models.", + "description": "Retrieves usage information for trained inference models.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" }, - "operationId": "ml-start-datafeed", + "operationId": "ml-get-trained-models-stats-1", "parameters": [ { - "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.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" + "$ref": "#/components/parameters/ml.get_trained_models_stats#allow_no_match" }, { - "in": "query", - "name": "end", - "description": "The time that the datafeed should end, which can be specified by using one of the following formats:\n\n* ISO 8601 format with milliseconds, for example `2017-01-22T06:00:00.000Z`\n* ISO 8601 format without milliseconds, for example `2017-01-22T06:00:00+00:00`\n* Milliseconds since the epoch, for example `1485061200000`\n\nDate-time arguments using either of the ISO 8601 formats must have a time zone designator, where `Z` is accepted\nas an abbreviation for UTC time. When a URL is expected (for example, in browsers), the `+` used in time zone\ndesignators must be encoded as `%2B`.\nThe end time value is exclusive. If you do not specify an end time, the datafeed\nruns continuously.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_trained_models_stats#from" }, { - "in": "query", - "name": "start", - "description": "The time that the datafeed should begin, which can be specified by using the same formats as the `end` parameter.\nThis value is inclusive.\nIf you do not specify a start time and the datafeed is associated with a new anomaly detection job, the analysis\nstarts from the earliest time for which data is available.\nIf you restart a stopped datafeed and specify a start value that is earlier than the timestamp of the latest\nprocessed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "style": "form" + "$ref": "#/components/parameters/ml.get_trained_models_stats#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_trained_models_stats#200" + } + } + } + }, + "/_ml/trained_models/{model_id}/_infer": { + "post": { + "tags": [ + "ml.infer_trained_model" + ], + "summary": "Evaluate a trained model.", + "description": "Evaluate a trained model.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" + }, + "operationId": "ml-infer-trained-model", + "parameters": [ + { + "$ref": "#/components/parameters/ml.infer_trained_model#model_id" }, { - "in": "query", - "name": "timeout", - "description": "Specifies the amount of time to wait until a datafeed starts.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" + "$ref": "#/components/parameters/ml.infer_trained_model#timeout" } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "end": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "start": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "timeout": { - "$ref": "#/components/schemas/_types:Duration" - } - } - } - } - } + "$ref": "#/components/requestBodies/ml.infer_trained_model" }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "node": { - "$ref": "#/components/schemas/_types:NodeIds" - }, - "started": { - "description": "For a successful response, this value is always `true`. On failure, an exception is returned instead.", - "type": "boolean" - } - }, - "required": [ - "node", - "started" - ] - } - } - } + "$ref": "#/components/responses/ml.infer_trained_model#200" } } } }, - "/_ml/trained_models/{model_id}/deployment/_start": { + "/_ml/trained_models/{model_id}/deployment/_infer": { "post": { "tags": [ - "ml.start_trained_model_deployment" + "ml.infer_trained_model" ], - "summary": "Start a trained model deployment.", - "description": "Start a trained model deployment.", + "summary": "Evaluate a trained model.", + "description": "Evaluate a trained model.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" }, - "operationId": "ml-start-trained-model-deployment", + "operationId": "ml-infer-trained-model-1", "parameters": [ { - "in": "path", - "name": "model_id", - "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Id" - }, - "style": "simple" - }, - { - "in": "query", - "name": "cache_size", - "description": "The inference cache size (in memory outside the JVM heap) per node for the model.\nThe default value is the same size as the `model_size_bytes`. To disable the cache,\n`0b` can be provided.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "style": "form" - }, - { - "in": "query", - "name": "number_of_allocations", - "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" - }, - { - "in": "query", - "name": "priority", - "description": "The deployment priority.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/ml._types:TrainingPriority" - }, - "style": "form" - }, - { - "in": "query", - "name": "queue_capacity", - "description": "Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds\nthis value, new requests are rejected with a 429 error.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" - }, - { - "in": "query", - "name": "threads_per_allocation", - "description": "Sets the number of threads used by each model allocation during inference. This generally increases\nthe inference speed. The inference process is a compute-bound process; any number\ngreater than the number of available hardware threads on the machine does not increase the\ninference speed. If this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", - "deprecated": false, - "schema": { - "type": "number" - }, - "style": "form" - }, - { - "in": "query", - "name": "timeout", - "description": "Specifies the amount of time to wait for the model to deploy.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types:Duration" - }, - "style": "form" + "$ref": "#/components/parameters/ml.infer_trained_model#model_id" }, { - "in": "query", - "name": "wait_for", - "description": "Specifies the allocation status to wait for before returning.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/ml._types:DeploymentAllocationState" - }, - "style": "form" + "$ref": "#/components/parameters/ml.infer_trained_model#timeout" } ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.infer_trained_model" + }, "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "assignment": { - "$ref": "#/components/schemas/ml._types:TrainedModelAssignment" - } - }, - "required": [ - "assignment" - ] - } - } - } + "$ref": "#/components/responses/ml.infer_trained_model#200" } } } }, - "/_ml/data_frame/analytics/{id}/_stop": { + "/_ml/anomaly_detectors/{job_id}/_open": { "post": { "tags": [ - "ml.stop_data_frame_analytics" + "ml.open_job" ], - "summary": "Stops one or more data frame analytics jobs.", - "description": "Stops one or more data frame analytics jobs.", + "summary": "Opens one or more anomaly detection jobs.", + "description": "Opens one or more anomaly detection jobs.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html" }, - "operationId": "ml-stop-data-frame-analytics", + "operationId": "ml-open-job", "parameters": [ { "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.", + "name": "job_id", + "description": "Identifier for the anomaly detection job.", "required": true, "deprecated": false, "schema": { @@ -11973,30 +12371,10 @@ }, "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 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 is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "in": "query", - "name": "force", - "description": "If true, the data frame analytics job is stopped forcefully.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, { "in": "query", "name": "timeout", - "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.", + "description": "Controls the time to wait until a job has opened.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -12004,6 +12382,20 @@ "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "timeout": { + "$ref": "#/components/schemas/_types:Duration" + } + } + } + } + } + }, "responses": { "200": { "description": "", @@ -12012,12 +12404,16 @@ "schema": { "type": "object", "properties": { - "stopped": { + "opened": { "type": "boolean" + }, + "node": { + "$ref": "#/components/schemas/_types:NodeId" } }, "required": [ - "stopped" + "opened", + "node" ] } } @@ -12026,22 +12422,230 @@ } } }, - "/_ml/datafeeds/{datafeed_id}/_stop": { + "/_ml/data_frame/analytics/_preview": { + "get": { + "tags": [ + "ml.preview_data_frame_analytics" + ], + "summary": "Previews that will be analyzed given a data frame analytics config.", + "description": "Previews that will be analyzed given a data frame analytics config.", + "externalDocs": { + "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + }, + "operationId": "ml-preview-data-frame-analytics", + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + } + } + }, "post": { "tags": [ - "ml.stop_datafeed" + "ml.preview_data_frame_analytics" ], - "summary": "Stops one or more datafeeds.", - "description": "Stops one or more datafeeds.", + "summary": "Previews that will be analyzed given a data frame analytics config.", + "description": "Previews that will be analyzed given a data frame analytics config.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html" + "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, - "operationId": "ml-stop-datafeed", - "parameters": [ - { + "operationId": "ml-preview-data-frame-analytics-1", + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + } + } + } + }, + "/_ml/data_frame/analytics/{id}/_preview": { + "get": { + "tags": [ + "ml.preview_data_frame_analytics" + ], + "summary": "Previews that will be analyzed given a data frame analytics config.", + "description": "Previews that will be analyzed given a data frame analytics config.", + "externalDocs": { + "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + }, + "operationId": "ml-preview-data-frame-analytics-2", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_data_frame_analytics#id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + } + } + }, + "post": { + "tags": [ + "ml.preview_data_frame_analytics" + ], + "summary": "Previews that will be analyzed given a data frame analytics config.", + "description": "Previews that will be analyzed given a data frame analytics config.", + "externalDocs": { + "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + }, + "operationId": "ml-preview-data-frame-analytics-3", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_data_frame_analytics#id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + } + } + } + }, + "/_ml/datafeeds/{datafeed_id}/_preview": { + "get": { + "tags": [ + "ml.preview_datafeed" + ], + "summary": "Previews a datafeed.", + "description": "Previews a datafeed.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + }, + "operationId": "ml-preview-datafeed", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_datafeed#datafeed_id" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#start" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#end" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_datafeed" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_datafeed#200" + } + } + }, + "post": { + "tags": [ + "ml.preview_datafeed" + ], + "summary": "Previews a datafeed.", + "description": "Previews a datafeed.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + }, + "operationId": "ml-preview-datafeed-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_datafeed#datafeed_id" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#start" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#end" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_datafeed" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_datafeed#200" + } + } + } + }, + "/_ml/datafeeds/_preview": { + "get": { + "tags": [ + "ml.preview_datafeed" + ], + "summary": "Previews a datafeed.", + "description": "Previews a datafeed.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + }, + "operationId": "ml-preview-datafeed-2", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_datafeed#start" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#end" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_datafeed" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_datafeed#200" + } + } + }, + "post": { + "tags": [ + "ml.preview_datafeed" + ], + "summary": "Previews a datafeed.", + "description": "Previews a datafeed.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + }, + "operationId": "ml-preview-datafeed-3", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_datafeed#start" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#end" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_datafeed" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_datafeed#200" + } + } + } + }, + "/_ml/trained_models/{model_id}/definition/{part}": { + "put": { + "tags": [ + "ml.put_trained_model_definition_part" + ], + "summary": "Creates part of a trained model definition", + "description": "Creates part of a trained model definition", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html" + }, + "operationId": "ml-put-trained-model-definition-part", + "parameters": [ + { "in": "path", - "name": "datafeed_id", - "description": "Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated\nlist of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as\nthe identifier.", + "name": "model_id", + "description": "The unique identifier of the trained model.", "required": true, "deprecated": false, "schema": { @@ -12050,34 +12654,82 @@ "style": "simple" }, { - "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" - }, - { - "in": "query", - "name": "force", - "description": "If `true`, the datafeed is stopped forcefully.", + "in": "path", + "name": "part", + "description": "The definition part number. When the definition is loaded for inference the definition parts are streamed in the\norder of their part number. The first part must be `0` and the final part must be `total_parts - 1`.", + "required": true, "deprecated": false, "schema": { - "type": "boolean" + "type": "number" }, - "style": "form" + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "definition": { + "description": "The definition part for the model. Must be a base64 encoded string.", + "type": "string" + }, + "total_definition_length": { + "description": "The total uncompressed definition length in bytes. Not base64 encoded.", + "type": "number" + }, + "total_parts": { + "description": "The total number of parts that will be uploaded. Must be greater than 0.", + "type": "number" + } + }, + "required": [ + "definition", + "total_definition_length", + "total_parts" + ] + } + } }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + } + } + }, + "/_ml/trained_models/{model_id}/vocabulary": { + "put": { + "tags": [ + "ml.put_trained_model_vocabulary" + ], + "summary": "Creates a trained model vocabulary", + "description": "Creates a trained model vocabulary", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html" + }, + "operationId": "ml-put-trained-model-vocabulary", + "parameters": [ { - "in": "query", - "name": "timeout", - "description": "Specifies the amount of time to wait until a datafeed stops.", + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:Duration" + "$ref": "#/components/schemas/_types:Id" }, - "style": "form" + "style": "simple" } ], "requestBody": { @@ -12086,21 +12738,35 @@ "schema": { "type": "object", "properties": { - "allow_no_match": { - "description": "Refer to the description for the `allow_no_match` query parameter.", - "type": "boolean" + "vocabulary": { + "description": "The model vocabulary, which must not be empty.", + "type": "array", + "items": { + "type": "string" + } }, - "force": { - "description": "Refer to the description for the `force` query parameter.", - "type": "boolean" + "merges": { + "description": "The optional model merges if required by the tokenizer.", + "type": "array", + "items": { + "type": "string" + } }, - "timeout": { - "$ref": "#/components/schemas/_types:Duration" + "scores": { + "description": "The optional vocabulary value scores if required by the tokenizer.", + "type": "array", + "items": { + "type": "number" + } } - } + }, + "required": [ + "vocabulary" + ] } } - } + }, + "required": true }, "responses": { "200": { @@ -12108,15 +12774,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "stopped": { - "type": "boolean" - } - }, - "required": [ - "stopped" - ] + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" } } } @@ -12124,22 +12782,22 @@ } } }, - "/_ml/trained_models/{model_id}/deployment/_stop": { + "/_ml/anomaly_detectors/{job_id}/_reset": { "post": { "tags": [ - "ml.stop_trained_model_deployment" + "ml.reset_job" ], - "summary": "Stop a trained model deployment.", - "description": "Stop a trained model deployment.", + "summary": "Resets an existing anomaly detection job.", + "description": "Resets an existing anomaly detection job.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html" }, - "operationId": "ml-stop-trained-model-deployment", + "operationId": "ml-reset-job", "parameters": [ { "in": "path", - "name": "model_id", - "description": "The unique identifier of the trained model.", + "name": "job_id", + "description": "The ID of the job to reset.", "required": true, "deprecated": false, "schema": { @@ -12149,8 +12807,8 @@ }, { "in": "query", - "name": "allow_no_match", - "description": "Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;\ncontains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and\nthere are only partial matches. By default, it returns an empty 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.", + "name": "wait_for_completion", + "description": "Should this request wait until the operation has completed before\nreturning.", "deprecated": false, "schema": { "type": "boolean" @@ -12159,8 +12817,8 @@ }, { "in": "query", - "name": "force", - "description": "Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you\nrestart the model deployment.", + "name": "delete_user_annotations", + "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", "deprecated": false, "schema": { "type": "boolean" @@ -12174,15 +12832,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "stopped": { - "type": "boolean" - } - }, - "required": [ - "stopped" - ] + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" } } } @@ -12190,17 +12840,17 @@ } } }, - "/_ml/data_frame/analytics/{id}/_update": { + "/_ml/data_frame/analytics/{id}/_start": { "post": { "tags": [ - "ml.update_data_frame_analytics" + "ml.start_data_frame_analytics" ], - "summary": "Updates certain properties of a data frame analytics job.", - "description": "Updates certain properties of a data frame analytics job.", + "summary": "Starts a data frame analytics job.", + "description": "Starts a data frame analytics job.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html" }, - "operationId": "ml-update-data-frame-analytics", + "operationId": "ml-start-data-frame-analytics", "parameters": [ { "in": "path", @@ -12212,42 +12862,18 @@ "$ref": "#/components/schemas/_types:Id" }, "style": "simple" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the amount of time to wait until the data frame analytics job\nstarts.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "description": "A description of the job.", - "type": "string" - }, - "model_memory_limit": { - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" - }, - "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\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", - "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.", - "type": "number" - }, - "allow_lazy_start": { - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" - }, - "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", - "type": "boolean" - } - } - } - } - }, - "required": true - }, "responses": { "200": { "description": "", @@ -12256,53 +12882,16 @@ "schema": { "type": "object", "properties": { - "authorization": { - "$ref": "#/components/schemas/ml._types:DataframeAnalyticsAuthorization" - }, - "allow_lazy_start": { + "acknowledged": { "type": "boolean" }, - "analysis": { - "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" - }, - "analyzed_fields": { - "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" - }, - "create_time": { - "type": "number" - }, - "description": { - "type": "string" - }, - "dest": { - "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" - }, - "id": { - "$ref": "#/components/schemas/_types:Id" - }, - "max_num_threads": { - "type": "number" - }, - "model_memory_limit": { - "type": "string" - }, - "source": { - "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" - }, - "version": { - "$ref": "#/components/schemas/_types:VersionString" + "node": { + "$ref": "#/components/schemas/_types:NodeId" } }, "required": [ - "allow_lazy_start", - "analysis", - "create_time", - "dest", - "id", - "max_num_threads", - "model_memory_limit", - "source", - "version" + "acknowledged", + "node" ] } } @@ -12311,22 +12900,22 @@ } } }, - "/_ml/datafeeds/{datafeed_id}/_update": { + "/_ml/datafeeds/{datafeed_id}/_start": { "post": { "tags": [ - "ml.update_datafeed" + "ml.start_datafeed" ], - "summary": "Updates certain properties of a datafeed.", - "description": "Updates certain properties of a datafeed.", + "summary": "Starts one or more datafeeds.", + "description": "Starts one or more datafeeds.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html" }, - "operationId": "ml-update-datafeed", + "operationId": "ml-start-datafeed", "parameters": [ { "in": "path", "name": "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.", + "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.", "required": true, "deprecated": false, "schema": { @@ -12336,41 +12925,31 @@ }, { "in": "query", - "name": "allow_no_indices", - "description": "If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the\n`_all` string or when no indices are specified.", + "name": "end", + "description": "The time that the datafeed should end, which can be specified by using one of the following formats:\n\n* ISO 8601 format with milliseconds, for example `2017-01-22T06:00:00.000Z`\n* ISO 8601 format without milliseconds, for example `2017-01-22T06:00:00+00:00`\n* Milliseconds since the epoch, for example `1485061200000`\n\nDate-time arguments using either of the ISO 8601 formats must have a time zone designator, where `Z` is accepted\nas an abbreviation for UTC time. When a URL is expected (for example, in browsers), the `+` used in time zone\ndesignators must be encoded as `%2B`.\nThe end time value is exclusive. If you do not specify an end time, the datafeed\nruns continuously.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:DateTime" }, "style": "form" }, { "in": "query", - "name": "expand_wildcards", - "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:\n\n* `all`: Match any data stream or index, including hidden ones.\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 patterns are not accepted.\n* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.", + "name": "start", + "description": "The time that the datafeed should begin, which can be specified by using the same formats as the `end` parameter.\nThis value is inclusive.\nIf you do not specify a start time and the datafeed is associated with a new anomaly detection job, the analysis\nstarts from the earliest time for which data is available.\nIf you restart a stopped datafeed and specify a start value that is earlier than the timestamp of the latest\nprocessed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record.", "deprecated": false, "schema": { - "$ref": "#/components/schemas/_types:ExpandWildcards" - }, - "style": "form" - }, - { - "in": "query", - "name": "ignore_throttled", - "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", - "deprecated": true, - "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:DateTime" }, "style": "form" }, { "in": "query", - "name": "ignore_unavailable", - "description": "If `true`, unavailable indices (missing or closed) are ignored.", + "name": "timeout", + "description": "Specifies the amount of time to wait until a datafeed starts.", "deprecated": false, "schema": { - "type": "boolean" + "$ref": "#/components/schemas/_types:Duration" }, "style": "form" } @@ -12381,64 +12960,19 @@ "schema": { "type": "object", "properties": { - "aggregations": { - "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" - } - }, - "chunking_config": { - "$ref": "#/components/schemas/ml._types:ChunkingConfig" - }, - "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" - }, - "frequency": { - "$ref": "#/components/schemas/_types:Duration" - }, - "indices": { - "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.", - "type": "array", - "items": { - "type": "string" - } - }, - "indices_options": { - "$ref": "#/components/schemas/_types:IndicesOptions" - }, - "job_id": { - "$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), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", - "type": "number" + "end": { + "$ref": "#/components/schemas/_types:DateTime" }, - "query": { - "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + "start": { + "$ref": "#/components/schemas/_types:DateTime" }, - "query_delay": { + "timeout": { "$ref": "#/components/schemas/_types:Duration" - }, - "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping:RuntimeFields" - }, - "script_fields": { - "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe 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.\nThe maximum value is the value of `index.max_result_window`.", - "type": "number" } } } } - }, - "required": true + } }, "responses": { "200": { @@ -12448,69 +12982,17 @@ "schema": { "type": "object", "properties": { - "authorization": { - "$ref": "#/components/schemas/ml._types:DatafeedAuthorization" - }, - "aggregations": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" - } - }, - "chunking_config": { - "$ref": "#/components/schemas/ml._types:ChunkingConfig" - }, - "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" - }, - "datafeed_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "frequency": { - "$ref": "#/components/schemas/_types:Duration" - }, - "indices": { - "type": "array", - "items": { - "type": "string" - } - }, - "indices_options": { - "$ref": "#/components/schemas/_types:IndicesOptions" - }, - "job_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "max_empty_searches": { - "type": "number" - }, - "query": { - "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" - }, - "query_delay": { - "$ref": "#/components/schemas/_types:Duration" - }, - "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping:RuntimeFields" - }, - "script_fields": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/_types:ScriptField" - } + "node": { + "$ref": "#/components/schemas/_types:NodeIds" }, - "scroll_size": { - "type": "number" + "started": { + "description": "For a successful response, this value is always `true`. On failure, an exception is returned instead.", + "type": "boolean" } }, "required": [ - "chunking_config", - "datafeed_id", - "indices", - "job_id", - "query", - "query_delay", - "scroll_size" + "node", + "started" ] } } @@ -12519,60 +13001,176 @@ } } }, - "/_ml/filters/{filter_id}/_update": { + "/_ml/trained_models/{model_id}/deployment/_start": { "post": { "tags": [ - "ml.update_filter" + "ml.start_trained_model_deployment" ], - "summary": "Updates the description of a filter, adds items, or removes items.", - "description": "Updates the description of a filter, adds items, or removes items.", + "summary": "Start a trained model deployment.", + "description": "Start a trained model deployment.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html" }, - "operationId": "ml-update-filter", + "operationId": "ml-start-trained-model-deployment", "parameters": [ { "in": "path", - "name": "filter_id", - "description": "A string that uniquely identifies a filter.", + "name": "model_id", + "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Id" }, "style": "simple" + }, + { + "in": "query", + "name": "cache_size", + "description": "The inference cache size (in memory outside the JVM heap) per node for the model.\nThe default value is the same size as the `model_size_bytes`. To disable the cache,\n`0b` can be provided.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "style": "form" + }, + { + "in": "query", + "name": "number_of_allocations", + "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "priority", + "description": "The deployment priority.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ml._types:TrainingPriority" + }, + "style": "form" + }, + { + "in": "query", + "name": "queue_capacity", + "description": "Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds\nthis value, new requests are rejected with a 429 error.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "threads_per_allocation", + "description": "Sets the number of threads used by each model allocation during inference. This generally increases\nthe inference speed. The inference process is a compute-bound process; any number\ngreater than the number of available hardware threads on the machine does not increase the\ninference speed. If this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Specifies the amount of time to wait for the model to deploy.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for", + "description": "Specifies the allocation status to wait for before returning.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ml._types:DeploymentAllocationState" + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "add_items": { - "description": "The items to add to the filter.", - "type": "array", - "items": { - "type": "string" + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignment": { + "$ref": "#/components/schemas/ml._types:TrainedModelAssignment" } }, - "description": { - "description": "A description for the filter.", - "type": "string" - }, - "remove_items": { - "description": "The items to remove from the filter.", - "type": "array", - "items": { - "type": "string" - } - } + "required": [ + "assignment" + ] } } } - }, - "required": true + } + } + } + }, + "/_ml/data_frame/analytics/{id}/_stop": { + "post": { + "tags": [ + "ml.stop_data_frame_analytics" + ], + "summary": "Stops one or more data frame analytics jobs.", + "description": "Stops one or more data frame analytics jobs.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html" }, + "operationId": "ml-stop-data-frame-analytics", + "parameters": [ + { + "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" + }, + { + "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 is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "force", + "description": "If true, the data frame analytics job is stopped forcefully.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], "responses": { "200": { "description": "", @@ -12581,23 +13179,12 @@ "schema": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "filter_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "items": { - "type": "array", - "items": { - "type": "string" - } + "stopped": { + "type": "boolean" } }, "required": [ - "description", - "filter_id", - "items" + "stopped" ] } } @@ -12606,28 +13193,58 @@ } } }, - "/_ml/anomaly_detectors/{job_id}/_update": { + "/_ml/datafeeds/{datafeed_id}/_stop": { "post": { "tags": [ - "ml.update_job" + "ml.stop_datafeed" ], - "summary": "Updates certain properties of an anomaly detection job.", - "description": "Updates certain properties of an anomaly detection job.", + "summary": "Stops one or more datafeeds.", + "description": "Stops one or more datafeeds.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html" }, - "operationId": "ml-update-job", + "operationId": "ml-stop-datafeed", "parameters": [ { "in": "path", - "name": "job_id", - "description": "Identifier for the job.", + "name": "datafeed_id", + "description": "Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated\nlist of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as\nthe identifier.", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Id" }, "style": "simple" + }, + { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\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" + }, + { + "in": "query", + "name": "force", + "description": "If `true`, the datafeed is stopped forcefully.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Specifies the amount of time to wait until a datafeed stops.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" } ], "requestBody": { @@ -12636,86 +13253,21 @@ "schema": { "type": "object", "properties": { - "allow_lazy_open": { - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" - }, - "description": "Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.", + "allow_no_match": { + "description": "Refer to the description for the `allow_no_match` query parameter.", "type": "boolean" }, - "analysis_limits": { - "$ref": "#/components/schemas/ml._types:AnalysisMemoryLimit" - }, - "background_persist_interval": { - "$ref": "#/components/schemas/_types:Duration" - }, - "custom_settings": { - "description": "Advanced configuration option. Contains custom meta data about the job.\nFor example, it can contain custom URL information as shown in Adding\ncustom URLs to machine learning results.", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "categorization_filters": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "description": "A description of the job.", - "type": "string" - }, - "model_plot_config": { - "$ref": "#/components/schemas/ml._types:ModelPlotConfig" + "force": { + "description": "Refer to the description for the `force` query parameter.", + "type": "boolean" }, - "model_prune_window": { + "timeout": { "$ref": "#/components/schemas/_types:Duration" - }, - "daily_model_snapshot_retention_after_days": { - "externalDocs": { - "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots" - }, - "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.", - "type": "number" - }, - "model_snapshot_retention_days": { - "externalDocs": { - "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots" - }, - "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.", - "type": "number" - }, - "renormalization_window_days": { - "description": "Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.", - "type": "number" - }, - "results_retention_days": { - "description": "Advanced configuration option. The period of time (in days) that results\nare retained. Age is calculated relative to the timestamp of the latest\nbucket result. If this property has a non-null value, once per day at\n00:30 (server time), results that are the specified number of days older\nthan the latest bucket result are deleted from Elasticsearch. The default\nvalue is null, which means all results are retained.", - "type": "number" - }, - "groups": { - "description": "A list of job groups. A job can belong to no groups or many.", - "type": "array", - "items": { - "type": "string" - } - }, - "detectors": { - "description": "An array of detector update objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ml._types:Detector" - } - }, - "per_partition_categorization": { - "$ref": "#/components/schemas/ml._types:PerPartitionCategorization" } } } } - }, - "required": true + } }, "responses": { "200": { @@ -12725,88 +13277,12 @@ "schema": { "type": "object", "properties": { - "allow_lazy_open": { + "stopped": { "type": "boolean" - }, - "analysis_config": { - "$ref": "#/components/schemas/ml._types:AnalysisConfigRead" - }, - "analysis_limits": { - "$ref": "#/components/schemas/ml._types:AnalysisLimits" - }, - "background_persist_interval": { - "$ref": "#/components/schemas/_types:Duration" - }, - "create_time": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, - "finished_time": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, - "custom_settings": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "daily_model_snapshot_retention_after_days": { - "type": "number" - }, - "data_description": { - "$ref": "#/components/schemas/ml._types:DataDescription" - }, - "datafeed_config": { - "$ref": "#/components/schemas/ml._types:Datafeed" - }, - "description": { - "type": "string" - }, - "groups": { - "type": "array", - "items": { - "type": "string" - } - }, - "job_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "job_type": { - "type": "string" - }, - "job_version": { - "$ref": "#/components/schemas/_types:VersionString" - }, - "model_plot_config": { - "$ref": "#/components/schemas/ml._types:ModelPlotConfig" - }, - "model_snapshot_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "model_snapshot_retention_days": { - "type": "number" - }, - "renormalization_window_days": { - "type": "number" - }, - "results_index_name": { - "$ref": "#/components/schemas/_types:IndexName" - }, - "results_retention_days": { - "type": "number" } }, "required": [ - "allow_lazy_open", - "analysis_config", - "analysis_limits", - "create_time", - "daily_model_snapshot_retention_after_days", - "data_description", - "job_id", - "job_type", - "job_version", - "model_snapshot_retention_days", - "results_index_name" + "stopped" ] } } @@ -12815,226 +13291,917 @@ } } }, - "/_msearch": { - "get": { + "/_ml/trained_models/{model_id}/deployment/_stop": { + "post": { "tags": [ - "msearch" + "ml.stop_trained_model_deployment" ], - "summary": "Allows to execute several search operations in one request.", - "description": "Allows to execute several search operations in one request.", + "summary": "Stop a trained model deployment.", + "description": "Stop a trained model deployment.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html" }, - "operationId": "msearch", + "operationId": "ml-stop-trained-model-deployment", "parameters": [ { - "$ref": "#/components/parameters/msearch#allow_no_indices" - }, - { - "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" - }, - { - "$ref": "#/components/parameters/msearch#expand_wildcards" - }, - { - "$ref": "#/components/parameters/msearch#ignore_throttled" - }, - { - "$ref": "#/components/parameters/msearch#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/msearch#max_concurrent_searches" - }, - { - "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" - }, - { - "$ref": "#/components/parameters/msearch#pre_filter_shard_size" - }, - { - "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" - }, - { - "$ref": "#/components/parameters/msearch#routing" + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/msearch#search_type" + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;\ncontains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and\nthere are only partial matches. By default, it returns an empty 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" }, { - "$ref": "#/components/parameters/msearch#typed_keys" + "in": "query", + "name": "force", + "description": "Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you\nrestart the model deployment.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], - "requestBody": { - "$ref": "#/components/requestBodies/msearch" - }, "responses": { "200": { - "$ref": "#/components/responses/msearch#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "stopped": { + "type": "boolean" + } + }, + "required": [ + "stopped" + ] + } + } + } } } - }, + } + }, + "/_ml/data_frame/analytics/{id}/_update": { "post": { "tags": [ - "msearch" + "ml.update_data_frame_analytics" ], - "summary": "Allows to execute several search operations in one request.", - "description": "Allows to execute several search operations in one request.", + "summary": "Updates certain properties of a data frame analytics job.", + "description": "Updates certain properties of a data frame analytics job.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html" }, - "operationId": "msearch-1", + "operationId": "ml-update-data-frame-analytics", "parameters": [ { - "$ref": "#/components/parameters/msearch#allow_no_indices" - }, - { - "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" - }, - { - "$ref": "#/components/parameters/msearch#expand_wildcards" - }, - { - "$ref": "#/components/parameters/msearch#ignore_throttled" - }, - { - "$ref": "#/components/parameters/msearch#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/msearch#max_concurrent_searches" - }, - { - "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" - }, - { - "$ref": "#/components/parameters/msearch#pre_filter_shard_size" - }, - { - "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" - }, - { - "$ref": "#/components/parameters/msearch#routing" - }, - { - "$ref": "#/components/parameters/msearch#search_type" - }, - { - "$ref": "#/components/parameters/msearch#typed_keys" + "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" } ], "requestBody": { - "$ref": "#/components/requestBodies/msearch" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "description": "A description of the job.", + "type": "string" + }, + "model_memory_limit": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "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\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", + "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.", + "type": "number" + }, + "allow_lazy_start": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", + "type": "boolean" + } + } + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/msearch#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsAuthorization" + }, + "allow_lazy_start": { + "type": "boolean" + }, + "analysis": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" + }, + "analyzed_fields": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" + }, + "create_time": { + "type": "number" + }, + "description": { + "type": "string" + }, + "dest": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_num_threads": { + "type": "number" + }, + "model_memory_limit": { + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "allow_lazy_start", + "analysis", + "create_time", + "dest", + "id", + "max_num_threads", + "model_memory_limit", + "source", + "version" + ] + } + } + } } } } }, - "/{index}/_msearch": { - "get": { + "/_ml/datafeeds/{datafeed_id}/_update": { + "post": { "tags": [ - "msearch" + "ml.update_datafeed" ], - "summary": "Allows to execute several search operations in one request.", - "description": "Allows to execute several search operations in one request.", + "summary": "Updates certain properties of a datafeed.", + "description": "Updates certain properties of a datafeed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html" }, - "operationId": "msearch-2", + "operationId": "ml-update-datafeed", "parameters": [ { - "$ref": "#/components/parameters/msearch#index" - }, - { - "$ref": "#/components/parameters/msearch#allow_no_indices" - }, - { - "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" - }, - { - "$ref": "#/components/parameters/msearch#expand_wildcards" - }, - { - "$ref": "#/components/parameters/msearch#ignore_throttled" - }, - { - "$ref": "#/components/parameters/msearch#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/msearch#max_concurrent_searches" - }, - { - "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" - }, - { - "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + "in": "path", + "name": "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.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" }, { - "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + "in": "query", + "name": "allow_no_indices", + "description": "If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the\n`_all` string or when no indices are specified.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/msearch#routing" + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:\n\n* `all`: Match any data stream or index, including hidden ones.\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 patterns are not accepted.\n* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" }, { - "$ref": "#/components/parameters/msearch#search_type" + "in": "query", + "name": "ignore_throttled", + "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", + "deprecated": true, + "schema": { + "type": "boolean" + }, + "style": "form" }, { - "$ref": "#/components/parameters/msearch#typed_keys" + "in": "query", + "name": "ignore_unavailable", + "description": "If `true`, unavailable indices (missing or closed) are ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "requestBody": { - "$ref": "#/components/requestBodies/msearch" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.", + "type": "array", + "items": { + "type": "string" + } + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "job_id": { + "$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), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "script_fields": { + "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe 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.\nThe maximum value is the value of `index.max_result_window`.", + "type": "number" + } + } + } + } + }, + "required": true }, "responses": { "200": { - "$ref": "#/components/responses/msearch#200" + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/ml._types:DatafeedAuthorization" + }, + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "datafeed_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "type": "array", + "items": { + "type": "string" + } + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_empty_searches": { + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "script_fields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "scroll_size": { + "type": "number" + } + }, + "required": [ + "chunking_config", + "datafeed_id", + "indices", + "job_id", + "query", + "query_delay", + "scroll_size" + ] + } + } + } } } - }, + } + }, + "/_ml/filters/{filter_id}/_update": { "post": { "tags": [ - "msearch" + "ml.update_filter" ], - "summary": "Allows to execute several search operations in one request.", - "description": "Allows to execute several search operations in one request.", + "summary": "Updates the description of a filter, adds items, or removes items.", + "description": "Updates the description of a filter, adds items, or removes items.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html" }, - "operationId": "msearch-3", + "operationId": "ml-update-filter", "parameters": [ { - "$ref": "#/components/parameters/msearch#index" - }, - { - "$ref": "#/components/parameters/msearch#allow_no_indices" - }, - { - "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" - }, - { - "$ref": "#/components/parameters/msearch#expand_wildcards" - }, - { - "$ref": "#/components/parameters/msearch#ignore_throttled" - }, - { - "$ref": "#/components/parameters/msearch#ignore_unavailable" - }, - { - "$ref": "#/components/parameters/msearch#max_concurrent_searches" - }, - { - "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" - }, - { - "$ref": "#/components/parameters/msearch#pre_filter_shard_size" - }, - { - "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" - }, - { - "$ref": "#/components/parameters/msearch#routing" + "in": "path", + "name": "filter_id", + "description": "A string that uniquely identifies a filter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "add_items": { + "description": "The items to add to the filter.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "A description for the filter.", + "type": "string" + }, + "remove_items": { + "description": "The items to remove from the filter.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "filter_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "description", + "filter_id", + "items" + ] + } + } + } + } + } + } + }, + "/_ml/anomaly_detectors/{job_id}/_update": { + "post": { + "tags": [ + "ml.update_job" + ], + "summary": "Updates certain properties of an anomaly detection job.", + "description": "Updates certain properties of an anomaly detection job.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html" + }, + "operationId": "ml-update-job", + "parameters": [ + { + "in": "path", + "name": "job_id", + "description": "Identifier for the job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_lazy_open": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "description": "Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.", + "type": "boolean" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisMemoryLimit" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "custom_settings": { + "description": "Advanced configuration option. Contains custom meta data about the job.\nFor example, it can contain custom URL information as shown in Adding\ncustom URLs to machine learning results.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "categorization_filters": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "A description of the job.", + "type": "string" + }, + "model_plot_config": { + "$ref": "#/components/schemas/ml._types:ModelPlotConfig" + }, + "model_prune_window": { + "$ref": "#/components/schemas/_types:Duration" + }, + "daily_model_snapshot_retention_after_days": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots" + }, + "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.", + "type": "number" + }, + "model_snapshot_retention_days": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots" + }, + "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.", + "type": "number" + }, + "renormalization_window_days": { + "description": "Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.", + "type": "number" + }, + "results_retention_days": { + "description": "Advanced configuration option. The period of time (in days) that results\nare retained. Age is calculated relative to the timestamp of the latest\nbucket result. If this property has a non-null value, once per day at\n00:30 (server time), results that are the specified number of days older\nthan the latest bucket result are deleted from Elasticsearch. The default\nvalue is null, which means all results are retained.", + "type": "number" + }, + "groups": { + "description": "A list of job groups. A job can belong to no groups or many.", + "type": "array", + "items": { + "type": "string" + } + }, + "detectors": { + "description": "An array of detector update objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:Detector" + } + }, + "per_partition_categorization": { + "$ref": "#/components/schemas/ml._types:PerPartitionCategorization" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_lazy_open": { + "type": "boolean" + }, + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfigRead" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisLimits" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "create_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "finished_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "custom_settings": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "daily_model_snapshot_retention_after_days": { + "type": "number" + }, + "data_description": { + "$ref": "#/components/schemas/ml._types:DataDescription" + }, + "datafeed_config": { + "$ref": "#/components/schemas/ml._types:Datafeed" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "job_type": { + "type": "string" + }, + "job_version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "model_plot_config": { + "$ref": "#/components/schemas/ml._types:ModelPlotConfig" + }, + "model_snapshot_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "model_snapshot_retention_days": { + "type": "number" + }, + "renormalization_window_days": { + "type": "number" + }, + "results_index_name": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "results_retention_days": { + "type": "number" + } + }, + "required": [ + "allow_lazy_open", + "analysis_config", + "analysis_limits", + "create_time", + "daily_model_snapshot_retention_after_days", + "data_description", + "job_id", + "job_type", + "job_version", + "model_snapshot_retention_days", + "results_index_name" + ] + } + } + } + } + } + } + }, + "/_msearch": { + "get": { + "tags": [ + "msearch" + ], + "summary": "Allows to execute several search operations in one request.", + "description": "Allows to execute several search operations in one request.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + }, + "operationId": "msearch", + "parameters": [ + { + "$ref": "#/components/parameters/msearch#allow_no_indices" + }, + { + "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch#expand_wildcards" + }, + { + "$ref": "#/components/parameters/msearch#ignore_throttled" + }, + { + "$ref": "#/components/parameters/msearch#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch#routing" + }, + { + "$ref": "#/components/parameters/msearch#search_type" + }, + { + "$ref": "#/components/parameters/msearch#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch#200" + } + } + }, + "post": { + "tags": [ + "msearch" + ], + "summary": "Allows to execute several search operations in one request.", + "description": "Allows to execute several search operations in one request.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + }, + "operationId": "msearch-1", + "parameters": [ + { + "$ref": "#/components/parameters/msearch#allow_no_indices" + }, + { + "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch#expand_wildcards" + }, + { + "$ref": "#/components/parameters/msearch#ignore_throttled" + }, + { + "$ref": "#/components/parameters/msearch#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch#routing" + }, + { + "$ref": "#/components/parameters/msearch#search_type" + }, + { + "$ref": "#/components/parameters/msearch#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch#200" + } + } + } + }, + "/{index}/_msearch": { + "get": { + "tags": [ + "msearch" + ], + "summary": "Allows to execute several search operations in one request.", + "description": "Allows to execute several search operations in one request.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + }, + "operationId": "msearch-2", + "parameters": [ + { + "$ref": "#/components/parameters/msearch#index" + }, + { + "$ref": "#/components/parameters/msearch#allow_no_indices" + }, + { + "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch#expand_wildcards" + }, + { + "$ref": "#/components/parameters/msearch#ignore_throttled" + }, + { + "$ref": "#/components/parameters/msearch#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch#routing" + }, + { + "$ref": "#/components/parameters/msearch#search_type" + }, + { + "$ref": "#/components/parameters/msearch#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch#200" + } + } + }, + "post": { + "tags": [ + "msearch" + ], + "summary": "Allows to execute several search operations in one request.", + "description": "Allows to execute several search operations in one request.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + }, + "operationId": "msearch-3", + "parameters": [ + { + "$ref": "#/components/parameters/msearch#index" + }, + { + "$ref": "#/components/parameters/msearch#allow_no_indices" + }, + { + "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch#expand_wildcards" + }, + { + "$ref": "#/components/parameters/msearch#ignore_throttled" + }, + { + "$ref": "#/components/parameters/msearch#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch#routing" }, { "$ref": "#/components/parameters/msearch#search_type" @@ -47478,519 +48645,1260 @@ } }, "required": [ - "enabled" + "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": { + "$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": { + "$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.", + "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.", + "type": "boolean" + } + } + }, + "indices._types:DataStreamLifecycleWithRollover": { + "type": "object", + "properties": { + "data_retention": { + "$ref": "#/components/schemas/_types:Duration" + }, + "downsampling": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" + }, + "rollover": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleRolloverConditions" + } + } + }, + "indices._types:DataStreamLifecycleDownsampling": { + "type": "object", + "properties": { + "rounds": { + "description": "The list of downsampling rounds to execute as part of this downsampling configuration", + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:DownsamplingRound" + } + } + }, + "required": [ + "rounds" + ] + }, + "indices._types:DownsamplingRound": { + "type": "object", + "properties": { + "after": { + "$ref": "#/components/schemas/_types:Duration" + }, + "config": { + "$ref": "#/components/schemas/indices._types:DownsampleConfig" + } + }, + "required": [ + "after", + "config" + ] + }, + "indices._types:DownsampleConfig": { + "type": "object", + "properties": { + "fixed_interval": { + "$ref": "#/components/schemas/_types:DurationLarge" + } + }, + "required": [ + "fixed_interval" + ] + }, + "indices._types:DataStreamLifecycleRolloverConditions": { + "type": "object", + "properties": { + "min_age": { + "$ref": "#/components/schemas/_types:Duration" + }, + "max_age": { + "type": "string" + }, + "min_docs": { + "type": "number" + }, + "max_docs": { + "type": "number" + }, + "min_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_docs": { + "type": "number" + }, + "max_primary_shard_docs": { + "type": "number" + } + } + }, + "_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" + } + } + } + }, + "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:Ingest": { + "type": "object", + "properties": { + "pipelines": { + "description": "Contains statistics about ingest pipelines for the node.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/nodes._types:IngestTotal" + } + }, + "total": { + "$ref": "#/components/schemas/nodes._types:IngestTotal" + } + } + }, + "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" + }, + "processors": { + "description": "Total number of ingest processors.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/nodes._types:KeyedProcessor" + } + } + }, + "time_in_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + } + } + }, + "nodes._types:KeyedProcessor": { + "type": "object", + "properties": { + "stats": { + "$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": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + } + } + }, + "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" + } + } + }, + "indices._types:IndexState": { + "type": "object", + "properties": { + "aliases": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + }, + "defaults": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + }, + "data_stream": { + "$ref": "#/components/schemas/_types:DataStreamName" + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + } + } + }, + "indices._types:Alias": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "index_routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "is_hidden": { + "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", + "type": "boolean" + }, + "is_write_index": { + "description": "If `true`, the index is the write index for the alias.", + "type": "boolean" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "search_routing": { + "$ref": "#/components/schemas/_types:Routing" + } + } + }, + "_types:DataStreamName": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-data-stream.html#indices-create-data-stream-api-path-params" + }, + "type": "string" + }, + "indices._types:DataStreamLifecycle": { + "type": "object", + "properties": { + "data_retention": { + "$ref": "#/components/schemas/_types:Duration" + }, + "downsampling": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" + } + } + }, + "_types:Result": { + "type": "string", + "enum": [ + "created", + "updated", + "deleted", + "not_found", + "noop" + ] + }, + "connector._types:Connector": { + "type": "object", + "properties": { + "api_key_id": { + "type": "string" + }, + "configuration": { + "$ref": "#/components/schemas/connector._types:ConnectorConfiguration" + }, + "custom_scheduling": { + "$ref": "#/components/schemas/connector._types:ConnectorCustomScheduling" + }, + "description": { + "type": "string" + }, + "error": { + "type": "string" + }, + "features": { + "$ref": "#/components/schemas/connector._types:ConnectorFeatures" + }, + "filtering": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:FilteringConfig" + } + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "index_name": { + "type": "string" + }, + "is_native": { + "type": "boolean" + }, + "language": { + "type": "string" + }, + "last_access_control_sync_error": { + "type": "string" + }, + "last_access_control_sync_scheduled_at": { + "type": "string" + }, + "last_access_control_sync_status": { + "$ref": "#/components/schemas/connector._types:SyncStatus" + }, + "last_deleted_document_count": { + "type": "number" + }, + "last_incremental_sync_scheduled_at": { + "type": "string" + }, + "last_indexed_document_count": { + "type": "number" + }, + "last_seen": { + "type": "string" + }, + "last_sync_error": { + "type": "string" + }, + "last_sync_scheduled_at": { + "type": "string" + }, + "last_sync_status": { + "$ref": "#/components/schemas/connector._types:SyncStatus" + }, + "last_synced": { + "type": "string" + }, + "name": { + "type": "string" + }, + "pipeline": { + "$ref": "#/components/schemas/connector._types:IngestPipelineParams" + }, + "scheduling": { + "$ref": "#/components/schemas/connector._types:SchedulingConfiguration" + }, + "service_type": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/connector._types:ConnectorStatus" + }, + "sync_now": { + "type": "boolean" + } + }, + "required": [ + "configuration", + "custom_scheduling", + "features", + "filtering", + "is_native", + "scheduling", + "service_type", + "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": { + "$ref": "#/components/schemas/_types:ScalarValue" + }, + "depends_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:Dependency" + } + }, + "display": { + "$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": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/connector._types:ConnectorFieldType" + }, + "ui_restrictions": { + "type": "array", + "items": { + "type": "string" + } + }, + "validations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:Validation" + } + }, + "value": { + "$ref": "#/components/schemas/_types:ScalarValue" + } + }, + "required": [ + "default_value", + "depends_on", + "display", + "label", + "options", + "required", + "sensitive", + "type", + "ui_restrictions", + "validations", + "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": { + "$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": { + "type": "string" + } + }, + "required": [ + "label", + "value" + ] + }, + "connector._types:ConnectorFieldType": { + "type": "string", + "enum": [ + "str", + "int", + "list", + "bool" + ] + }, + "connector._types:Validation": { + "discriminator": { + "propertyName": "type" + }, + "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": "array", + "items": { + "$ref": "#/components/schemas/_types:ScalarValue" + } + } + }, + "required": [ + "type", + "constraint" ] }, - "_types.mapping:IndexField": { + "connector._types:IncludedInValidation": { "type": "object", "properties": { - "enabled": { - "type": "boolean" + "type": { + "type": "string", + "enum": [ + "\"included_in\"" + ] + }, + "constraint": { + "type": "string" } }, "required": [ - "enabled" + "type", + "constraint" ] }, - "_types.mapping:RoutingField": { + "connector._types:RegexValidation": { "type": "object", "properties": { - "required": { - "type": "boolean" + "type": { + "type": "string", + "enum": [ + "\"regex\"" + ] + }, + "constraint": { + "type": "string" } }, "required": [ - "required" + "type", + "constraint" ] }, - "_types.mapping:SizeField": { + "connector._types:ConnectorCustomScheduling": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/connector._types:CustomScheduling" + } + }, + "connector._types:CustomScheduling": { "type": "object", "properties": { + "configuration_overrides": { + "$ref": "#/components/schemas/connector._types:CustomSchedulingConfigurationOverrides" + }, "enabled": { "type": "boolean" + }, + "interval": { + "type": "string" + }, + "last_synced": { + "type": "string" + }, + "name": { + "type": "string" } }, "required": [ - "enabled" + "configuration_overrides", + "enabled", + "interval", + "name" ] }, - "_types.mapping:SourceField": { + "connector._types:CustomSchedulingConfigurationOverrides": { "type": "object", "properties": { - "compress": { - "type": "boolean" - }, - "compress_threshold": { - "type": "string" + "max_crawl_depth": { + "type": "number" }, - "enabled": { + "sitemap_discovery_disabled": { "type": "boolean" }, - "excludes": { + "domain_allowlist": { "type": "array", "items": { "type": "string" } }, - "includes": { + "sitemap_urls": { "type": "array", "items": { "type": "string" } }, - "mode": { - "$ref": "#/components/schemas/_types.mapping:SourceFieldMode" + "seed_urls": { + "type": "array", + "items": { + "type": "string" + } } } }, - "_types.mapping:SourceFieldMode": { - "type": "string", - "enum": [ - "disabled", - "stored", - "synthetic" - ] - }, - "_types.mapping:DataStreamTimestamp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "required": [ - "enabled" - ] - }, - "indices._types:AliasDefinition": { + "connector._types:ConnectorFeatures": { "type": "object", "properties": { - "filter": { - "$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" + "document_level_security": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" }, - "is_write_index": { - "description": "If `true`, the index is the write index for the alias.", + "filtering_advanced_config": { "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.", + "filtering_rules": { "type": "boolean" - } - } - }, - "indices._types:DataStreamLifecycleWithRollover": { - "type": "object", - "properties": { - "data_retention": { - "$ref": "#/components/schemas/_types:Duration" }, - "downsampling": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" + "incremental_sync": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" }, - "rollover": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleRolloverConditions" + "sync_rules": { + "$ref": "#/components/schemas/connector._types:SyncRulesFeature" } } }, - "indices._types:DataStreamLifecycleDownsampling": { + "connector._types:FeatureEnabled": { "type": "object", "properties": { - "rounds": { - "description": "The list of downsampling rounds to execute as part of this downsampling configuration", - "type": "array", - "items": { - "$ref": "#/components/schemas/indices._types:DownsamplingRound" - } + "enabled": { + "type": "boolean" } }, "required": [ - "rounds" + "enabled" ] }, - "indices._types:DownsamplingRound": { + "connector._types:SyncRulesFeature": { "type": "object", "properties": { - "after": { - "$ref": "#/components/schemas/_types:Duration" + "advanced": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" }, - "config": { - "$ref": "#/components/schemas/indices._types:DownsampleConfig" + "basic": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" } - }, - "required": [ - "after", - "config" - ] + } }, - "indices._types:DownsampleConfig": { + "connector._types:FilteringConfig": { "type": "object", "properties": { - "fixed_interval": { - "$ref": "#/components/schemas/_types:DurationLarge" + "active": { + "$ref": "#/components/schemas/connector._types:FilteringRules" + }, + "domain": { + "type": "string" + }, + "draft": { + "$ref": "#/components/schemas/connector._types:FilteringRules" } }, "required": [ - "fixed_interval" + "active", + "domain", + "draft" ] }, - "indices._types:DataStreamLifecycleRolloverConditions": { + "connector._types:FilteringRules": { "type": "object", "properties": { - "min_age": { - "$ref": "#/components/schemas/_types:Duration" - }, - "max_age": { - "type": "string" - }, - "min_docs": { - "type": "number" - }, - "max_docs": { - "type": "number" - }, - "min_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "max_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "min_primary_shard_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "max_primary_shard_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "min_primary_shard_docs": { - "type": "number" - }, - "max_primary_shard_docs": { - "type": "number" - } - } - }, - "_types:ClusterInfoTargets": { - "oneOf": [ - { - "$ref": "#/components/schemas/_types:ClusterInfoTarget" + "advanced_snippet": { + "$ref": "#/components/schemas/connector._types:FilteringAdvancedSnippet" }, - { + "rules": { "type": "array", "items": { - "$ref": "#/components/schemas/_types:ClusterInfoTarget" + "$ref": "#/components/schemas/connector._types:FilteringRule" } + }, + "validation": { + "$ref": "#/components/schemas/connector._types:FilteringRulesValidation" } + }, + "required": [ + "advanced_snippet", + "rules", + "validation" ] }, - "_types:ClusterInfoTarget": { - "type": "string", - "enum": [ - "_all", - "http", - "ingest", - "thread_pool", - "script" - ] - }, - "nodes._types:Http": { + "connector._types:FilteringAdvancedSnippet": { "type": "object", "properties": { - "current_open": { - "description": "Current number of open HTTP connections for the node.", - "type": "number" + "created_at": { + "type": "string" }, - "total_opened": { - "description": "Total number of HTTP connections opened for the node.", - "type": "number" + "updated_at": { + "type": "string" }, - "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" + "value": { + "type": "object", + "additionalProperties": { + "type": "object" } } - } + }, + "required": [ + "created_at", + "updated_at", + "value" + ] }, - "nodes._types:Client": { + "connector._types:FilteringRule": { "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.", + "created_at": { "type": "string" }, - "remote_address": { - "description": "Remote address for the HTTP connection.", + "field": { "type": "string" }, - "last_uri": { - "description": "The URI of the client’s most recent request.", + "id": { "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.", + "order": { "type": "number" }, - "last_request_time_millis": { - "description": "Time of the most recent request from this client.", - "type": "number" + "policy": { + "$ref": "#/components/schemas/connector._types:FilteringPolicy" }, - "request_count": { - "description": "Number of requests from this client.", - "type": "number" + "rule": { + "$ref": "#/components/schemas/connector._types:FilteringRuleRule" }, - "request_size_bytes": { - "description": "Cumulative size in bytes of all requests from this client.", - "type": "number" + "updated_at": { + "type": "string" }, - "x_opaque_id": { - "description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.", + "value": { "type": "string" } - } + }, + "required": [ + "created_at", + "field", + "id", + "order", + "policy", + "rule", + "updated_at", + "value" + ] }, - "nodes._types:Ingest": { - "type": "object", - "properties": { - "pipelines": { - "description": "Contains statistics about ingest pipelines for the node.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/nodes._types:IngestTotal" - } - }, - "total": { - "$ref": "#/components/schemas/nodes._types:IngestTotal" - } - } + "connector._types:FilteringPolicy": { + "type": "string", + "enum": [ + "exclude", + "include" + ] }, - "nodes._types:IngestTotal": { + "connector._types:FilteringRuleRule": { + "type": "string", + "enum": [ + "contains", + "ends_with", + "equals", + "regex", + "starts_with", + ">", + "<" + ] + }, + "connector._types:FilteringRulesValidation": { "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.", + "errors": { "type": "array", "items": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/nodes._types:KeyedProcessor" - } + "$ref": "#/components/schemas/connector._types:FilteringValidation" } }, - "time_in_millis": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" - } - } - }, - "nodes._types:KeyedProcessor": { - "type": "object", - "properties": { - "stats": { - "$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": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" - } - } - }, - "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" + "state": { + "$ref": "#/components/schemas/connector._types:FilteringValidationState" } - } + }, + "required": [ + "errors", + "state" + ] }, - "nodes._types:Scripting": { + "connector._types:FilteringValidation": { "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" + "ids": { + "type": "array", + "items": { + "type": "string" } }, - "compilation_limit_triggered": { - "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", - "type": "number" - }, - "contexts": { + "messages": { "type": "array", "items": { - "$ref": "#/components/schemas/nodes._types:Context" + "type": "string" } } - } + }, + "required": [ + "ids", + "messages" + ] }, - "nodes._types:Context": { + "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": { - "context": { - "type": "string" + "extract_binary_content": { + "type": "boolean" }, - "compilations": { - "type": "number" + "name": { + "type": "string" }, - "cache_evictions": { - "type": "number" + "reduce_whitespace": { + "type": "boolean" }, - "compilation_limit_triggered": { - "type": "number" + "run_ml_inference": { + "type": "boolean" } - } + }, + "required": [ + "extract_binary_content", + "name", + "reduce_whitespace", + "run_ml_inference" + ] }, - "indices._types:IndexState": { + "connector._types:SchedulingConfiguration": { "type": "object", "properties": { - "aliases": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/indices._types:Alias" - } - }, - "mappings": { - "$ref": "#/components/schemas/_types.mapping:TypeMapping" - }, - "settings": { - "$ref": "#/components/schemas/indices._types:IndexSettings" - }, - "defaults": { - "$ref": "#/components/schemas/indices._types:IndexSettings" + "access_control": { + "$ref": "#/components/schemas/connector._types:ConnectorScheduling" }, - "data_stream": { - "$ref": "#/components/schemas/_types:DataStreamName" + "full": { + "$ref": "#/components/schemas/connector._types:ConnectorScheduling" }, - "lifecycle": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + "incremental": { + "$ref": "#/components/schemas/connector._types:ConnectorScheduling" } } }, - "indices._types:Alias": { + "connector._types:ConnectorScheduling": { "type": "object", "properties": { - "filter": { - "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" - }, - "index_routing": { - "$ref": "#/components/schemas/_types:Routing" - }, - "is_hidden": { - "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", - "type": "boolean" - }, - "is_write_index": { - "description": "If `true`, the index is the write index for the alias.", + "enabled": { "type": "boolean" }, - "routing": { - "$ref": "#/components/schemas/_types:Routing" - }, - "search_routing": { - "$ref": "#/components/schemas/_types:Routing" + "interval": { + "description": "The interval is expressed using the crontab syntax", + "type": "string" } - } - }, - "_types:DataStreamName": { - "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-data-stream.html#indices-create-data-stream-api-path-params" }, - "type": "string" + "required": [ + "enabled", + "interval" + ] }, - "indices._types:DataStreamLifecycle": { - "type": "object", - "properties": { - "data_retention": { - "$ref": "#/components/schemas/_types:Duration" + "connector._types:ConnectorStatus": { + "type": "string", + "enum": [ + "created", + "needs_configuration", + "configured", + "connected", + "error" + ] + }, + "_spec_utils:WithNullValuestring": { + "description": "`WithNullValue` allows for explicit null assignments in contexts where `null` should be interpreted as an\nactual value.", + "oneOf": [ + { + "type": "string" }, - "downsampling": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" + { + "$ref": "#/components/schemas/_spec_utils:NullValue" } - } + ] + }, + "_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" }, "_types:WriteResponseBase": { "type": "object", @@ -48029,16 +49937,6 @@ "_version" ] }, - "_types:Result": { - "type": "string", - "enum": [ - "created", - "updated", - "deleted", - "not_found", - "noop" - ] - }, "_types:Conflicts": { "type": "string", "enum": [ diff --git a/output/schema/schema.json b/output/schema/schema.json index 0b782fe840..0a9bfab9df 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -3076,48 +3076,38 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Returns number of documents matching a query.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", - "name": "count", + "description": "Updates the last_seen timestamp in the connector document.", + "docId": "connector-checkin", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html", + "name": "connector.check_in", "request": { "name": "Request", - "namespace": "_global.count" + "namespace": "connector.check_in" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "_global.count" + "namespace": "connector.check_in" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST", - "GET" - ], - "path": "/_count" - }, - { - "methods": [ - "POST", - "GET" + "PUT" ], - "path": "/{index}/_count" + "path": "/_connector/{connector_id}/_check_in" } ], "visibility": "public" @@ -3125,143 +3115,158 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "5.0.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", - "name": "create", + "description": "Deletes a connector.", + "docId": "connector-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html", + "name": "connector.delete", "request": { "name": "Request", - "namespace": "_global.create" + "namespace": "connector.delete" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "_global.create" + "namespace": "connector.delete" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "PUT", - "POST" + "DELETE" ], - "path": "/{index}/_create/{id}" + "path": "/_connector/{connector_id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, "stack": { - "since": "7.9.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Deletes the specified dangling index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", - "name": "dangling_indices.delete_dangling_index", + "description": "Returns the details about a connector.", + "docId": "connector-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html", + "name": "connector.get", "request": { "name": "Request", - "namespace": "dangling_indices.delete_dangling_index" + "namespace": "connector.get" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "dangling_indices.delete_dangling_index" + "namespace": "connector.get" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_dangling/{index_uuid}" + "path": "/_connector/{connector_id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, "stack": { - "since": "7.9.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Imports the specified dangling index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", - "name": "dangling_indices.import_dangling_index", + "description": "Updates the stats of last sync in the connector document.", + "docId": "connector-last-sync", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html", + "name": "connector.last_sync", "request": { "name": "Request", - "namespace": "dangling_indices.import_dangling_index" + "namespace": "connector.last_sync" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "dangling_indices.import_dangling_index" + "namespace": "connector.last_sync" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_dangling/{index_uuid}" + "path": "/_connector/{connector_id}/_last_sync" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, "stack": { - "since": "7.9.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Returns all dangling indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", - "name": "dangling_indices.list_dangling_indices", + "description": "Lists all connectors.", + "docId": "connector-list", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html", + "name": "connector.list", "request": { "name": "Request", - "namespace": "dangling_indices.list_dangling_indices" + "namespace": "connector.list" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "dangling_indices.list_dangling_indices" + "namespace": "connector.list" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ "GET" ], - "path": "/_dangling" + "path": "/_connector" } ], "visibility": "public" @@ -3269,37 +3274,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Removes a document from the index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", - "name": "delete", + "description": "Creates a connector.", + "docId": "connector-post", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", + "name": "connector.post", "request": { "name": "Request", - "namespace": "_global.delete" + "namespace": "connector.post" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.delete" + "namespace": "connector.post" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/{index}/_doc/{id}" + "path": "/_connector" } ], "visibility": "public" @@ -3307,20 +3316,21 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "5.0.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Deletes documents matching the provided query.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", - "name": "delete_by_query", + "description": "Creates or updates a connector.", + "docId": "connector-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", + "name": "connector.put", "request": { "name": "Request", - "namespace": "_global.delete_by_query" + "namespace": "connector.put" }, "requestBodyRequired": true, "requestMediaType": [ @@ -3328,19 +3338,19 @@ ], "response": { "name": "Response", - "namespace": "_global.delete_by_query" + "namespace": "connector.put" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/{index}/_delete_by_query" + "path": "/_connector/{connector_id}" } ], "visibility": "public" @@ -3348,37 +3358,41 @@ { "availability": { "serverless": { - "stability": "stable", - "visibility": "private" + "stability": "experimental", + "visibility": "public" }, "stack": { - "since": "6.5.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Changes the number of requests per second for a particular Delete By Query operation.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", - "name": "delete_by_query_rethrottle", + "description": "Updates the API key id and/or API key secret id fields in the connector document.", + "docId": "connector-update-api-key-id", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-api-key-id-api.html", + "name": "connector.update_api_key_id", "request": { "name": "Request", - "namespace": "_global.delete_by_query_rethrottle" + "namespace": "connector.update_api_key_id" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.delete_by_query_rethrottle" + "namespace": "connector.update_api_key_id" }, "responseMediaType": [ "application/json" ], - "since": "6.5.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_delete_by_query/{task_id}/_rethrottle" + "path": "/_connector/{connector_id}/_api_key_id" } ], "visibility": "public" @@ -3386,37 +3400,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Deletes a script.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", - "name": "delete_script", + "description": "Updates the connector configuration.", + "docId": "connector-configuration", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-configuration-api.html", + "name": "connector.update_configuration", "request": { "name": "Request", - "namespace": "_global.delete_script" + "namespace": "connector.update_configuration" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.delete_script" + "namespace": "connector.update_configuration" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "PUT" ], - "path": "/_scripts/{id}" + "path": "/_connector/{connector_id}/_configuration" } ], "visibility": "public" @@ -3424,37 +3442,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.5.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Deletes an existing enrich policy and its enrich index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", - "name": "enrich.delete_policy", + "description": "Updates the error field in the connector document.", + "docId": "connector-update-error", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-error-api.html", + "name": "connector.update_error", "request": { "name": "Request", - "namespace": "enrich.delete_policy" + "namespace": "connector.update_error" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "enrich.delete_policy" + "namespace": "connector.update_error" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "PUT" ], - "path": "/_enrich/policy/{name}" + "path": "/_connector/{connector_id}/_error" } ], "visibility": "public" @@ -3462,38 +3484,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.5.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Creates the enrich index for an existing enrich policy.", - "docId": "execute-enrich-policy-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html", - "name": "enrich.execute_policy", + "description": "Updates the filtering field in the connector document.", + "docId": "connector-update-filtering", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", + "name": "connector.update_filtering", "request": { "name": "Request", - "namespace": "enrich.execute_policy" + "namespace": "connector.update_filtering" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "enrich.execute_policy" + "namespace": "connector.update_filtering" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ "PUT" ], - "path": "/_enrich/policy/{name}/_execute" + "path": "/_connector/{connector_id}/_filtering" } ], "visibility": "public" @@ -3501,43 +3526,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.5.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Gets information about an enrich policy.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", - "name": "enrich.get_policy", + "description": "Updates the index name of the connector.", + "docId": "connector-update-index-name", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-index-name-api.html", + "name": "connector.update_index_name", "request": { "name": "Request", - "namespace": "enrich.get_policy" + "namespace": "connector.update_index_name" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "enrich.get_policy" + "namespace": "connector.update_index_name" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET" - ], - "path": "/_enrich/policy/{name}" - }, - { - "methods": [ - "GET" + "PUT" ], - "path": "/_enrich/policy" + "path": "/_connector/{connector_id}/_index_name" } ], "visibility": "public" @@ -3545,21 +3568,21 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.5.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Creates a new enrich policy.", - "docId": "put-enrich-policy-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html", - "name": "enrich.put_policy", + "description": "Updates the name and/or description fields in the connector document.", + "docId": "connector-update-name", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-name-description-api.html", + "name": "connector.update_name", "request": { "name": "Request", - "namespace": "enrich.put_policy" + "namespace": "connector.update_name" }, "requestBodyRequired": true, "requestMediaType": [ @@ -3567,19 +3590,19 @@ ], "response": { "name": "Response", - "namespace": "enrich.put_policy" + "namespace": "connector.update_name" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ "PUT" ], - "path": "/_enrich/policy/{name}" + "path": "/_connector/{connector_id}/_name" } ], "visibility": "public" @@ -3587,37 +3610,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.5.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Gets enrich coordinator statistics and information about enrich policies that are currently executing.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", - "name": "enrich.stats", + "description": "Updates the is_native flag of the connector.", + "docId": "connector-update-native", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-native-api.html", + "name": "connector.update_native", "request": { "name": "Request", - "namespace": "enrich.stats" + "namespace": "connector.update_native" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "enrich.stats" + "namespace": "connector.update_native" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/_enrich/_stats" + "path": "/_connector/{connector_id}/_native" } ], "visibility": "public" @@ -3625,37 +3652,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.9.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", - "name": "eql.delete", + "description": "Updates the pipeline field in the connector document.", + "docId": "connector-update-pipeline", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-pipeline-api.html", + "name": "connector.update_pipeline", "request": { "name": "Request", - "namespace": "eql.delete" + "namespace": "connector.update_pipeline" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "eql.delete" + "namespace": "connector.update_pipeline" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "PUT" ], - "path": "/_eql/search/{id}" + "path": "/_connector/{connector_id}/_pipeline" } ], "visibility": "public" @@ -3663,38 +3694,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.9.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Returns async results from previously executed Event Query Language (EQL) search", - "docId": "eql-async-search-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", - "name": "eql.get", + "description": "Updates the scheduling field in the connector document.", + "docId": "connector-update-scheduling", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-scheduling-api.html", + "name": "connector.update_scheduling", "request": { "name": "Request", - "namespace": "eql.get" + "namespace": "connector.update_scheduling" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "eql.get" + "namespace": "connector.update_scheduling" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/_eql/search/{id}" + "path": "/_connector/{connector_id}/_scheduling" } ], "visibility": "public" @@ -3702,38 +3736,41 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.9.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", - "docId": "eql-async-search-status-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", - "name": "eql.get_status", + "description": "Updates the service type of the connector.", + "docId": "connector-update-service-type", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-service-type-api.html", + "name": "connector.update_service_type", "request": { "name": "Request", - "namespace": "eql.get_status" + "namespace": "connector.update_service_type" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "eql.get_status" + "namespace": "connector.update_service_type" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/_eql/search/status/{id}" + "path": "/_connector/{connector_id}/_service_type" } ], "visibility": "public" @@ -3741,20 +3778,21 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.9.0", - "stability": "stable" + "since": "8.12.0", + "stability": "experimental" } }, - "description": "Returns results matching a query expressed in Event Query Language (EQL)", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", - "name": "eql.search", + "description": "Updates the status of the connector.", + "docId": "connector-update-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-status-api.html", + "name": "connector.update_status", "request": { "name": "Request", - "namespace": "eql.search" + "namespace": "connector.update_status" }, "requestBodyRequired": true, "requestMediaType": [ @@ -3762,58 +3800,68 @@ ], "response": { "name": "Response", - "namespace": "eql.search" + "namespace": "connector.update_status" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", - "stability": "stable", + "since": "8.12.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET", - "POST" + "PUT" ], - "path": "/{index}/_eql/search" + "path": "/_connector/{connector_id}/_status" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "8.11.0", - "stability": "experimental" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Executes an ESQL request", - "docId": "esql-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html", - "name": "esql.query", + "description": "Returns number of documents matching a query.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", + "name": "count", "request": { "name": "Request", - "namespace": "esql.query" + "namespace": "_global.count" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "esql.query" + "namespace": "_global.count" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "POST" + "POST", + "GET" ], - "path": "/_query" + "path": "/_count" + }, + { + "methods": [ + "POST", + "GET" + ], + "path": "/{index}/_count" } ], "visibility": "public" @@ -3825,113 +3873,105 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "5.0.0", "stability": "stable" } }, - "description": "Returns information about whether a document exists in an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", - "name": "exists", + "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", + "name": "create", "request": { "name": "Request", - "namespace": "_global.exists" + "namespace": "_global.create" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.exists" + "namespace": "_global.create" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "5.0.0", "stability": "stable", "urls": [ { "methods": [ - "HEAD" + "PUT", + "POST" ], - "path": "/{index}/_doc/{id}" + "path": "/{index}/_create/{id}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "5.4.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns information about whether a document source exists in an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", - "name": "exists_source", + "description": "Deletes the specified dangling index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", + "name": "dangling_indices.delete_dangling_index", "request": { "name": "Request", - "namespace": "_global.exists_source" + "namespace": "dangling_indices.delete_dangling_index" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "_global.exists_source" + "namespace": "dangling_indices.delete_dangling_index" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ - "HEAD" + "DELETE" ], - "path": "/{index}/_source/{id}" + "path": "/_dangling/{index_uuid}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns information about why a specific matches (or doesn't match) a query.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", - "name": "explain", + "description": "Imports the specified dangling index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", + "name": "dangling_indices.import_dangling_index", "request": { "name": "Request", - "namespace": "_global.explain" + "namespace": "dangling_indices.import_dangling_index" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "_global.explain" + "namespace": "dangling_indices.import_dangling_index" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ - "GET", "POST" ], - "path": "/{index}/_explain/{id}" + "path": "/_dangling/{index_uuid}" } ], "visibility": "public" @@ -3939,33 +3979,33 @@ { "availability": { "stack": { - "since": "7.12.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", - "name": "features.get_features", + "description": "Returns all dangling indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", + "name": "dangling_indices.list_dangling_indices", "request": { "name": "Request", - "namespace": "features.get_features" + "namespace": "dangling_indices.list_dangling_indices" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "features.get_features" + "namespace": "dangling_indices.list_dangling_indices" }, "responseMediaType": [ "application/json" ], - "since": "7.12.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_features" + "path": "/_dangling" } ], "visibility": "public" @@ -3973,37 +4013,37 @@ { "availability": { "serverless": { - "stability": "experimental", - "visibility": "private" + "stability": "stable", + "visibility": "public" }, "stack": { - "since": "7.12.0", - "stability": "experimental" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Resets the internal state of features, usually by deleting system indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "features.reset_features", + "description": "Removes a document from the index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", + "name": "delete", "request": { "name": "Request", - "namespace": "features.reset_features" + "namespace": "_global.delete" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "features.reset_features" + "namespace": "_global.delete" }, "responseMediaType": [ "application/json" ], - "since": "7.12.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "POST" + "DELETE" ], - "path": "/_features/_reset" + "path": "/{index}/_doc/{id}" } ], "visibility": "public" @@ -4015,146 +4055,112 @@ "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "5.0.0", "stability": "stable" } }, - "description": "Returns the information about the capabilities of fields among multiple indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", - "name": "field_caps", - "privileges": { - "index": [ - "view_index_metadata", - "read", - "manage" - ] - }, + "description": "Deletes documents matching the provided query.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", + "name": "delete_by_query", "request": { "name": "Request", - "namespace": "_global.field_caps" + "namespace": "_global.delete_by_query" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "_global.field_caps" + "namespace": "_global.delete_by_query" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "5.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_field_caps" - }, - { - "methods": [ - "GET", "POST" ], - "path": "/{index}/_field_caps" + "path": "/{index}/_delete_by_query" } ], "visibility": "public" }, { "availability": { - "stack": { - "stability": "experimental", + "serverless": { + "stability": "stable", "visibility": "private" - } - }, - "description": "Deletes a secret stored by Fleet.", - "docUrl": null, - "name": "fleet.delete_secret", - "request": null, - "requestBodyRequired": false, - "response": null, - "responseMediaType": [ - "application/json" - ], - "stability": "experimental", - "urls": [ - { - "methods": [ - "DELETE" - ], - "path": "/_fleet/secret/{id}" - } - ], - "visibility": "private" - }, - { - "availability": { + }, "stack": { - "stability": "experimental", - "visibility": "private" + "since": "6.5.0", + "stability": "stable" } }, - "description": "Retrieves a secret stored by Fleet.", - "docUrl": null, - "name": "fleet.get_secret", - "request": null, + "description": "Changes the number of requests per second for a particular Delete By Query operation.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", + "name": "delete_by_query_rethrottle", + "request": { + "name": "Request", + "namespace": "_global.delete_by_query_rethrottle" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "_global.delete_by_query_rethrottle" + }, "responseMediaType": [ "application/json" ], - "stability": "experimental", + "since": "6.5.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_fleet/secret/{id}" + "path": "/_delete_by_query/{task_id}/_rethrottle" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "7.13.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", - "name": "fleet.global_checkpoints", + "description": "Deletes a script.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", + "name": "delete_script", "request": { "name": "Request", - "namespace": "fleet.global_checkpoints" + "namespace": "_global.delete_script" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "fleet.global_checkpoints" + "namespace": "_global.delete_script" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/{index}/_fleet/global_checkpoints" + "path": "/_scripts/{id}" } ], "visibility": "public" @@ -4162,127 +4168,120 @@ { "availability": { "serverless": { - "stability": "experimental", - "visibility": "private" + "stability": "stable", + "visibility": "public" }, "stack": { - "since": "7.16.0", - "stability": "experimental" + "since": "7.5.0", + "stability": "stable" } }, - "description": "Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.", - "docUrl": null, - "name": "fleet.msearch", - "privileges": { - "index": [ - "read" - ] - }, + "description": "Deletes an existing enrich policy and its enrich index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", + "name": "enrich.delete_policy", "request": { "name": "Request", - "namespace": "fleet.msearch" + "namespace": "enrich.delete_policy" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/x-ndjson" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "fleet.msearch" + "namespace": "enrich.delete_policy" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", - "stability": "experimental", + "since": "7.5.0", + "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_fleet/_fleet_msearch" - }, - { - "methods": [ - "GET", - "POST" + "DELETE" ], - "path": "/{index}/_fleet/_fleet_msearch" + "path": "/_enrich/policy/{name}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "stability": "experimental", - "visibility": "private" + "since": "7.5.0", + "stability": "stable" } }, - "description": "Creates a secret stored by Fleet.", - "docUrl": null, - "name": "fleet.post_secret", - "request": null, - "requestBodyRequired": true, - "response": null, + "description": "Creates the enrich index for an existing enrich policy.", + "docId": "execute-enrich-policy-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html", + "name": "enrich.execute_policy", + "request": { + "name": "Request", + "namespace": "enrich.execute_policy" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "enrich.execute_policy" + }, "responseMediaType": [ "application/json" ], - "stability": "experimental", + "since": "7.5.0", + "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_fleet/secret" + "path": "/_enrich/policy/{name}/_execute" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { "serverless": { - "stability": "experimental", - "visibility": "private" + "stability": "stable", + "visibility": "public" }, "stack": { - "since": "7.16.0", - "stability": "experimental" + "since": "7.5.0", + "stability": "stable" } }, - "description": "Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.", - "docUrl": null, - "name": "fleet.search", - "privileges": { - "index": [ - "read" - ] - }, + "description": "Gets information about an enrich policy.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", + "name": "enrich.get_policy", "request": { "name": "Request", - "namespace": "fleet.search" + "namespace": "enrich.get_policy" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "fleet.search" + "namespace": "enrich.get_policy" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", - "stability": "experimental", + "since": "7.5.0", + "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/{index}/_fleet/_fleet_search" + "path": "/_enrich/policy/{name}" + }, + { + "methods": [ + "GET" + ], + "path": "/_enrich/policy" } ], "visibility": "public" @@ -4294,33 +4293,37 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Returns a document.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", - "name": "get", + "description": "Creates a new enrich policy.", + "docId": "put-enrich-policy-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html", + "name": "enrich.put_policy", "request": { "name": "Request", - "namespace": "_global.get" + "namespace": "enrich.put_policy" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.get" + "namespace": "enrich.put_policy" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/{index}/_doc/{id}" + "path": "/_enrich/policy/{name}" } ], "visibility": "public" @@ -4332,101 +4335,110 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Returns a script.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", - "name": "get_script", + "description": "Gets enrich coordinator statistics and information about enrich policies that are currently executing.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", + "name": "enrich.stats", "request": { "name": "Request", - "namespace": "_global.get_script" + "namespace": "enrich.stats" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "_global.get_script" + "namespace": "enrich.stats" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_scripts/{id}" + "path": "/_enrich/_stats" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns all script contexts.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", - "name": "get_script_context", + "description": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", + "name": "eql.delete", "request": { "name": "Request", - "namespace": "_global.get_script_context" + "namespace": "eql.delete" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "_global.get_script_context" + "namespace": "eql.delete" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_script_context" + "path": "/_eql/search/{id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns available script types, languages and contexts", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", - "name": "get_script_languages", + "description": "Returns async results from previously executed Event Query Language (EQL) search", + "docId": "eql-async-search-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", + "name": "eql.get", "request": { "name": "Request", - "namespace": "_global.get_script_languages" + "namespace": "eql.get" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "_global.get_script_languages" + "namespace": "eql.get" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_script_language" + "path": "/_eql/search/{id}" } ], "visibility": "public" @@ -4438,33 +4450,34 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns the source of a document.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", - "name": "get_source", + "description": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", + "docId": "eql-async-search-status-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", + "name": "eql.get_status", "request": { "name": "Request", - "namespace": "_global.get_source" + "namespace": "eql.get_status" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "_global.get_source" + "namespace": "eql.get_status" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/{index}/_source/{id}" + "path": "/_eql/search/status/{id}" } ], "visibility": "public" @@ -4476,30 +4489,29 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Explore extracted and summarized information about the documents and terms in an index.", - "docId": "graph-explore-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html", - "name": "graph.explore", + "description": "Returns results matching a query expressed in Event Query Language (EQL)", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", + "name": "eql.search", "request": { "name": "Request", - "namespace": "graph.explore" + "namespace": "eql.search" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "graph.explore" + "namespace": "eql.search" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { @@ -4507,176 +4519,163 @@ "GET", "POST" ], - "path": "/{index}/_graph/explore" + "path": "/{index}/_eql/search" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "8.7.0", - "stability": "stable" + "since": "8.11.0", + "stability": "experimental" } }, - "description": "Returns the health of the cluster.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html", - "name": "health_report", + "description": "Executes an ESQL request", + "docId": "esql-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html", + "name": "esql.query", "request": { "name": "Request", - "namespace": "_global.health_report" + "namespace": "esql.query" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.health_report" + "namespace": "esql.query" }, "responseMediaType": [ "application/json" ], - "since": "8.7.0", - "stability": "stable", + "since": "8.11.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET" - ], - "path": "/_health_report" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_health_report/{feature}" + "path": "/_query" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.6.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", - "name": "ilm.delete_lifecycle", - "privileges": { - "cluster": [ - "manage_ilm" - ] - }, + "description": "Returns information about whether a document exists in an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", + "name": "exists", "request": { "name": "Request", - "namespace": "ilm.delete_lifecycle" + "namespace": "_global.exists" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ilm.delete_lifecycle" + "namespace": "_global.exists" }, "responseMediaType": [ "application/json" ], - "since": "6.6.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "HEAD" ], - "path": "/_ilm/policy/{policy}" + "path": "/{index}/_doc/{id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.6.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", - "name": "ilm.explain_lifecycle", - "privileges": { - "index": [ - "view_index_metadata", - "manage_ilm" - ] - }, + "description": "Returns information about whether a document source exists in an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", + "name": "exists_source", "request": { "name": "Request", - "namespace": "ilm.explain_lifecycle" + "namespace": "_global.exists_source" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ilm.explain_lifecycle" + "namespace": "_global.exists_source" }, "responseMediaType": [ "application/json" ], - "since": "6.6.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "HEAD" ], - "path": "/{index}/_ilm/explain" + "path": "/{index}/_source/{id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.6.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Returns the specified policy definition. Includes the policy version and last modified date.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", - "name": "ilm.get_lifecycle", - "privileges": { - "cluster": [ - "manage_ilm", - "read_ilm" - ] - }, + "description": "Returns information about why a specific matches (or doesn't match) a query.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", + "name": "explain", "request": { "name": "Request", - "namespace": "ilm.get_lifecycle" + "namespace": "_global.explain" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ilm.get_lifecycle" + "namespace": "_global.explain" }, "responseMediaType": [ "application/json" ], - "since": "6.6.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_ilm/policy/{policy}" - }, - { - "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_ilm/policy" + "path": "/{index}/_explain/{id}" } ], "visibility": "public" @@ -4684,87 +4683,99 @@ { "availability": { "stack": { - "since": "6.6.0", + "since": "7.12.0", "stability": "stable" } }, - "description": "Retrieves the current index lifecycle management (ILM) status.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", - "name": "ilm.get_status", + "description": "Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", + "name": "features.get_features", "request": { "name": "Request", - "namespace": "ilm.get_status" + "namespace": "features.get_features" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ilm.get_status" + "namespace": "features.get_features" }, "responseMediaType": [ "application/json" ], - "since": "6.6.0", + "since": "7.12.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_ilm/status" + "path": "/_features" } ], "visibility": "public" }, { "availability": { - "stack": { - "since": "7.14.0", - "stability": "stable" + "serverless": { + "stability": "experimental", + "visibility": "private" + }, + "stack": { + "since": "7.12.0", + "stability": "experimental" } }, - "description": "Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", - "name": "ilm.migrate_to_data_tiers", + "description": "Resets the internal state of features, usually by deleting system indices", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "features.reset_features", "request": { "name": "Request", - "namespace": "ilm.migrate_to_data_tiers" + "namespace": "features.reset_features" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ilm.migrate_to_data_tiers" + "namespace": "features.reset_features" }, "responseMediaType": [ "application/json" ], - "since": "7.14.0", - "stability": "stable", + "since": "7.12.0", + "stability": "experimental", "urls": [ { "methods": [ "POST" ], - "path": "/_ilm/migrate_to_data_tiers" + "path": "/_features/_reset" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.6.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Manually moves an index into the specified step and executes that step.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", - "name": "ilm.move_to_step", + "description": "Returns the information about the capabilities of fields among multiple indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", + "name": "field_caps", + "privileges": { + "index": [ + "view_index_metadata", + "read", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "ilm.move_to_step" + "namespace": "_global.field_caps" }, "requestBodyRequired": false, "requestMediaType": [ @@ -4772,19 +4783,27 @@ ], "response": { "name": "Response", - "namespace": "ilm.move_to_step" + "namespace": "_global.field_caps" }, "responseMediaType": [ "application/json" ], - "since": "6.6.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_ilm/move/{index}" + "path": "/_field_caps" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_field_caps" } ], "visibility": "public" @@ -4792,146 +4811,148 @@ { "availability": { "stack": { - "since": "6.6.0", - "stability": "stable" + "stability": "experimental", + "visibility": "private" } }, - "description": "Creates a lifecycle policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", - "name": "ilm.put_lifecycle", - "privileges": { - "cluster": [ - "manage_ilm" - ], - "index": [ - "manage" - ] - }, - "request": { - "name": "Request", - "namespace": "ilm.put_lifecycle" - }, + "description": "Deletes a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.delete_secret", + "request": null, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], - "response": { - "name": "Response", - "namespace": "ilm.put_lifecycle" - }, + "response": null, "responseMediaType": [ "application/json" ], - "since": "6.6.0", - "stability": "stable", + "stability": "experimental", "urls": [ { "methods": [ - "PUT" + "DELETE" ], - "path": "/_ilm/policy/{policy}" + "path": "/_fleet/secret/{id}" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { "stack": { - "since": "6.6.0", - "stability": "stable" + "stability": "experimental", + "visibility": "private" } }, - "description": "Removes the assigned lifecycle policy and stops managing the specified index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", - "name": "ilm.remove_policy", - "request": { - "name": "Request", - "namespace": "ilm.remove_policy" - }, + "description": "Retrieves a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.get_secret", + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "ilm.remove_policy" - }, + "response": null, "responseMediaType": [ "application/json" ], - "since": "6.6.0", - "stability": "stable", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/{index}/_ilm/remove" + "path": "/_fleet/secret/{id}" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "6.6.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Retries executing the policy for an index that is in the ERROR step.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", - "name": "ilm.retry", + "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", + "name": "fleet.global_checkpoints", "request": { "name": "Request", - "namespace": "ilm.retry" + "namespace": "fleet.global_checkpoints" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ilm.retry" + "namespace": "fleet.global_checkpoints" }, "responseMediaType": [ "application/json" ], - "since": "6.6.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/{index}/_ilm/retry" + "path": "/{index}/_fleet/global_checkpoints" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "experimental", + "visibility": "private" + }, "stack": { - "since": "6.6.0", - "stability": "stable" + "since": "7.16.0", + "stability": "experimental" } }, - "description": "Start the index lifecycle management (ILM) plugin.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", - "name": "ilm.start", + "description": "Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.", + "docUrl": null, + "name": "fleet.msearch", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", - "namespace": "ilm.start" + "namespace": "fleet.msearch" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": { "name": "Response", - "namespace": "ilm.start" + "namespace": "fleet.msearch" }, "responseMediaType": [ "application/json" ], - "since": "6.6.0", - "stability": "stable", + "since": "7.16.0", + "stability": "experimental", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_ilm/start" + "path": "/_fleet/_fleet_msearch" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_fleet/_fleet_msearch" } ], "visibility": "public" @@ -4939,81 +4960,73 @@ { "availability": { "stack": { - "since": "6.6.0", - "stability": "stable" + "stability": "experimental", + "visibility": "private" } }, - "description": "Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", - "name": "ilm.stop", - "request": { - "name": "Request", - "namespace": "ilm.stop" - }, - "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "ilm.stop" - }, + "description": "Creates a secret stored by Fleet.", + "docUrl": null, + "name": "fleet.post_secret", + "request": null, + "requestBodyRequired": true, + "response": null, "responseMediaType": [ "application/json" ], - "since": "6.6.0", - "stability": "stable", + "stability": "experimental", "urls": [ { "methods": [ "POST" ], - "path": "/_ilm/stop" + "path": "/_fleet/secret" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { "serverless": { - "stability": "stable", - "visibility": "public" + "stability": "experimental", + "visibility": "private" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "7.16.0", + "stability": "experimental" } }, - "description": "Creates or updates a document in an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", - "name": "index", + "description": "Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.", + "docUrl": null, + "name": "fleet.search", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", - "namespace": "_global.index" + "namespace": "fleet.search" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "_global.index" + "namespace": "fleet.search" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "7.16.0", + "stability": "experimental", "urls": [ { "methods": [ - "PUT", - "POST" - ], - "path": "/{index}/_doc/{id}" - }, - { - "methods": [ + "GET", "POST" ], - "path": "/{index}/_doc" + "path": "/{index}/_fleet/_fleet_search" } ], "visibility": "public" @@ -5025,33 +5038,33 @@ "visibility": "public" }, "stack": { - "since": "7.9.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Adds a block to an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", - "name": "indices.add_block", + "description": "Returns a document.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", + "name": "get", "request": { "name": "Request", - "namespace": "indices.add_block" + "namespace": "_global.get" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.add_block" + "namespace": "_global.get" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/{index}/_block/{block}" + "path": "/{index}/_doc/{id}" } ], "visibility": "public" @@ -5067,21 +5080,17 @@ "stability": "stable" } }, - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "docId": "indices-analyze", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", - "name": "indices.analyze", + "description": "Returns a script.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", + "name": "get_script", "request": { "name": "Request", - "namespace": "indices.analyze" + "namespace": "_global.get_script" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "indices.analyze" + "namespace": "_global.get_script" }, "responseMediaType": [ "application/json" @@ -5091,43 +5100,31 @@ "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_analyze" - }, - { - "methods": [ - "GET", - "POST" + "GET" ], - "path": "/{index}/_analyze" + "path": "/_scripts/{id}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { "since": "0.0.0", "stability": "stable" } }, - "description": "Clears all or specific caches for one or more indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", - "name": "indices.clear_cache", + "description": "Returns all script contexts.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", + "name": "get_script_context", "request": { "name": "Request", - "namespace": "indices.clear_cache" + "namespace": "_global.get_script_context" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.clear_cache" + "namespace": "_global.get_script_context" }, "responseMediaType": [ "application/json" @@ -5137,15 +5134,9 @@ "urls": [ { "methods": [ - "POST" - ], - "path": "/_cache/clear" - }, - { - "methods": [ - "POST" + "GET" ], - "path": "/{index}/_cache/clear" + "path": "/_script_context" } ], "visibility": "public" @@ -5153,37 +5144,33 @@ { "availability": { "stack": { - "since": "7.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Clones an index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", - "name": "indices.clone", + "description": "Returns available script types, languages and contexts", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", + "name": "get_script_languages", "request": { "name": "Request", - "namespace": "indices.clone" + "namespace": "_global.get_script_languages" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "indices.clone" + "namespace": "_global.get_script_languages" }, "responseMediaType": [ "application/json" ], - "since": "7.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/{index}/_clone/{target}" + "path": "/_script_language" } ], "visibility": "public" @@ -5192,25 +5179,24 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { "since": "0.0.0", "stability": "stable" } }, - "description": "Closes an index.", - "docId": "indices-close", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-close.html", - "name": "indices.close", + "description": "Returns the source of a document.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", + "name": "get_source", "request": { "name": "Request", - "namespace": "indices.close" + "namespace": "_global.get_source" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.close" + "namespace": "_global.get_source" }, "responseMediaType": [ "application/json" @@ -5220,9 +5206,9 @@ "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/{index}/_close" + "path": "/{index}/_source/{id}" } ], "visibility": "public" @@ -5238,19 +5224,13 @@ "stability": "stable" } }, - "description": "Creates an index with optional settings and mappings.", - "docId": "indices-create-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-index.html", - "name": "indices.create", - "privileges": { - "index": [ - "create_index", - "manage" - ] - }, + "description": "Explore extracted and summarized information about the documents and terms in an index.", + "docId": "graph-explore-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html", + "name": "graph.explore", "request": { "name": "Request", - "namespace": "indices.create" + "namespace": "graph.explore" }, "requestBodyRequired": false, "requestMediaType": [ @@ -5258,7 +5238,7 @@ ], "response": { "name": "Response", - "namespace": "indices.create" + "namespace": "graph.explore" }, "responseMediaType": [ "application/json" @@ -5268,9 +5248,10 @@ "urls": [ { "methods": [ - "PUT" + "GET", + "POST" ], - "path": "/{index}" + "path": "/{index}/_graph/explore" } ], "visibility": "public" @@ -5279,297 +5260,275 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.9.0", + "since": "8.7.0", "stability": "stable" } }, - "description": "Creates a data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "name": "indices.create_data_stream", - "privileges": { - "index": [ - "create_index" - ] - }, + "description": "Returns the health of the cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html", + "name": "health_report", "request": { "name": "Request", - "namespace": "indices.create_data_stream" + "namespace": "_global.health_report" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.create_data_stream" + "namespace": "_global.health_report" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "8.7.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_data_stream/{name}" + "path": "/_health_report" + }, + { + "methods": [ + "GET" + ], + "path": "/_health_report/{feature}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.9.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Provides statistics on operations happening in a data stream.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "name": "indices.data_streams_stats", + "description": "Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", + "name": "ilm.delete_lifecycle", "privileges": { - "index": [ - "monitor" + "cluster": [ + "manage_ilm" ] }, "request": { "name": "Request", - "namespace": "indices.data_streams_stats" + "namespace": "ilm.delete_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.data_streams_stats" + "namespace": "ilm.delete_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "6.6.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_data_stream/_stats" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_data_stream/{name}/_stats" + "path": "/_ilm/policy/{policy}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "0.0.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Deletes an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", - "name": "indices.delete", + "description": "Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", + "name": "ilm.explain_lifecycle", + "privileges": { + "index": [ + "view_index_metadata", + "manage_ilm" + ] + }, "request": { "name": "Request", - "namespace": "indices.delete" + "namespace": "ilm.explain_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.delete" + "namespace": "ilm.explain_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "6.6.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/{index}" + "path": "/{index}/_ilm/explain" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "0.0.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Deletes an alias.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "name": "indices.delete_alias", + "description": "Returns the specified policy definition. Includes the policy version and last modified date.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", + "name": "ilm.get_lifecycle", + "privileges": { + "cluster": [ + "manage_ilm", + "read_ilm" + ] + }, "request": { "name": "Request", - "namespace": "indices.delete_alias" + "namespace": "ilm.get_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.delete_alias" + "namespace": "ilm.get_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "6.6.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/{index}/_alias/{name}" + "path": "/_ilm/policy/{policy}" }, { "methods": [ - "DELETE" + "GET" ], - "path": "/{index}/_aliases/{name}" + "path": "/_ilm/policy" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "8.11.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Deletes the data stream lifecycle of the selected data streams.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", - "name": "indices.delete_data_lifecycle", + "description": "Retrieves the current index lifecycle management (ILM) status.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", + "name": "ilm.get_status", "request": { "name": "Request", - "namespace": "indices.delete_data_lifecycle" + "namespace": "ilm.get_status" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.delete_data_lifecycle" + "namespace": "ilm.get_status" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", + "since": "6.6.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_data_stream/{name}/_lifecycle" + "path": "/_ilm/status" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.9.0", + "since": "7.14.0", "stability": "stable" } }, - "description": "Deletes a data stream.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "name": "indices.delete_data_stream", - "privileges": { - "index": [ - "delete_index" - ] - }, + "description": "Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", + "name": "ilm.migrate_to_data_tiers", "request": { "name": "Request", - "namespace": "indices.delete_data_stream" + "namespace": "ilm.migrate_to_data_tiers" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "indices.delete_data_stream" + "namespace": "ilm.migrate_to_data_tiers" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "7.14.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_data_stream/{name}" + "path": "/_ilm/migrate_to_data_tiers" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.8.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Deletes an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", - "name": "indices.delete_index_template", - "privileges": { - "cluster": [ - "manage_index_templates", - "manage" - ] - }, + "description": "Manually moves an index into the specified step and executes that step.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", + "name": "ilm.move_to_step", "request": { "name": "Request", - "namespace": "indices.delete_index_template" + "namespace": "ilm.move_to_step" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "indices.delete_index_template" + "namespace": "ilm.move_to_step" }, "responseMediaType": [ "application/json" ], - "since": "7.8.0", + "since": "6.6.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_index_template/{name}" + "path": "/_ilm/move/{index}" } ], "visibility": "public" @@ -5577,202 +5536,180 @@ { "availability": { "stack": { - "since": "0.0.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Deletes an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html", - "name": "indices.delete_template", + "description": "Creates a lifecycle policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", + "name": "ilm.put_lifecycle", "privileges": { "cluster": [ - "manage_index_templates", + "manage_ilm" + ], + "index": [ "manage" ] }, "request": { "name": "Request", - "namespace": "indices.delete_template" + "namespace": "ilm.put_lifecycle" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "indices.delete_template" + "namespace": "ilm.put_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "6.6.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "PUT" ], - "path": "/_template/{name}" + "path": "/_ilm/policy/{policy}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "experimental", - "visibility": "private" - }, "stack": { - "since": "7.15.0", - "stability": "experimental" + "since": "6.6.0", + "stability": "stable" } }, - "description": "Analyzes the disk usage of each field of an index or data stream", - "docId": "indices-disk-usage", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-disk-usage.html", - "name": "indices.disk_usage", + "description": "Removes the assigned lifecycle policy and stops managing the specified index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", + "name": "ilm.remove_policy", "request": { "name": "Request", - "namespace": "indices.disk_usage" + "namespace": "ilm.remove_policy" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.disk_usage" + "namespace": "ilm.remove_policy" }, "responseMediaType": [ "application/json" ], - "since": "7.15.0", - "stability": "experimental", + "since": "6.6.0", + "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/{index}/_disk_usage" + "path": "/{index}/_ilm/remove" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "experimental", - "visibility": "private" - }, "stack": { - "since": "8.5.0", - "stability": "experimental" + "since": "6.6.0", + "stability": "stable" } }, - "description": "Downsample an index", - "docId": "indices-downsample-data-stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html", - "name": "indices.downsample", + "description": "Retries executing the policy for an index that is in the ERROR step.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", + "name": "ilm.retry", "request": { "name": "Request", - "namespace": "indices.downsample" + "namespace": "ilm.retry" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.downsample" + "namespace": "ilm.retry" }, "responseMediaType": [ "application/json" ], - "since": "8.5.0", - "stability": "experimental", + "since": "6.6.0", + "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/{index}/_downsample/{target_index}" + "path": "/{index}/_ilm/retry" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "0.0.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Returns information about whether a particular index exists.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", - "name": "indices.exists", + "description": "Start the index lifecycle management (ILM) plugin.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", + "name": "ilm.start", "request": { "name": "Request", - "namespace": "indices.exists" + "namespace": "ilm.start" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.exists" + "namespace": "ilm.start" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "6.6.0", "stability": "stable", "urls": [ { "methods": [ - "HEAD" + "POST" ], - "path": "/{index}" + "path": "/_ilm/start" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "0.0.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Returns information about whether a particular alias exists.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "name": "indices.exists_alias", + "description": "Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", + "name": "ilm.stop", "request": { "name": "Request", - "namespace": "indices.exists_alias" + "namespace": "ilm.stop" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.exists_alias" + "namespace": "ilm.stop" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "6.6.0", "stability": "stable", "urls": [ { "methods": [ - "HEAD" - ], - "path": "/_alias/{name}" - }, - { - "methods": [ - "HEAD" + "POST" ], - "path": "/{index}/_alias/{name}" + "path": "/_ilm/stop" } ], "visibility": "public" @@ -5788,17 +5725,20 @@ "stability": "stable" } }, - "description": "Returns information about whether a particular index template exists.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", - "name": "indices.exists_index_template", + "description": "Creates or updates a document in an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", + "name": "index", "request": { "name": "Request", - "namespace": "indices.exists_index_template" + "namespace": "_global.index" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "indices.exists_index_template" + "namespace": "_global.index" }, "responseMediaType": [ "application/json" @@ -5808,43 +5748,54 @@ "urls": [ { "methods": [ - "HEAD" + "PUT", + "POST" ], - "path": "/_index_template/{name}" + "path": "/{index}/_doc/{id}" + }, + { + "methods": [ + "POST" + ], + "path": "/{index}/_doc" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns information about whether a particular index template exists.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", - "name": "indices.exists_template", + "description": "Adds a block to an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", + "name": "indices.add_block", "request": { "name": "Request", - "namespace": "indices.exists_template" + "namespace": "indices.add_block" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.exists_template" + "namespace": "indices.add_block" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ - "HEAD" + "PUT" ], - "path": "/_template/{name}" + "path": "/{index}/_block/{block}" } ], "visibility": "public" @@ -5856,76 +5807,45 @@ "visibility": "public" }, "stack": { - "since": "8.11.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", - "name": "indices.explain_data_lifecycle", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "docId": "indices-analyze", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", + "name": "indices.analyze", "request": { "name": "Request", - "namespace": "indices.explain_data_lifecycle" + "namespace": "indices.analyze" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "indices.explain_data_lifecycle" + "namespace": "indices.analyze" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/{index}/_lifecycle/explain" - } - ], - "visibility": "public" - }, - { - "availability": { - "serverless": { - "stability": "experimental", - "visibility": "private" + "path": "/_analyze" }, - "stack": { - "since": "7.15.0", - "stability": "experimental" - } - }, - "description": "Returns the field usage stats for each field of an index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html", - "name": "indices.field_usage_stats", - "privileges": { - "index": [ - "manage" - ] - }, - "request": { - "name": "Request", - "namespace": "indices.field_usage_stats" - }, - "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "indices.field_usage_stats" - }, - "responseMediaType": [ - "application/json" - ], - "since": "7.15.0", - "stability": "experimental", - "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/{index}/_field_usage_stats" + "path": "/{index}/_analyze" } ], "visibility": "public" @@ -5941,18 +5861,17 @@ "stability": "stable" } }, - "description": "Performs the flush operation on one or more indices.", - "docId": "indices-flush", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-flush.html", - "name": "indices.flush", + "description": "Clears all or specific caches for one or more indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", + "name": "indices.clear_cache", "request": { "name": "Request", - "namespace": "indices.flush" + "namespace": "indices.clear_cache" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.flush" + "namespace": "indices.clear_cache" }, "responseMediaType": [ "application/json" @@ -5962,61 +5881,53 @@ "urls": [ { "methods": [ - "POST", - "GET" + "POST" ], - "path": "/_flush" + "path": "/_cache/clear" }, { "methods": [ - "POST", - "GET" + "POST" ], - "path": "/{index}/_flush" + "path": "/{index}/_cache/clear" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "2.1.0", + "since": "7.4.0", "stability": "stable" } }, - "description": "Performs the force merge operation on one or more indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", - "name": "indices.forcemerge", + "description": "Clones an index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", + "name": "indices.clone", "request": { "name": "Request", - "namespace": "indices.forcemerge" + "namespace": "indices.clone" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "indices.forcemerge" + "namespace": "indices.clone" }, "responseMediaType": [ "application/json" ], - "since": "2.1.0", + "since": "7.4.0", "stability": "stable", "urls": [ { "methods": [ + "PUT", "POST" ], - "path": "/_forcemerge" - }, - { - "methods": [ - "POST" - ], - "path": "/{index}/_forcemerge" + "path": "/{index}/_clone/{target}" } ], "visibility": "public" @@ -6025,30 +5936,25 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, - "description": "Returns information about one or more indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", - "name": "indices.get", - "privileges": { - "index": [ - "view_index_metadata", - "manage" - ] - }, + "description": "Closes an index.", + "docId": "indices-close", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-close.html", + "name": "indices.close", "request": { "name": "Request", - "namespace": "indices.get" + "namespace": "indices.close" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.get" + "namespace": "indices.close" }, "responseMediaType": [ "application/json" @@ -6058,9 +5964,9 @@ "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/{index}" + "path": "/{index}/_close" } ], "visibility": "public" @@ -6076,17 +5982,27 @@ "stability": "stable" } }, - "description": "Returns an alias.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "name": "indices.get_alias", + "description": "Creates an index with optional settings and mappings.", + "docId": "indices-create-index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-index.html", + "name": "indices.create", + "privileges": { + "index": [ + "create_index", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "indices.get_alias" + "namespace": "indices.create" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "indices.get_alias" + "namespace": "indices.create" }, "responseMediaType": [ "application/json" @@ -6096,27 +6012,9 @@ "urls": [ { "methods": [ - "GET" - ], - "path": "/_alias" - }, - { - "methods": [ - "GET" - ], - "path": "/_alias/{name}" - }, - { - "methods": [ - "GET" - ], - "path": "/{index}/_alias/{name}" - }, - { - "methods": [ - "GET" + "PUT" ], - "path": "/{index}/_alias" + "path": "/{index}" } ], "visibility": "public" @@ -6128,33 +6026,38 @@ "visibility": "public" }, "stack": { - "since": "8.11.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns the data stream lifecycle of the selected data streams.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", - "name": "indices.get_data_lifecycle", + "description": "Creates a data stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "name": "indices.create_data_stream", + "privileges": { + "index": [ + "create_index" + ] + }, "request": { "name": "Request", - "namespace": "indices.get_data_lifecycle" + "namespace": "indices.create_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.get_data_lifecycle" + "namespace": "indices.create_data_stream" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/_data_stream/{name}/_lifecycle" + "path": "/_data_stream/{name}" } ], "visibility": "public" @@ -6170,22 +6073,22 @@ "stability": "stable" } }, - "description": "Returns data streams.", + "description": "Provides statistics on operations happening in a data stream.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "name": "indices.get_data_stream", + "name": "indices.data_streams_stats", "privileges": { "index": [ - "view_index_metadata" + "monitor" ] }, "request": { "name": "Request", - "namespace": "indices.get_data_stream" + "namespace": "indices.data_streams_stats" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.get_data_stream" + "namespace": "indices.data_streams_stats" }, "responseMediaType": [ "application/json" @@ -6197,35 +6100,39 @@ "methods": [ "GET" ], - "path": "/_data_stream" + "path": "/_data_stream/_stats" }, { "methods": [ "GET" ], - "path": "/_data_stream/{name}" + "path": "/_data_stream/{name}/_stats" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { "since": "0.0.0", "stability": "stable" } }, - "description": "Returns mapping for one or more fields.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", - "name": "indices.get_field_mapping", + "description": "Deletes an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", + "name": "indices.delete", "request": { "name": "Request", - "namespace": "indices.get_field_mapping" + "namespace": "indices.delete" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.get_field_mapping" + "namespace": "indices.delete" }, "responseMediaType": [ "application/json" @@ -6235,15 +6142,9 @@ "urls": [ { "methods": [ - "GET" - ], - "path": "/_mapping/field/{fields}" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/{index}/_mapping/field/{fields}" + "path": "/{index}" } ], "visibility": "public" @@ -6255,45 +6156,39 @@ "visibility": "public" }, "stack": { - "since": "7.9.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Returns an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", - "name": "indices.get_index_template", - "privileges": { - "cluster": [ - "manage_index_templates", - "manage" - ] - }, + "description": "Deletes an alias.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", + "name": "indices.delete_alias", "request": { "name": "Request", - "namespace": "indices.get_index_template" + "namespace": "indices.delete_alias" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.get_index_template" + "namespace": "indices.delete_alias" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_index_template" + "path": "/{index}/_alias/{name}" }, { "methods": [ - "GET" + "DELETE" ], - "path": "/_index_template/{name}" + "path": "/{index}/_aliases/{name}" } ], "visibility": "public" @@ -6305,39 +6200,33 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "8.11.0", "stability": "stable" } }, - "description": "Returns mappings for one or more indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", - "name": "indices.get_mapping", + "description": "Deletes the data stream lifecycle of the selected data streams.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", + "name": "indices.delete_data_lifecycle", "request": { "name": "Request", - "namespace": "indices.get_mapping" + "namespace": "indices.delete_data_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.get_mapping" + "namespace": "indices.delete_data_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "8.11.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_mapping" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/{index}/_mapping" + "path": "/_data_stream/{name}/_lifecycle" } ], "visibility": "public" @@ -6349,141 +6238,122 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns settings for one or more indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", - "name": "indices.get_settings", + "description": "Deletes a data stream.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "name": "indices.delete_data_stream", "privileges": { "index": [ - "view_index_metadata", - "monitor", - "manage" + "delete_index" ] }, "request": { "name": "Request", - "namespace": "indices.get_settings" + "namespace": "indices.delete_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.get_settings" + "namespace": "indices.delete_data_stream" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_settings" - }, - { - "methods": [ - "GET" - ], - "path": "/{index}/_settings" - }, - { - "methods": [ - "GET" - ], - "path": "/{index}/_settings/{name}" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_settings/{name}" + "path": "/_data_stream/{name}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.8.0", "stability": "stable" } }, - "description": "Returns an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", - "name": "indices.get_template", + "description": "Deletes an index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", + "name": "indices.delete_index_template", + "privileges": { + "cluster": [ + "manage_index_templates", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "indices.get_template" + "namespace": "indices.delete_index_template" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.get_template" + "namespace": "indices.delete_index_template" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.8.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_template" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_template/{name}" + "path": "/_index_template/{name}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.9.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Migrates an alias to a data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "name": "indices.migrate_to_data_stream", + "description": "Deletes an index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html", + "name": "indices.delete_template", "privileges": { - "index": [ + "cluster": [ + "manage_index_templates", "manage" ] }, "request": { "name": "Request", - "namespace": "indices.migrate_to_data_stream" + "namespace": "indices.delete_template" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.migrate_to_data_stream" + "namespace": "indices.delete_template" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "DELETE" ], - "path": "/_data_stream/_migrate/{name}" + "path": "/_template/{name}" } ], "visibility": "public" @@ -6491,40 +6361,38 @@ { "availability": { "serverless": { - "stability": "stable", - "visibility": "public" + "stability": "experimental", + "visibility": "private" }, "stack": { - "since": "7.16.0", - "stability": "stable" + "since": "7.15.0", + "stability": "experimental" } }, - "description": "Modifies a data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "name": "indices.modify_data_stream", + "description": "Analyzes the disk usage of each field of an index or data stream", + "docId": "indices-disk-usage", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-disk-usage.html", + "name": "indices.disk_usage", "request": { "name": "Request", - "namespace": "indices.modify_data_stream" + "namespace": "indices.disk_usage" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.modify_data_stream" + "namespace": "indices.disk_usage" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", - "stability": "stable", + "since": "7.15.0", + "stability": "experimental", "urls": [ { "methods": [ "POST" ], - "path": "/_data_stream/_modify" + "path": "/{index}/_disk_usage" } ], "visibility": "public" @@ -6532,71 +6400,79 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "private" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "8.5.0", + "stability": "experimental" } }, - "description": "Opens an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", - "name": "indices.open", + "description": "Downsample an index", + "docId": "indices-downsample-data-stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html", + "name": "indices.downsample", "request": { "name": "Request", - "namespace": "indices.open" + "namespace": "indices.downsample" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "indices.open" + "namespace": "indices.downsample" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "8.5.0", + "stability": "experimental", "urls": [ { "methods": [ "POST" ], - "path": "/{index}/_open" + "path": "/{index}/_downsample/{target_index}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "7.9.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Promotes a data stream from a replicated data stream managed by CCR to a regular data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "name": "indices.promote_data_stream", + "description": "Returns information about whether a particular index exists.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", + "name": "indices.exists", "request": { "name": "Request", - "namespace": "indices.promote_data_stream" + "namespace": "indices.exists" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.promote_data_stream" + "namespace": "indices.exists" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "HEAD" ], - "path": "/_data_stream/_promote/{name}" + "path": "/{index}" } ], "visibility": "public" @@ -6612,20 +6488,17 @@ "stability": "stable" } }, - "description": "Creates or updates an alias.", + "description": "Returns information about whether a particular alias exists.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "name": "indices.put_alias", + "name": "indices.exists_alias", "request": { "name": "Request", - "namespace": "indices.put_alias" + "namespace": "indices.exists_alias" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "indices.put_alias" + "namespace": "indices.exists_alias" }, "responseMediaType": [ "application/json" @@ -6635,17 +6508,15 @@ "urls": [ { "methods": [ - "PUT", - "POST" + "HEAD" ], - "path": "/{index}/_alias/{name}" + "path": "/_alias/{name}" }, { "methods": [ - "PUT", - "POST" + "HEAD" ], - "path": "/{index}/_aliases/{name}" + "path": "/{index}/_alias/{name}" } ], "visibility": "public" @@ -6657,75 +6528,67 @@ "visibility": "public" }, "stack": { - "since": "8.11.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Updates the data stream lifecycle of the selected data streams.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", - "name": "indices.put_data_lifecycle", + "description": "Returns information about whether a particular index template exists.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", + "name": "indices.exists_index_template", "request": { "name": "Request", - "namespace": "indices.put_data_lifecycle" + "namespace": "indices.exists_index_template" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.put_data_lifecycle" + "namespace": "indices.exists_index_template" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "HEAD" ], - "path": "/_data_stream/{name}/_lifecycle" + "path": "/_index_template/{name}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.9.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Creates or updates an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", - "name": "indices.put_index_template", + "description": "Returns information about whether a particular index template exists.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", + "name": "indices.exists_template", "request": { "name": "Request", - "namespace": "indices.put_index_template" + "namespace": "indices.exists_template" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.put_index_template" + "namespace": "indices.exists_template" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "HEAD" ], - "path": "/_index_template/{name}" + "path": "/_template/{name}" } ], "visibility": "public" @@ -6737,37 +6600,33 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "8.11.0", "stability": "stable" } }, - "description": "Updates the index mappings.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", - "name": "indices.put_mapping", + "description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", + "name": "indices.explain_data_lifecycle", "request": { "name": "Request", - "namespace": "indices.put_mapping" + "namespace": "indices.explain_data_lifecycle" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.put_mapping" + "namespace": "indices.explain_data_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "8.11.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/{index}/_mapping" + "path": "/{index}/_lifecycle/explain" } ], "visibility": "public" @@ -6775,17 +6634,17 @@ { "availability": { "serverless": { - "stability": "stable", - "visibility": "public" + "stability": "experimental", + "visibility": "private" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "7.15.0", + "stability": "experimental" } }, - "description": "Updates the index settings.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", - "name": "indices.put_settings", + "description": "Returns the field usage stats for each field of an index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html", + "name": "indices.field_usage_stats", "privileges": { "index": [ "manage" @@ -6793,33 +6652,24 @@ }, "request": { "name": "Request", - "namespace": "indices.put_settings" + "namespace": "indices.field_usage_stats" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.put_settings" + "namespace": "indices.field_usage_stats" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "7.15.0", + "stability": "experimental", "urls": [ { "methods": [ - "PUT" - ], - "path": "/_settings" - }, - { - "methods": [ - "PUT" + "GET" ], - "path": "/{index}/_settings" + "path": "/{index}/_field_usage_stats" } ], "visibility": "public" @@ -6828,27 +6678,25 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, - "description": "Creates or updates an index template.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", - "name": "indices.put_template", + "description": "Performs the flush operation on one or more indices.", + "docId": "indices-flush", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-flush.html", + "name": "indices.flush", "request": { "name": "Request", - "namespace": "indices.put_template" + "namespace": "indices.flush" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.put_template" + "namespace": "indices.flush" }, "responseMediaType": [ "application/json" @@ -6858,10 +6706,17 @@ "urls": [ { "methods": [ - "PUT", - "POST" + "POST", + "GET" ], - "path": "/_template/{name}" + "path": "/_flush" + }, + { + "methods": [ + "POST", + "GET" + ], + "path": "/{index}/_flush" } ], "visibility": "public" @@ -6873,39 +6728,39 @@ "visibility": "private" }, "stack": { - "since": "0.0.0", + "since": "2.1.0", "stability": "stable" } }, - "description": "Returns information about ongoing index shard recoveries.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", - "name": "indices.recovery", + "description": "Performs the force merge operation on one or more indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", + "name": "indices.forcemerge", "request": { "name": "Request", - "namespace": "indices.recovery" + "namespace": "indices.forcemerge" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.recovery" + "namespace": "indices.forcemerge" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "2.1.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_recovery" + "path": "/_forcemerge" }, { "methods": [ - "GET" + "POST" ], - "path": "/{index}/_recovery" + "path": "/{index}/_forcemerge" } ], "visibility": "public" @@ -6921,17 +6776,23 @@ "stability": "stable" } }, - "description": "Performs the refresh operation in one or more indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", - "name": "indices.refresh", + "description": "Returns information about one or more indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", + "name": "indices.get", + "privileges": { + "index": [ + "view_index_metadata", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "indices.refresh" + "namespace": "indices.get" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.refresh" + "namespace": "indices.get" }, "responseMediaType": [ "application/json" @@ -6941,86 +6802,103 @@ "urls": [ { "methods": [ - "POST", - "GET" - ], - "path": "/_refresh" - }, - { - "methods": [ - "POST", "GET" ], - "path": "/{index}/_refresh" + "path": "/{index}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "7.3.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Reloads an index's search analyzers and their resources.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", - "name": "indices.reload_search_analyzers", + "description": "Returns an alias.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", + "name": "indices.get_alias", "request": { "name": "Request", - "namespace": "indices.reload_search_analyzers" + "namespace": "indices.get_alias" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.reload_search_analyzers" + "namespace": "indices.get_alias" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/{index}/_reload_search_analyzers" + "path": "/_alias" + }, + { + "methods": [ + "GET" + ], + "path": "/_alias/{name}" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_alias/{name}" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_alias" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "8.13.0", + "since": "8.11.0", "stability": "stable" } }, - "description": "Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html", - "name": "indices.resolve_cluster", + "description": "Returns the data stream lifecycle of the selected data streams.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", + "name": "indices.get_data_lifecycle", "request": { "name": "Request", - "namespace": "indices.resolve_cluster" + "namespace": "indices.get_data_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.resolve_cluster" + "namespace": "indices.get_data_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "8.13.0", + "since": "8.11.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_resolve/cluster/{name}" + "path": "/_data_stream/{name}/_lifecycle" } ], "visibility": "public" @@ -7036,17 +6914,22 @@ "stability": "stable" } }, - "description": "Returns information about any matching indices, aliases, and data streams", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", - "name": "indices.resolve_index", + "description": "Returns data streams.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "name": "indices.get_data_stream", + "privileges": { + "index": [ + "view_index_metadata" + ] + }, "request": { "name": "Request", - "namespace": "indices.resolve_index" + "namespace": "indices.get_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.resolve_index" + "namespace": "indices.get_data_stream" }, "responseMediaType": [ "application/json" @@ -7058,55 +6941,53 @@ "methods": [ "GET" ], - "path": "/_resolve/index/{name}" + "path": "/_data_stream" + }, + { + "methods": [ + "GET" + ], + "path": "/_data_stream/{name}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "5.0.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", - "docId": "indices-rollover-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html", - "name": "indices.rollover", + "description": "Returns mapping for one or more fields.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", + "name": "indices.get_field_mapping", "request": { "name": "Request", - "namespace": "indices.rollover" + "namespace": "indices.get_field_mapping" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "indices.rollover" + "namespace": "indices.get_field_mapping" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/{alias}/_rollover" + "path": "/_mapping/field/{fields}" }, { "methods": [ - "POST" + "GET" ], - "path": "/{alias}/_rollover/{new_index}" + "path": "/{index}/_mapping/field/{fields}" } ], "visibility": "public" @@ -7115,64 +6996,74 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Provides low-level information about segments in a Lucene index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", - "name": "indices.segments", + "description": "Returns an index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", + "name": "indices.get_index_template", + "privileges": { + "cluster": [ + "manage_index_templates", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "indices.segments" + "namespace": "indices.get_index_template" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.segments" + "namespace": "indices.get_index_template" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_segments" + "path": "/_index_template" }, { "methods": [ "GET" ], - "path": "/{index}/_segments" + "path": "/_index_template/{name}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { "since": "0.0.0", "stability": "stable" } }, - "description": "Provides store information for shard copies of indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", - "name": "indices.shard_stores", + "description": "Returns mappings for one or more indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", + "name": "indices.get_mapping", "request": { "name": "Request", - "namespace": "indices.shard_stores" + "namespace": "indices.get_mapping" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.shard_stores" + "namespace": "indices.get_mapping" }, "responseMediaType": [ "application/json" @@ -7184,93 +7075,116 @@ "methods": [ "GET" ], - "path": "/_shard_stores" + "path": "/_mapping" }, { "methods": [ "GET" ], - "path": "/{index}/_shard_stores" + "path": "/{index}/_mapping" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "5.0.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Allow to shrink an existing index into a new index with fewer primary shards.", - "docId": "indices-shrink-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shrink-index.html", - "name": "indices.shrink", + "description": "Returns settings for one or more indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", + "name": "indices.get_settings", + "privileges": { + "index": [ + "view_index_metadata", + "monitor", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "indices.shrink" + "namespace": "indices.get_settings" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "indices.shrink" + "namespace": "indices.get_settings" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/{index}/_shrink/{target}" + "path": "/_settings" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_settings" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_settings/{name}" + }, + { + "methods": [ + "GET" + ], + "path": "/_settings/{name}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.9.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Simulate matching the given index name against the index templates in the system", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", - "name": "indices.simulate_index_template", + "description": "Returns an index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", + "name": "indices.get_template", "request": { "name": "Request", - "namespace": "indices.simulate_index_template" + "namespace": "indices.get_template" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "indices.simulate_index_template" + "namespace": "indices.get_template" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_index_template/_simulate_index/{name}" + "path": "/_template" + }, + { + "methods": [ + "GET" + ], + "path": "/_template/{name}" } ], "visibility": "public" @@ -7282,87 +7196,79 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Simulate resolving the given template name or body", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", - "name": "indices.simulate_template", + "description": "Migrates an alias to a data stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "name": "indices.migrate_to_data_stream", "privileges": { - "cluster": [ - "manage_index_templates", + "index": [ "manage" ] }, "request": { "name": "Request", - "namespace": "indices.simulate_template" + "namespace": "indices.migrate_to_data_stream" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "indices.simulate_template" + "namespace": "indices.migrate_to_data_stream" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_index_template/_simulate" - }, - { - "methods": [ - "POST" - ], - "path": "/_index_template/_simulate/{name}" + "path": "/_data_stream/_migrate/{name}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.1.0", + "since": "7.16.0", "stability": "stable" } }, - "description": "Allows you to split an existing index into a new index with more primary shards.", - "docId": "indices-split-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-split-index.html", - "name": "indices.split", + "description": "Modifies a data stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "name": "indices.modify_data_stream", "request": { "name": "Request", - "namespace": "indices.split" + "namespace": "indices.modify_data_stream" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "indices.split" + "namespace": "indices.modify_data_stream" }, "responseMediaType": [ "application/json" ], - "since": "6.1.0", + "since": "7.16.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", "POST" ], - "path": "/{index}/_split/{target}" + "path": "/_data_stream/_modify" } ], "visibility": "public" @@ -7374,57 +7280,33 @@ "visibility": "private" }, "stack": { - "since": "1.3.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Provides statistics on operations happening in an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", - "name": "indices.stats", - "privileges": { - "index": [ - "manage", - "monitor" - ] - }, + "description": "Opens an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", + "name": "indices.open", "request": { "name": "Request", - "namespace": "indices.stats" + "namespace": "indices.open" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.stats" + "namespace": "indices.open" }, "responseMediaType": [ "application/json" ], - "since": "1.3.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_stats" - }, - { - "methods": [ - "GET" - ], - "path": "/_stats/{metric}" - }, - { - "methods": [ - "GET" - ], - "path": "/{index}/_stats" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/{index}/_stats/{metric}" + "path": "/{index}/_open" } ], "visibility": "public" @@ -7432,37 +7314,33 @@ { "availability": { "stack": { - "since": "6.6.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html", - "name": "indices.unfreeze", + "description": "Promotes a data stream from a replicated data stream managed by CCR to a regular data stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "name": "indices.promote_data_stream", "request": { "name": "Request", - "namespace": "indices.unfreeze" + "namespace": "indices.promote_data_stream" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "indices.unfreeze" + "namespace": "indices.promote_data_stream" }, "responseMediaType": [ "application/json" ], - "since": "6.6.0", + "since": "7.9.0", "stability": "stable", "urls": [ { - "deprecation": { - "description": "Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release.", - "version": "7.14.0" - }, "methods": [ "POST" ], - "path": "/{index}/_unfreeze" + "path": "/_data_stream/_promote/{name}" } ], "visibility": "public" @@ -7474,36 +7352,44 @@ "visibility": "public" }, "stack": { - "since": "1.3.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Updates index aliases.", + "description": "Creates or updates an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "name": "indices.update_aliases", + "name": "indices.put_alias", "request": { "name": "Request", - "namespace": "indices.update_aliases" + "namespace": "indices.put_alias" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "indices.update_aliases" + "namespace": "indices.put_alias" }, "responseMediaType": [ "application/json" ], - "since": "1.3.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ + "PUT", "POST" ], - "path": "/_aliases" + "path": "/{index}/_alias/{name}" + }, + { + "methods": [ + "PUT", + "POST" + ], + "path": "/{index}/_aliases/{name}" } ], "visibility": "public" @@ -7515,44 +7401,33 @@ "visibility": "public" }, "stack": { - "since": "1.3.0", + "since": "8.11.0", "stability": "stable" } }, - "description": "Allows a user to validate a potentially expensive query without executing it.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", - "name": "indices.validate_query", + "description": "Updates the data stream lifecycle of the selected data streams.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", + "name": "indices.put_data_lifecycle", "request": { "name": "Request", - "namespace": "indices.validate_query" + "namespace": "indices.put_data_lifecycle" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "indices.validate_query" + "namespace": "indices.put_data_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "1.3.0", + "since": "8.11.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_validate/query" - }, - { - "methods": [ - "GET", - "POST" + "PUT" ], - "path": "/{index}/_validate/query" + "path": "/_data_stream/{name}/_lifecycle" } ], "visibility": "public" @@ -7560,44 +7435,41 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "8.11.0", - "stability": "experimental", - "visibility": "public" + "since": "7.9.0", + "stability": "stable" } }, - "description": "Delete model in the Inference API", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", - "name": "inference.delete_model", + "description": "Creates or updates an index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", + "name": "indices.put_index_template", "request": { "name": "Request", - "namespace": "inference.delete_model" + "namespace": "indices.put_index_template" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "inference.delete_model" + "namespace": "indices.put_index_template" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", - "stability": "experimental", + "since": "7.9.0", + "stability": "stable", "urls": [ { "methods": [ - "DELETE" - ], - "path": "/_inference/{inference_id}" - }, - { - "methods": [ - "DELETE" + "PUT", + "POST" ], - "path": "/_inference/{task_type}/{inference_id}" + "path": "/_index_template/{name}" } ], "visibility": "public" @@ -7605,44 +7477,41 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "8.11.0", - "stability": "experimental", - "visibility": "public" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Get a model in the Inference API", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", - "name": "inference.get_model", + "description": "Updates the index mappings.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", + "name": "indices.put_mapping", "request": { "name": "Request", - "namespace": "inference.get_model" + "namespace": "indices.put_mapping" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "inference.get_model" + "namespace": "indices.put_mapping" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_inference/{inference_id}" - }, - { - "methods": [ - "GET" + "PUT", + "POST" ], - "path": "/_inference/{task_type}/{inference_id}" + "path": "/{index}/_mapping" } ], "visibility": "public" @@ -7650,47 +7519,51 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "8.11.0", - "stability": "experimental", - "visibility": "public" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Perform inference on a model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", - "name": "inference.inference", + "description": "Updates the index settings.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", + "name": "indices.put_settings", + "privileges": { + "index": [ + "manage" + ] + }, "request": { "name": "Request", - "namespace": "inference.inference" + "namespace": "indices.put_settings" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "inference.inference" + "namespace": "indices.put_settings" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_inference/{inference_id}" + "path": "/_settings" }, { "methods": [ - "POST" + "PUT" ], - "path": "/_inference/{task_type}/{inference_id}" + "path": "/{index}/_settings" } ], "visibility": "public" @@ -7698,21 +7571,20 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "8.11.0", - "stability": "experimental", - "visibility": "public" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Configure a model for use in the Inference API", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", - "name": "inference.put_model", + "description": "Creates or updates an index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", + "name": "indices.put_template", "request": { "name": "Request", - "namespace": "inference.put_model" + "namespace": "indices.put_template" }, "requestBodyRequired": true, "requestMediaType": [ @@ -7720,25 +7592,20 @@ ], "response": { "name": "Response", - "namespace": "inference.put_model" + "namespace": "indices.put_template" }, "responseMediaType": [ "application/json" ], - "since": "8.11.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "PUT" - ], - "path": "/_inference/{inference_id}" - }, - { - "methods": [ - "PUT" + "PUT", + "POST" ], - "path": "/_inference/{task_type}/{inference_id}" + "path": "/_template/{name}" } ], "visibility": "public" @@ -7747,24 +7614,24 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { "since": "0.0.0", "stability": "stable" } }, - "description": "Returns basic information about the cluster.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", - "name": "info", + "description": "Returns information about ongoing index shard recoveries.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", + "name": "indices.recovery", "request": { "name": "Request", - "namespace": "_global.info" + "namespace": "indices.recovery" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "_global.info" + "namespace": "indices.recovery" }, "responseMediaType": [ "application/json" @@ -7776,7 +7643,13 @@ "methods": [ "GET" ], - "path": "/" + "path": "/_recovery" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_recovery" } ], "visibility": "public" @@ -7788,116 +7661,110 @@ "visibility": "public" }, "stack": { - "since": "5.0.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Deletes a pipeline.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", - "name": "ingest.delete_pipeline", + "description": "Performs the refresh operation in one or more indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", + "name": "indices.refresh", "request": { "name": "Request", - "namespace": "ingest.delete_pipeline" + "namespace": "indices.refresh" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ingest.delete_pipeline" + "namespace": "indices.refresh" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST", + "GET" ], - "path": "/_ingest/pipeline/{id}" + "path": "/_refresh" + }, + { + "methods": [ + "POST", + "GET" + ], + "path": "/{index}/_refresh" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "7.13.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Returns statistical information about geoip databases", - "docId": "geoip-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", - "name": "ingest.geo_ip_stats", + "description": "Reloads an index's search analyzers and their resources.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", + "name": "indices.reload_search_analyzers", "request": { "name": "Request", - "namespace": "ingest.geo_ip_stats" + "namespace": "indices.reload_search_analyzers" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ingest.geo_ip_stats" + "namespace": "indices.reload_search_analyzers" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_ingest/geoip/stats" + "path": "/{index}/_reload_search_analyzers" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "5.0.0", + "since": "8.13.0", "stability": "stable" } }, - "description": "Returns a pipeline.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", - "name": "ingest.get_pipeline", + "description": "Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html", + "name": "indices.resolve_cluster", "request": { "name": "Request", - "namespace": "ingest.get_pipeline" + "namespace": "indices.resolve_cluster" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ingest.get_pipeline" + "namespace": "indices.resolve_cluster" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", + "since": "8.13.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_ingest/pipeline" - }, - { - "methods": [ - "GET" - ], - "path": "/_ingest/pipeline/{id}" + "path": "/_resolve/cluster/{name}" } ], "visibility": "public" @@ -7909,34 +7776,33 @@ "visibility": "public" }, "stack": { - "since": "6.1.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Returns a list of the built-in patterns.", - "docId": "grok-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", - "name": "ingest.processor_grok", + "description": "Returns information about any matching indices, aliases, and data streams", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", + "name": "indices.resolve_index", "request": { "name": "Request", - "namespace": "ingest.processor_grok" + "namespace": "indices.resolve_index" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ingest.processor_grok" + "namespace": "indices.resolve_index" }, "responseMediaType": [ "application/json" ], - "since": "6.1.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_ingest/processor/grok" + "path": "/_resolve/index/{name}" } ], "visibility": "public" @@ -7952,21 +7818,21 @@ "stability": "stable" } }, - "description": "Creates or updates a pipeline.", - "docId": "ingest", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", - "name": "ingest.put_pipeline", + "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "docId": "indices-rollover-index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html", + "name": "indices.rollover", "request": { "name": "Request", - "namespace": "ingest.put_pipeline" + "namespace": "indices.rollover" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ingest.put_pipeline" + "namespace": "indices.rollover" }, "responseMediaType": [ "application/json" @@ -7976,9 +7842,15 @@ "urls": [ { "methods": [ - "PUT" + "POST" ], - "path": "/_ingest/pipeline/{id}" + "path": "/{alias}/_rollover" + }, + { + "methods": [ + "POST" + ], + "path": "/{alias}/_rollover/{new_index}" } ], "visibility": "public" @@ -7987,47 +7859,42 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "5.0.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Allows to simulate a pipeline with example documents.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", - "name": "ingest.simulate", + "description": "Provides low-level information about segments in a Lucene index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", + "name": "indices.segments", "request": { "name": "Request", - "namespace": "ingest.simulate" + "namespace": "indices.segments" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ingest.simulate" + "namespace": "indices.segments" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_ingest/pipeline/_simulate" + "path": "/_segments" }, { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_ingest/pipeline/{id}/_simulate" + "path": "/{index}/_segments" } ], "visibility": "public" @@ -8035,37 +7902,39 @@ { "availability": { "stack": { - "since": "8.0.0", - "stability": "experimental" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Performs a kNN search.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", - "name": "knn_search", + "description": "Provides store information for shard copies of indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", + "name": "indices.shard_stores", "request": { "name": "Request", - "namespace": "_global.knn_search" + "namespace": "indices.shard_stores" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "_global.knn_search" + "namespace": "indices.shard_stores" }, "responseMediaType": [ "application/json" ], - "since": "8.0.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/{index}/_knn_search" + "path": "/_shard_stores" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_shard_stores" } ], "visibility": "public" @@ -8073,33 +7942,38 @@ { "availability": { "stack": { - "since": "0.0.0", + "since": "5.0.0", "stability": "stable" } }, - "description": "Deletes licensing information for the cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", - "name": "license.delete", + "description": "Allow to shrink an existing index into a new index with fewer primary shards.", + "docId": "indices-shrink-index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shrink-index.html", + "name": "indices.shrink", "request": { "name": "Request", - "namespace": "license.delete" + "namespace": "indices.shrink" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "license.delete" + "namespace": "indices.shrink" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "5.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "PUT", + "POST" ], - "path": "/_license" + "path": "/{index}/_shrink/{target}" } ], "visibility": "public" @@ -8111,67 +7985,89 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Retrieves licensing information for the cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", - "name": "license.get", + "description": "Simulate matching the given index name against the index templates in the system", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", + "name": "indices.simulate_index_template", "request": { "name": "Request", - "namespace": "license.get" + "namespace": "indices.simulate_index_template" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "license.get" + "namespace": "indices.simulate_index_template" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_license" + "path": "/_index_template/_simulate_index/{name}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.3.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves information about the status of the basic license.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", - "name": "license.get_basic_status", + "description": "Simulate resolving the given template name or body", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", + "name": "indices.simulate_template", + "privileges": { + "cluster": [ + "manage_index_templates", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "license.get_basic_status" + "namespace": "indices.simulate_template" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "license.get_basic_status" + "namespace": "indices.simulate_template" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_license/basic_status" + "path": "/_index_template/_simulate" + }, + { + "methods": [ + "POST" + ], + "path": "/_index_template/_simulate/{name}" } ], "visibility": "public" @@ -8183,17 +8079,21 @@ "stability": "stable" } }, - "description": "Retrieves information about the status of the trial license.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", - "name": "license.get_trial_status", + "description": "Allows you to split an existing index into a new index with more primary shards.", + "docId": "indices-split-index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-split-index.html", + "name": "indices.split", "request": { "name": "Request", - "namespace": "license.get_trial_status" + "namespace": "indices.split" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "license.get_trial_status" + "namespace": "indices.split" }, "responseMediaType": [ "application/json" @@ -8203,52 +8103,72 @@ "urls": [ { "methods": [ - "GET" + "PUT", + "POST" ], - "path": "/_license/trial_status" + "path": "/{index}/_split/{target}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "0.0.0", + "since": "1.3.0", "stability": "stable" } }, - "description": "Updates the license for the cluster.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", - "name": "license.post", + "description": "Provides statistics on operations happening in an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", + "name": "indices.stats", "privileges": { - "cluster": [ - "manage" + "index": [ + "manage", + "monitor" ] }, "request": { "name": "Request", - "namespace": "license.post" + "namespace": "indices.stats" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "license.post" + "namespace": "indices.stats" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "1.3.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_license" + "path": "/_stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_stats/{metric}" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_stats" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_stats/{metric}" } ], "visibility": "public" @@ -8256,72 +8176,78 @@ { "availability": { "stack": { - "since": "6.3.0", + "since": "6.6.0", "stability": "stable" } }, - "description": "Starts an indefinite basic license.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", - "name": "license.post_start_basic", + "description": "Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html", + "name": "indices.unfreeze", "request": { "name": "Request", - "namespace": "license.post_start_basic" + "namespace": "indices.unfreeze" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "license.post_start_basic" + "namespace": "indices.unfreeze" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "6.6.0", "stability": "stable", "urls": [ { + "deprecation": { + "description": "Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release.", + "version": "7.14.0" + }, "methods": [ "POST" ], - "path": "/_license/start_basic" + "path": "/{index}/_unfreeze" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.1.0", + "since": "1.3.0", "stability": "stable" } }, - "description": "starts a limited time trial license.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", - "name": "license.post_start_trial", - "privileges": { - "cluster": [ - "manage" - ] - }, + "description": "Updates index aliases.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", + "name": "indices.update_aliases", "request": { "name": "Request", - "namespace": "license.post_start_trial" + "namespace": "indices.update_aliases" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "license.post_start_trial" + "namespace": "indices.update_aliases" }, "responseMediaType": [ "application/json" ], - "since": "6.1.0", + "since": "1.3.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_license/start_trial" + "path": "/_aliases" } ], "visibility": "public" @@ -8333,38 +8259,44 @@ "visibility": "public" }, "stack": { - "since": "7.12.0", + "since": "1.3.0", "stability": "stable" } }, - "description": "Deletes Logstash Pipelines used by Central Management", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", - "name": "logstash.delete_pipeline", - "privileges": { - "cluster": [ - "manage_logstash_pipelines" - ] - }, + "description": "Allows a user to validate a potentially expensive query without executing it.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", + "name": "indices.validate_query", "request": { "name": "Request", - "namespace": "logstash.delete_pipeline" + "namespace": "indices.validate_query" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "logstash.delete_pipeline" + "namespace": "indices.validate_query" }, "responseMediaType": [ "application/json" ], - "since": "7.12.0", + "since": "1.3.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET", + "POST" ], - "path": "/_logstash/pipeline/{id}" + "path": "/_validate/query" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_validate/query" } ], "visibility": "public" @@ -8372,48 +8304,44 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.12.0", - "stability": "stable" + "since": "8.11.0", + "stability": "experimental", + "visibility": "public" } }, - "description": "Retrieves Logstash Pipelines used by Central Management", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", - "name": "logstash.get_pipeline", - "privileges": { - "cluster": [ - "manage_logstash_pipelines" - ] - }, + "description": "Delete model in the Inference API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", + "name": "inference.delete_model", "request": { "name": "Request", - "namespace": "logstash.get_pipeline" + "namespace": "inference.delete_model" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "logstash.get_pipeline" + "namespace": "inference.delete_model" }, "responseMediaType": [ "application/json" ], - "since": "7.12.0", - "stability": "stable", + "since": "8.11.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_logstash/pipeline" + "path": "/_inference/{inference_id}" }, { "methods": [ - "GET" + "DELETE" ], - "path": "/_logstash/pipeline/{id}" + "path": "/_inference/{task_type}/{inference_id}" } ], "visibility": "public" @@ -8421,45 +8349,44 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.12.0", - "stability": "stable" + "since": "8.11.0", + "stability": "experimental", + "visibility": "public" } }, - "description": "Adds and updates Logstash Pipelines used for Central Management", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", - "name": "logstash.put_pipeline", - "privileges": { - "cluster": [ - "manage_logstash_pipelines" - ] - }, + "description": "Get a model in the Inference API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", + "name": "inference.get_model", "request": { "name": "Request", - "namespace": "logstash.put_pipeline" + "namespace": "inference.get_model" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "logstash.put_pipeline" + "namespace": "inference.get_model" }, "responseMediaType": [ "application/json" ], - "since": "7.12.0", - "stability": "stable", + "since": "8.11.0", + "stability": "experimental", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_logstash/pipeline/{id}" + "path": "/_inference/{inference_id}" + }, + { + "methods": [ + "GET" + ], + "path": "/_inference/{task_type}/{inference_id}" } ], "visibility": "public" @@ -8467,171 +8394,171 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "1.3.0", - "stability": "stable" + "since": "8.11.0", + "stability": "experimental", + "visibility": "public" } }, - "description": "Allows to get multiple documents in one request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", - "name": "mget", - "privileges": { - "index": [ - "read" - ] - }, + "description": "Perform inference on a model", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", + "name": "inference.inference", "request": { "name": "Request", - "namespace": "_global.mget" + "namespace": "inference.inference" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "_global.mget" + "namespace": "inference.inference" }, "responseMediaType": [ "application/json" ], - "since": "1.3.0", - "stability": "stable", + "since": "8.11.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET", "POST" ], - "path": "/_mget" + "path": "/_inference/{inference_id}" }, { "methods": [ - "GET", "POST" ], - "path": "/{index}/_mget" + "path": "/_inference/{task_type}/{inference_id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, "stack": { - "since": "6.1.0", - "stability": "stable" - } + "since": "8.11.0", + "stability": "experimental", + "visibility": "public" + } }, - "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", - "name": "migration.deprecations", + "description": "Configure a model for use in the Inference API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", + "name": "inference.put_model", "request": { "name": "Request", - "namespace": "migration.deprecations" + "namespace": "inference.put_model" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "migration.deprecations" + "namespace": "inference.put_model" }, "responseMediaType": [ "application/json" ], - "since": "6.1.0", - "stability": "stable", + "since": "8.11.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/_migration/deprecations" + "path": "/_inference/{inference_id}" }, { "methods": [ - "GET" + "PUT" ], - "path": "/{index}/_migration/deprecations" + "path": "/_inference/{task_type}/{inference_id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "7.16.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Find out whether system features need to be upgraded or not", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", - "name": "migration.get_feature_upgrade_status", - "privileges": { - "index": [ - "manage" - ] - }, + "description": "Returns basic information about the cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "name": "info", "request": { "name": "Request", - "namespace": "migration.get_feature_upgrade_status" + "namespace": "_global.info" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "migration.get_feature_upgrade_status" + "namespace": "_global.info" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_migration/system_features" + "path": "/" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "7.16.0", + "since": "5.0.0", "stability": "stable" } }, - "description": "Begin upgrades for system features", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", - "name": "migration.post_feature_upgrade", - "privileges": { - "index": [ - "manage" - ] - }, + "description": "Deletes a pipeline.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", + "name": "ingest.delete_pipeline", "request": { "name": "Request", - "namespace": "migration.post_feature_upgrade" + "namespace": "ingest.delete_pipeline" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "migration.post_feature_upgrade" + "namespace": "ingest.delete_pipeline" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", + "since": "5.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "DELETE" ], - "path": "/_migration/system_features" + "path": "/_ingest/pipeline/{id}" } ], "visibility": "public" @@ -8643,41 +8570,34 @@ "visibility": "private" }, "stack": { - "since": "8.5.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Clear the cached results from a trained model deployment", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html", - "name": "ml.clear_trained_model_deployment_cache", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Returns statistical information about geoip databases", + "docId": "geoip-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", + "name": "ingest.geo_ip_stats", "request": { "name": "Request", - "namespace": "ml.clear_trained_model_deployment_cache" + "namespace": "ingest.geo_ip_stats" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.clear_trained_model_deployment_cache" + "namespace": "ingest.geo_ip_stats" }, "responseMediaType": [ "application/json" ], - "since": "8.5.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/trained_models/{model_id}/deployment/cache/_clear" + "path": "/_ingest/geoip/stats" } ], "visibility": "public" @@ -8689,42 +8609,39 @@ "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "5.0.0", "stability": "stable" } }, - "description": "Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.", - "docId": "ml-close-job", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-close-job.html", - "name": "ml.close_job", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Returns a pipeline.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", + "name": "ingest.get_pipeline", "request": { "name": "Request", - "namespace": "ml.close_job" + "namespace": "ingest.get_pipeline" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.close_job" + "namespace": "ingest.get_pipeline" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "5.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/anomaly_detectors/{job_id}/_close" + "path": "/_ingest/pipeline" + }, + { + "methods": [ + "GET" + ], + "path": "/_ingest/pipeline/{id}" } ], "visibility": "public" @@ -8736,39 +8653,34 @@ "visibility": "public" }, "stack": { - "since": "6.2.0", + "since": "6.1.0", "stability": "stable" } }, - "description": "Deletes a calendar.", - "docId": "ml-delete-calendar", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar.html", - "name": "ml.delete_calendar", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Returns a list of the built-in patterns.", + "docId": "grok-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", + "name": "ingest.processor_grok", "request": { "name": "Request", - "namespace": "ml.delete_calendar" + "namespace": "ingest.processor_grok" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.delete_calendar" + "namespace": "ingest.processor_grok" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "6.1.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_ml/calendars/{calendar_id}" + "path": "/_ingest/processor/grok" } ], "visibility": "public" @@ -8780,34 +8692,37 @@ "visibility": "public" }, "stack": { - "since": "6.2.0", + "since": "5.0.0", "stability": "stable" } }, - "description": "Deletes scheduled events from a calendar.", - "docId": "ml-delete-calendar-event", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-event.html", - "name": "ml.delete_calendar_event", + "description": "Creates or updates a pipeline.", + "docId": "ingest", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", + "name": "ingest.put_pipeline", "request": { "name": "Request", - "namespace": "ml.delete_calendar_event" + "namespace": "ingest.put_pipeline" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.delete_calendar_event" + "namespace": "ingest.put_pipeline" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "5.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "PUT" ], - "path": "/_ml/calendars/{calendar_id}/events/{event_id}" + "path": "/_ingest/pipeline/{id}" } ], "visibility": "public" @@ -8819,127 +8734,116 @@ "visibility": "public" }, "stack": { - "since": "6.2.0", + "since": "5.0.0", "stability": "stable" } }, - "description": "Deletes anomaly detection jobs from a calendar.", - "docId": "ml-delete-calendar-job", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-job.html", - "name": "ml.delete_calendar_job", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Allows to simulate a pipeline with example documents.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", + "name": "ingest.simulate", "request": { "name": "Request", - "namespace": "ml.delete_calendar_job" + "namespace": "ingest.simulate" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.delete_calendar_job" + "namespace": "ingest.simulate" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "5.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET", + "POST" ], - "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}" + "path": "/_ingest/pipeline/_simulate" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/_ingest/pipeline/{id}/_simulate" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.3.0", - "stability": "stable" + "since": "8.0.0", + "stability": "experimental" } }, - "description": "Deletes an existing data frame analytics job.", - "docId": "ml-delete-dfanalytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-dfanalytics.html", - "name": "ml.delete_data_frame_analytics", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Performs a kNN search.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", + "name": "knn_search", "request": { "name": "Request", - "namespace": "ml.delete_data_frame_analytics" + "namespace": "_global.knn_search" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.delete_data_frame_analytics" + "namespace": "_global.knn_search" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", - "stability": "stable", + "since": "8.0.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "GET", + "POST" ], - "path": "/_ml/data_frame/analytics/{id}" + "path": "/{index}/_knn_search" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "5.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Deletes an existing datafeed.", - "docId": "ml-delete-datafeed", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-datafeed.html", - "name": "ml.delete_datafeed", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Deletes licensing information for the cluster", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", + "name": "license.delete", "request": { "name": "Request", - "namespace": "ml.delete_datafeed" + "namespace": "license.delete" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.delete_datafeed" + "namespace": "license.delete" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ "DELETE" ], - "path": "/_ml/datafeeds/{datafeed_id}" + "path": "/_license" } ], "visibility": "public" @@ -8948,271 +8852,220 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Deletes expired and unused machine learning data.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", - "name": "ml.delete_expired_data", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Retrieves licensing information for the cluster", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", + "name": "license.get", "request": { "name": "Request", - "namespace": "ml.delete_expired_data" + "namespace": "license.get" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.delete_expired_data" + "namespace": "license.get" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" - ], - "path": "/_ml/_delete_expired_data/{job_id}" - }, - { - "methods": [ - "DELETE" + "GET" ], - "path": "/_ml/_delete_expired_data" + "path": "/_license" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "5.4.0", + "since": "6.3.0", "stability": "stable" } }, - "description": "Deletes a filter.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", - "name": "ml.delete_filter", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Retrieves information about the status of the basic license.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", + "name": "license.get_basic_status", "request": { "name": "Request", - "namespace": "ml.delete_filter" + "namespace": "license.get_basic_status" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.delete_filter" + "namespace": "license.get_basic_status" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "6.3.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_ml/filters/{filter_id}" + "path": "/_license/basic_status" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "6.5.0", + "since": "6.1.0", "stability": "stable" } }, - "description": "Deletes forecasts from a machine learning job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", - "name": "ml.delete_forecast", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Retrieves information about the status of the trial license.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", + "name": "license.get_trial_status", "request": { "name": "Request", - "namespace": "ml.delete_forecast" + "namespace": "license.get_trial_status" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.delete_forecast" + "namespace": "license.get_trial_status" }, "responseMediaType": [ "application/json" ], - "since": "6.5.0", + "since": "6.1.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" - ], - "path": "/_ml/anomaly_detectors/{job_id}/_forecast" - }, - { - "methods": [ - "DELETE" + "GET" ], - "path": "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}" + "path": "/_license/trial_status" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "5.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Deletes an existing anomaly detection job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", - "name": "ml.delete_job", + "description": "Updates the license for the cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", + "name": "license.post", "privileges": { "cluster": [ - "manage_ml" + "manage" ] }, "request": { "name": "Request", - "namespace": "ml.delete_job" + "namespace": "license.post" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.delete_job" + "namespace": "license.post" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "PUT", + "POST" ], - "path": "/_ml/anomaly_detectors/{job_id}" + "path": "/_license" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "5.4.0", + "since": "6.3.0", "stability": "stable" } }, - "description": "Deletes an existing model snapshot.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", - "name": "ml.delete_model_snapshot", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Starts an indefinite basic license.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", + "name": "license.post_start_basic", "request": { "name": "Request", - "namespace": "ml.delete_model_snapshot" + "namespace": "license.post_start_basic" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.delete_model_snapshot" + "namespace": "license.post_start_basic" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "6.3.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}" + "path": "/_license/start_basic" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.10.0", + "since": "6.1.0", "stability": "stable" } }, - "description": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", - "name": "ml.delete_trained_model", + "description": "starts a limited time trial license.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", + "name": "license.post_start_trial", "privileges": { "cluster": [ - "manage_ml" + "manage" ] }, "request": { "name": "Request", - "namespace": "ml.delete_trained_model" + "namespace": "license.post_start_trial" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.delete_trained_model" + "namespace": "license.post_start_trial" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", + "since": "6.1.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_ml/trained_models/{model_id}" + "path": "/_license/start_trial" } ], "visibility": "public" @@ -9224,41 +9077,38 @@ "visibility": "public" }, "stack": { - "since": "7.13.0", + "since": "7.12.0", "stability": "stable" } }, - "description": "Deletes a model alias that refers to the trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", - "name": "ml.delete_trained_model_alias", + "description": "Deletes Logstash Pipelines used by Central Management", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", + "name": "logstash.delete_pipeline", "privileges": { "cluster": [ - "manage_ml" + "manage_logstash_pipelines" ] }, "request": { "name": "Request", - "namespace": "ml.delete_trained_model_alias" + "namespace": "logstash.delete_pipeline" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.delete_trained_model_alias" + "namespace": "logstash.delete_pipeline" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "7.12.0", "stability": "stable", "urls": [ { "methods": [ "DELETE" ], - "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}" + "path": "/_logstash/pipeline/{id}" } ], "visibility": "public" @@ -9270,43 +9120,46 @@ "visibility": "public" }, "stack": { - "since": "7.7.0", + "since": "7.12.0", "stability": "stable" } }, - "description": "Estimates the model memory", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", - "name": "ml.estimate_model_memory", + "description": "Retrieves Logstash Pipelines used by Central Management", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", + "name": "logstash.get_pipeline", "privileges": { "cluster": [ - "manage_ml" + "manage_logstash_pipelines" ] }, "request": { "name": "Request", - "namespace": "ml.estimate_model_memory" + "namespace": "logstash.get_pipeline" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.estimate_model_memory" + "namespace": "logstash.get_pipeline" }, "responseMediaType": [ "application/json" ], - "since": "7.7.0", + "since": "7.12.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/anomaly_detectors/_estimate_model_memory" - } - ], + "path": "/_logstash/pipeline" + }, + { + "methods": [ + "GET" + ], + "path": "/_logstash/pipeline/{id}" + } + ], "visibility": "public" }, { @@ -9316,21 +9169,21 @@ "visibility": "public" }, "stack": { - "since": "7.3.0", + "since": "7.12.0", "stability": "stable" } }, - "description": "Evaluates the data frame analytics for an annotated index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", - "name": "ml.evaluate_data_frame", + "description": "Adds and updates Logstash Pipelines used for Central Management", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", + "name": "logstash.put_pipeline", "privileges": { "cluster": [ - "monitor_ml" + "manage_logstash_pipelines" ] }, "request": { "name": "Request", - "namespace": "ml.evaluate_data_frame" + "namespace": "logstash.put_pipeline" }, "requestBodyRequired": true, "requestMediaType": [ @@ -9338,19 +9191,19 @@ ], "response": { "name": "Response", - "namespace": "ml.evaluate_data_frame" + "namespace": "logstash.put_pipeline" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "7.12.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/data_frame/_evaluate" + "path": "/_logstash/pipeline/{id}" } ], "visibility": "public" @@ -9359,37 +9212,37 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "7.3.0", + "since": "1.3.0", "stability": "stable" } }, - "description": "Explains a data frame analytics config.", - "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", - "name": "ml.explain_data_frame_analytics", + "description": "Allows to get multiple documents in one request.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", + "name": "mget", "privileges": { - "cluster": [ - "monitor_ml" + "index": [ + "read" ] }, "request": { "name": "Request", - "namespace": "ml.explain_data_frame_analytics" + "namespace": "_global.mget" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.explain_data_frame_analytics" + "namespace": "_global.mget" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "1.3.0", "stability": "stable", "urls": [ { @@ -9397,160 +9250,132 @@ "GET", "POST" ], - "path": "/_ml/data_frame/analytics/_explain" + "path": "/_mget" }, { "methods": [ "GET", "POST" ], - "path": "/_ml/data_frame/analytics/{id}/_explain" + "path": "/{index}/_mget" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "5.4.0", + "since": "6.1.0", "stability": "stable" } }, - "description": "Forces any buffered data to be processed by the job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", - "name": "ml.flush_job", - "privileges": { - "cluster": [ - "manage_ml" - ] - }, + "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", + "name": "migration.deprecations", "request": { "name": "Request", - "namespace": "ml.flush_job" + "namespace": "migration.deprecations" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.flush_job" + "namespace": "migration.deprecations" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "6.1.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/anomaly_detectors/{job_id}/_flush" + "path": "/_migration/deprecations" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_migration/deprecations" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "6.1.0", + "since": "7.16.0", "stability": "stable" } }, - "description": "Predicts the future behavior of a time series by using its historical behavior.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", - "name": "ml.forecast", + "description": "Find out whether system features need to be upgraded or not", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", + "name": "migration.get_feature_upgrade_status", "privileges": { - "cluster": [ - "manage_ml" + "index": [ + "manage" ] }, "request": { "name": "Request", - "namespace": "ml.forecast" + "namespace": "migration.get_feature_upgrade_status" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.forecast" + "namespace": "migration.get_feature_upgrade_status" }, "responseMediaType": [ "application/json" ], - "since": "6.1.0", + "since": "7.16.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/anomaly_detectors/{job_id}/_forecast" + "path": "/_migration/system_features" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "5.4.0", + "since": "7.16.0", "stability": "stable" } }, - "description": "Retrieves anomaly detection job results for one or more buckets.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", - "name": "ml.get_buckets", + "description": "Begin upgrades for system features", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", + "name": "migration.post_feature_upgrade", "privileges": { - "cluster": [ - "monitor_ml" + "index": [ + "manage" ] }, "request": { "name": "Request", - "namespace": "ml.get_buckets" + "namespace": "migration.post_feature_upgrade" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.get_buckets" + "namespace": "migration.post_feature_upgrade" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "7.16.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}" - }, - { - "methods": [ - "GET", "POST" ], - "path": "/_ml/anomaly_detectors/{job_id}/results/buckets" + "path": "/_migration/system_features" } ], "visibility": "public" @@ -9559,41 +9384,44 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "6.2.0", + "since": "8.5.0", "stability": "stable" } }, - "description": "Retrieves information about the scheduled events in calendars.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", - "name": "ml.get_calendar_events", + "description": "Clear the cached results from a trained model deployment", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html", + "name": "ml.clear_trained_model_deployment_cache", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_calendar_events" + "namespace": "ml.clear_trained_model_deployment_cache" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.get_calendar_events" + "namespace": "ml.clear_trained_model_deployment_cache" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "8.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_ml/calendars/{calendar_id}/events" + "path": "/_ml/trained_models/{model_id}/deployment/cache/_clear" } ], "visibility": "public" @@ -9605,21 +9433,22 @@ "visibility": "public" }, "stack": { - "since": "6.2.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Retrieves configuration information for calendars.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", - "name": "ml.get_calendars", + "description": "Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.", + "docId": "ml-close-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-close-job.html", + "name": "ml.close_job", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_calendars" + "namespace": "ml.close_job" }, "requestBodyRequired": false, "requestMediaType": [ @@ -9627,27 +9456,19 @@ ], "response": { "name": "Response", - "namespace": "ml.get_calendars" + "namespace": "ml.close_job" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_ml/calendars" - }, - { - "methods": [ - "GET", "POST" ], - "path": "/_ml/calendars/{calendar_id}" + "path": "/_ml/anomaly_detectors/{job_id}/_close" } ], "visibility": "public" @@ -9656,52 +9477,42 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "6.2.0", "stability": "stable" } }, - "description": "Retrieves anomaly detection job results for one or more categories.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", - "name": "ml.get_categories", + "description": "Deletes a calendar.", + "docId": "ml-delete-calendar", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar.html", + "name": "ml.delete_calendar", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_categories" + "namespace": "ml.delete_calendar" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.get_categories" + "namespace": "ml.delete_calendar" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "6.2.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}" - }, - { - "methods": [ - "GET", - "POST" + "DELETE" ], - "path": "/_ml/anomaly_detectors/{job_id}/results/categories" + "path": "/_ml/calendars/{calendar_id}" } ], "visibility": "public" @@ -9713,44 +9524,34 @@ "visibility": "public" }, "stack": { - "since": "7.3.0", + "since": "6.2.0", "stability": "stable" } }, - "description": "Retrieves configuration information for data frame analytics jobs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", - "name": "ml.get_data_frame_analytics", - "privileges": { - "cluster": [ - "monitor_ml" - ] - }, + "description": "Deletes scheduled events from a calendar.", + "docId": "ml-delete-calendar-event", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-event.html", + "name": "ml.delete_calendar_event", "request": { "name": "Request", - "namespace": "ml.get_data_frame_analytics" + "namespace": "ml.delete_calendar_event" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.get_data_frame_analytics" + "namespace": "ml.delete_calendar_event" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "6.2.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_ml/data_frame/analytics/{id}" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/data_frame/analytics" + "path": "/_ml/calendars/{calendar_id}/events/{event_id}" } ], "visibility": "public" @@ -9762,44 +9563,39 @@ "visibility": "public" }, "stack": { - "since": "7.3.0", + "since": "6.2.0", "stability": "stable" } }, - "description": "Retrieves usage information for data frame analytics jobs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", - "name": "ml.get_data_frame_analytics_stats", + "description": "Deletes anomaly detection jobs from a calendar.", + "docId": "ml-delete-calendar-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-job.html", + "name": "ml.delete_calendar_job", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_data_frame_analytics_stats" + "namespace": "ml.delete_calendar_job" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.get_data_frame_analytics_stats" + "namespace": "ml.delete_calendar_job" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "6.2.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_ml/data_frame/analytics/_stats" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/data_frame/analytics/{id}/_stats" + "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}" } ], "visibility": "public" @@ -9811,44 +9607,39 @@ "visibility": "public" }, "stack": { - "since": "5.5.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Retrieves usage information for datafeeds.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", - "name": "ml.get_datafeed_stats", + "description": "Deletes an existing data frame analytics job.", + "docId": "ml-delete-dfanalytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-dfanalytics.html", + "name": "ml.delete_data_frame_analytics", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_datafeed_stats" + "namespace": "ml.delete_data_frame_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.get_datafeed_stats" + "namespace": "ml.delete_data_frame_analytics" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_ml/datafeeds/{datafeed_id}/_stats" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/datafeeds/_stats" + "path": "/_ml/data_frame/analytics/{id}" } ], "visibility": "public" @@ -9860,44 +9651,39 @@ "visibility": "public" }, "stack": { - "since": "5.5.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Retrieves configuration information for datafeeds.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", - "name": "ml.get_datafeeds", + "description": "Deletes an existing datafeed.", + "docId": "ml-delete-datafeed", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-datafeed.html", + "name": "ml.delete_datafeed", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_datafeeds" + "namespace": "ml.delete_datafeed" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.get_datafeeds" + "namespace": "ml.delete_datafeed" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], "path": "/_ml/datafeeds/{datafeed_id}" - }, - { - "methods": [ - "GET" - ], - "path": "/_ml/datafeeds" } ], "visibility": "public" @@ -9906,16 +9692,16 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "5.5.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Retrieves filters.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", - "name": "ml.get_filters", + "description": "Deletes expired and unused machine learning data.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", + "name": "ml.delete_expired_data", "privileges": { "cluster": [ "manage_ml" @@ -9923,30 +9709,33 @@ }, "request": { "name": "Request", - "namespace": "ml.get_filters" + "namespace": "ml.delete_expired_data" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.get_filters" + "namespace": "ml.delete_expired_data" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/filters" + "path": "/_ml/_delete_expired_data/{job_id}" }, { "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/filters/{filter_id}" + "path": "/_ml/_delete_expired_data" } ], "visibility": "public" @@ -9955,32 +9744,29 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, - "description": "Retrieves anomaly detection job results for one or more influencers.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", - "name": "ml.get_influencers", + "description": "Deletes a filter.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", + "name": "ml.delete_filter", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_influencers" + "namespace": "ml.delete_filter" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.get_influencers" + "namespace": "ml.delete_filter" }, "responseMediaType": [ "application/json" @@ -9990,10 +9776,9 @@ "urls": [ { "methods": [ - "GET", - "POST" + "DELETE" ], - "path": "/_ml/anomaly_detectors/{job_id}/results/influencers" + "path": "/_ml/filters/{filter_id}" } ], "visibility": "public" @@ -10002,47 +9787,47 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "5.5.0", + "since": "6.5.0", "stability": "stable" } }, - "description": "Retrieves usage information for anomaly detection jobs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", - "name": "ml.get_job_stats", + "description": "Deletes forecasts from a machine learning job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", + "name": "ml.delete_forecast", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_job_stats" + "namespace": "ml.delete_forecast" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.get_job_stats" + "namespace": "ml.delete_forecast" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "6.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/anomaly_detectors/_stats" + "path": "/_ml/anomaly_detectors/{job_id}/_forecast" }, { "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/anomaly_detectors/{job_id}/_stats" + "path": "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}" } ], "visibility": "public" @@ -10054,44 +9839,38 @@ "visibility": "public" }, "stack": { - "since": "5.5.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Retrieves configuration information for anomaly detection jobs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", - "name": "ml.get_jobs", + "description": "Deletes an existing anomaly detection job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", + "name": "ml.delete_job", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_jobs" + "namespace": "ml.delete_job" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.get_jobs" + "namespace": "ml.delete_job" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], "path": "/_ml/anomaly_detectors/{job_id}" - }, - { - "methods": [ - "GET" - ], - "path": "/_ml/anomaly_detectors" } ], "visibility": "public" @@ -10103,44 +9882,38 @@ "visibility": "private" }, "stack": { - "since": "8.2.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Returns information on how ML is using memory.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html", - "name": "ml.get_memory_stats", + "description": "Deletes an existing model snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", + "name": "ml.delete_model_snapshot", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_memory_stats" + "namespace": "ml.delete_model_snapshot" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.get_memory_stats" + "namespace": "ml.delete_model_snapshot" }, "responseMediaType": [ "application/json" ], - "since": "8.2.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_ml/memory/_stats" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/memory/{node_id}/_stats" + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}" } ], "visibility": "public" @@ -10149,41 +9922,41 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "7.16.0", + "since": "7.10.0", "stability": "stable" } }, - "description": "Gets stats for anomaly detection job model snapshot upgrades that are in progress.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", - "name": "ml.get_model_snapshot_upgrade_stats", + "description": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", + "name": "ml.delete_trained_model", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_model_snapshot_upgrade_stats" + "namespace": "ml.delete_trained_model" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.get_model_snapshot_upgrade_stats" + "namespace": "ml.delete_trained_model" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", + "since": "7.10.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats" + "path": "/_ml/trained_models/{model_id}" } ], "visibility": "public" @@ -10192,24 +9965,24 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Retrieves information about model snapshots.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", - "name": "ml.get_model_snapshots", + "description": "Deletes a model alias that refers to the trained model", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", + "name": "ml.delete_trained_model_alias", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_model_snapshots" + "namespace": "ml.delete_trained_model_alias" }, "requestBodyRequired": false, "requestMediaType": [ @@ -10217,27 +9990,19 @@ ], "response": { "name": "Response", - "namespace": "ml.get_model_snapshots" + "namespace": "ml.delete_trained_model_alias" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}" - }, - { - "methods": [ - "GET", - "POST" + "DELETE" ], - "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots" + "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}" } ], "visibility": "public" @@ -10249,42 +10014,41 @@ "visibility": "public" }, "stack": { - "since": "6.1.0", + "since": "7.7.0", "stability": "stable" } }, - "description": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", - "name": "ml.get_overall_buckets", + "description": "Estimates the model memory", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", + "name": "ml.estimate_model_memory", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_overall_buckets" + "namespace": "ml.estimate_model_memory" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.get_overall_buckets" + "namespace": "ml.estimate_model_memory" }, "responseMediaType": [ "application/json" ], - "since": "6.1.0", + "since": "7.7.0", "stability": "stable", "urls": [ { "methods": [ - "GET", "POST" ], - "path": "/_ml/anomaly_detectors/{job_id}/results/overall_buckets" + "path": "/_ml/anomaly_detectors/_estimate_model_memory" } ], "visibility": "public" @@ -10293,16 +10057,16 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Retrieves anomaly records for an anomaly detection job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", - "name": "ml.get_records", + "description": "Evaluates the data frame analytics for an annotated index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", + "name": "ml.evaluate_data_frame", "privileges": { "cluster": [ "monitor_ml" @@ -10310,28 +10074,27 @@ }, "request": { "name": "Request", - "namespace": "ml.get_records" + "namespace": "ml.evaluate_data_frame" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.get_records" + "namespace": "ml.evaluate_data_frame" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ - "GET", "POST" ], - "path": "/_ml/anomaly_detectors/{job_id}/results/records" + "path": "/_ml/data_frame/_evaluate" } ], "visibility": "public" @@ -10340,16 +10103,16 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.10.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Retrieves configuration information for a trained inference model.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", - "name": "ml.get_trained_models", + "description": "Explains a data frame analytics config.", + "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", + "name": "ml.explain_data_frame_analytics", "privileges": { "cluster": [ "monitor_ml" @@ -10357,30 +10120,35 @@ }, "request": { "name": "Request", - "namespace": "ml.get_trained_models" + "namespace": "ml.explain_data_frame_analytics" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.get_trained_models" + "namespace": "ml.explain_data_frame_analytics" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_ml/trained_models/{model_id}" + "path": "/_ml/data_frame/analytics/_explain" }, { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_ml/trained_models" + "path": "/_ml/data_frame/analytics/{id}/_explain" } ], "visibility": "public" @@ -10392,44 +10160,41 @@ "visibility": "public" }, "stack": { - "since": "7.10.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Retrieves usage information for trained inference models.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", - "name": "ml.get_trained_models_stats", + "description": "Forces any buffered data to be processed by the job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", + "name": "ml.flush_job", "privileges": { "cluster": [ - "monitor_ml" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "ml.get_trained_models_stats" + "namespace": "ml.flush_job" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.get_trained_models_stats" + "namespace": "ml.flush_job" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_ml/trained_models/{model_id}/_stats" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_ml/trained_models/_stats" + "path": "/_ml/anomaly_detectors/{job_id}/_flush" } ], "visibility": "public" @@ -10438,49 +10203,44 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "8.3.0", + "since": "6.1.0", "stability": "stable" } }, - "description": "Evaluate a trained model.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", - "name": "ml.infer_trained_model", + "description": "Predicts the future behavior of a time series by using its historical behavior.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", + "name": "ml.forecast", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "ml.infer_trained_model" + "namespace": "ml.forecast" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.infer_trained_model" + "namespace": "ml.forecast" }, "responseMediaType": [ "application/json" ], - "since": "8.3.0", + "since": "6.1.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_ml/trained_models/{model_id}/_infer" - }, - { - "deprecation": { - "description": "/_ml/trained_models/{model_id}/deployment/_infer is deprecated. Use /_ml/trained_models/{model_id}/_infer instead", - "version": "8.3.0" - }, - "methods": [ - "POST" - ], - "path": "/_ml/trained_models/{model_id}/deployment/_infer" + "path": "/_ml/anomaly_detectors/{job_id}/_forecast" } ], "visibility": "public" @@ -10492,13 +10252,13 @@ "visibility": "private" }, "stack": { - "since": "6.3.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Returns defaults and limits used by machine learning.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", - "name": "ml.info", + "description": "Retrieves anomaly detection job results for one or more buckets.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", + "name": "ml.get_buckets", "privileges": { "cluster": [ "monitor_ml" @@ -10506,24 +10266,35 @@ }, "request": { "name": "Request", - "namespace": "ml.info" + "namespace": "ml.get_buckets" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.info" + "namespace": "ml.get_buckets" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_ml/info" + "path": "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/_ml/anomaly_detectors/{job_id}/results/buckets" } ], "visibility": "public" @@ -10535,41 +10306,38 @@ "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "6.2.0", "stability": "stable" } }, - "description": "Opens one or more anomaly detection jobs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", - "name": "ml.open_job", + "description": "Retrieves information about the scheduled events in calendars.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", + "name": "ml.get_calendar_events", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.open_job" + "namespace": "ml.get_calendar_events" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.open_job" + "namespace": "ml.get_calendar_events" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "6.2.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/anomaly_detectors/{job_id}/_open" + "path": "/_ml/calendars/{calendar_id}/events" } ], "visibility": "public" @@ -10585,25 +10353,25 @@ "stability": "stable" } }, - "description": "Posts scheduled events in a calendar.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", - "name": "ml.post_calendar_events", + "description": "Retrieves configuration information for calendars.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", + "name": "ml.get_calendars", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.post_calendar_events" + "namespace": "ml.get_calendars" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.post_calendar_events" + "namespace": "ml.get_calendars" }, "responseMediaType": [ "application/json" @@ -10613,40 +10381,51 @@ "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_ml/calendars/{calendar_id}/events" + "path": "/_ml/calendars" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/_ml/calendars/{calendar_id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { "since": "5.4.0", "stability": "stable" } }, - "description": "Sends data to an anomaly detection job for analysis.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", - "name": "ml.post_data", + "description": "Retrieves anomaly detection job results for one or more categories.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", + "name": "ml.get_categories", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.post_data" + "namespace": "ml.get_categories" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ - "application/x-ndjson", "application/json" ], "response": { "name": "Response", - "namespace": "ml.post_data" + "namespace": "ml.get_categories" }, "responseMediaType": [ "application/json" @@ -10656,9 +10435,17 @@ "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_ml/anomaly_detectors/{job_id}/_data" + "path": "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/_ml/anomaly_detectors/{job_id}/results/categories" } ], "visibility": "public" @@ -10670,13 +10457,13 @@ "visibility": "public" }, "stack": { - "since": "7.13.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Previews that will be analyzed given a data frame analytics config.", - "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", - "name": "ml.preview_data_frame_analytics", + "description": "Retrieves configuration information for data frame analytics jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", + "name": "ml.get_data_frame_analytics", "privileges": { "cluster": [ "monitor_ml" @@ -10684,35 +10471,30 @@ }, "request": { "name": "Request", - "namespace": "ml.preview_data_frame_analytics" + "namespace": "ml.get_data_frame_analytics" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.preview_data_frame_analytics" + "namespace": "ml.get_data_frame_analytics" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_ml/data_frame/analytics/_preview" + "path": "/_ml/data_frame/analytics/{id}" }, { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_ml/data_frame/analytics/{id}/_preview" + "path": "/_ml/data_frame/analytics" } ], "visibility": "public" @@ -10724,52 +10506,44 @@ "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Previews a datafeed.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", - "name": "ml.preview_datafeed", + "description": "Retrieves usage information for data frame analytics jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", + "name": "ml.get_data_frame_analytics_stats", "privileges": { "cluster": [ - "manage_ml" - ], - "index": [ - "read" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.preview_datafeed" + "namespace": "ml.get_data_frame_analytics_stats" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.preview_datafeed" + "namespace": "ml.get_data_frame_analytics_stats" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_ml/datafeeds/{datafeed_id}/_preview" + "path": "/_ml/data_frame/analytics/_stats" }, { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_ml/datafeeds/_preview" + "path": "/_ml/data_frame/analytics/{id}/_stats" } ], "visibility": "public" @@ -10781,41 +10555,44 @@ "visibility": "public" }, "stack": { - "since": "6.2.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Instantiates a calendar.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", - "name": "ml.put_calendar", + "description": "Retrieves usage information for datafeeds.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", + "name": "ml.get_datafeed_stats", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_calendar" + "namespace": "ml.get_datafeed_stats" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.put_calendar" + "namespace": "ml.get_datafeed_stats" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_ml/calendars/{calendar_id}" + "path": "/_ml/datafeeds/{datafeed_id}/_stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_ml/datafeeds/_stats" } ], "visibility": "public" @@ -10827,38 +10604,44 @@ "visibility": "public" }, "stack": { - "since": "6.2.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Adds an anomaly detection job to a calendar.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", - "name": "ml.put_calendar_job", + "description": "Retrieves configuration information for datafeeds.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", + "name": "ml.get_datafeeds", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_calendar_job" + "namespace": "ml.get_datafeeds" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.put_calendar_job" + "namespace": "ml.get_datafeeds" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}" + "path": "/_ml/datafeeds/{datafeed_id}" + }, + { + "methods": [ + "GET" + ], + "path": "/_ml/datafeeds" } ], "visibility": "public" @@ -10870,49 +10653,44 @@ "visibility": "public" }, "stack": { - "since": "7.3.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Instantiates a data frame analytics job.", - "docId": "put-dfanalytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", - "name": "ml.put_data_frame_analytics", + "description": "Retrieves filters.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", + "name": "ml.get_filters", "privileges": { "cluster": [ "manage_ml" - ], - "index": [ - "create_index", - "index", - "manage", - "read", - "view_index_metadata" ] }, "request": { "name": "Request", - "namespace": "ml.put_data_frame_analytics" + "namespace": "ml.get_filters" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.put_data_frame_analytics" + "namespace": "ml.get_filters" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_ml/data_frame/analytics/{id}" + "path": "/_ml/filters" + }, + { + "methods": [ + "GET" + ], + "path": "/_ml/filters/{filter_id}" } ], "visibility": "public" @@ -10921,35 +10699,32 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { "since": "5.4.0", "stability": "stable" } }, - "description": "Instantiates a datafeed.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", - "name": "ml.put_datafeed", + "description": "Retrieves anomaly detection job results for one or more influencers.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", + "name": "ml.get_influencers", "privileges": { "cluster": [ - "manage_ml" - ], - "index": [ - "read" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_datafeed" + "namespace": "ml.get_influencers" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.put_datafeed" + "namespace": "ml.get_influencers" }, "responseMediaType": [ "application/json" @@ -10959,9 +10734,10 @@ "urls": [ { "methods": [ - "PUT" + "GET", + "POST" ], - "path": "/_ml/datafeeds/{datafeed_id}" + "path": "/_ml/anomaly_detectors/{job_id}/results/influencers" } ], "visibility": "public" @@ -10973,41 +10749,44 @@ "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Instantiates a filter.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", - "name": "ml.put_filter", + "description": "Retrieves usage information for anomaly detection jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", + "name": "ml.get_job_stats", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_filter" + "namespace": "ml.get_job_stats" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.put_filter" + "namespace": "ml.get_job_stats" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_ml/filters/{filter_id}" + "path": "/_ml/anomaly_detectors/_stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_ml/anomaly_detectors/{job_id}/_stats" } ], "visibility": "public" @@ -11019,44 +10798,44 @@ "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Instantiates an anomaly detection job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", - "name": "ml.put_job", + "description": "Retrieves configuration information for anomaly detection jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", + "name": "ml.get_jobs", "privileges": { "cluster": [ - "manage_ml" - ], - "index": [ - "read" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_job" + "namespace": "ml.get_jobs" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.put_job" + "namespace": "ml.get_jobs" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], "path": "/_ml/anomaly_detectors/{job_id}" + }, + { + "methods": [ + "GET" + ], + "path": "/_ml/anomaly_detectors" } ], "visibility": "public" @@ -11065,44 +10844,47 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.10.0", + "since": "8.2.0", "stability": "stable" } }, - "description": "Creates an inference trained model.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", - "name": "ml.put_trained_model", + "description": "Returns information on how ML is using memory.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html", + "name": "ml.get_memory_stats", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_trained_model" + "namespace": "ml.get_memory_stats" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.put_trained_model" + "namespace": "ml.get_memory_stats" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", + "since": "8.2.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_ml/trained_models/{model_id}" + "path": "/_ml/memory/_stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_ml/memory/{node_id}/_stats" } ], "visibility": "public" @@ -11111,44 +10893,41 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.13.0", + "since": "7.16.0", "stability": "stable" } }, - "description": "Creates a new model alias (or reassigns an existing one) to refer to the trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", - "name": "ml.put_trained_model_alias", + "description": "Gets stats for anomaly detection job model snapshot upgrades that are in progress.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", + "name": "ml.get_model_snapshot_upgrade_stats", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_trained_model_alias" + "namespace": "ml.get_model_snapshot_upgrade_stats" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.put_trained_model_alias" + "namespace": "ml.get_model_snapshot_upgrade_stats" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "7.16.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}" + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats" } ], "visibility": "public" @@ -11157,44 +10936,52 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "8.0.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Creates part of a trained model definition", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", - "name": "ml.put_trained_model_definition_part", + "description": "Retrieves information about model snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", + "name": "ml.get_model_snapshots", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_trained_model_definition_part" + "namespace": "ml.get_model_snapshots" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.put_trained_model_definition_part" + "namespace": "ml.get_model_snapshots" }, "responseMediaType": [ "application/json" ], - "since": "8.0.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET", + "POST" ], - "path": "/_ml/trained_models/{model_id}/definition/{part}" + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots" } ], "visibility": "public" @@ -11206,41 +10993,42 @@ "visibility": "public" }, "stack": { - "since": "8.0.0", + "since": "6.1.0", "stability": "stable" } }, - "description": "Creates a trained model vocabulary", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", - "name": "ml.put_trained_model_vocabulary", + "description": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", + "name": "ml.get_overall_buckets", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.put_trained_model_vocabulary" + "namespace": "ml.get_overall_buckets" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.put_trained_model_vocabulary" + "namespace": "ml.get_overall_buckets" }, "responseMediaType": [ "application/json" ], - "since": "8.0.0", + "since": "6.1.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET", + "POST" ], - "path": "/_ml/trained_models/{model_id}/vocabulary" + "path": "/_ml/anomaly_detectors/{job_id}/results/overall_buckets" } ], "visibility": "public" @@ -11249,41 +11037,45 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.14.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Resets an existing anomaly detection job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", - "name": "ml.reset_job", + "description": "Retrieves anomaly records for an anomaly detection job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", + "name": "ml.get_records", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.reset_job" + "namespace": "ml.get_records" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.reset_job" + "namespace": "ml.get_records" }, "responseMediaType": [ "application/json" ], - "since": "7.14.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_ml/anomaly_detectors/{job_id}/_reset" + "path": "/_ml/anomaly_detectors/{job_id}/results/records" } ], "visibility": "public" @@ -11292,44 +11084,47 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "5.4.0", + "since": "7.10.0", "stability": "stable" } }, - "description": "Reverts to a specific snapshot.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", - "name": "ml.revert_model_snapshot", + "description": "Retrieves configuration information for a trained inference model.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", + "name": "ml.get_trained_models", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.revert_model_snapshot" + "namespace": "ml.get_trained_models" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.revert_model_snapshot" + "namespace": "ml.get_trained_models" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "7.10.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert" + "path": "/_ml/trained_models/{model_id}" + }, + { + "methods": [ + "GET" + ], + "path": "/_ml/trained_models" } ], "visibility": "public" @@ -11338,41 +11133,47 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "6.7.0", + "since": "7.10.0", "stability": "stable" } }, - "description": "Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", - "name": "ml.set_upgrade_mode", + "description": "Retrieves usage information for trained inference models.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", + "name": "ml.get_trained_models_stats", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.set_upgrade_mode" + "namespace": "ml.get_trained_models_stats" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.set_upgrade_mode" + "namespace": "ml.get_trained_models_stats" }, "responseMediaType": [ "application/json" ], - "since": "6.7.0", + "since": "7.10.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/set_upgrade_mode" + "path": "/_ml/trained_models/{model_id}/_stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_ml/trained_models/_stats" } ], "visibility": "public" @@ -11384,48 +11185,46 @@ "visibility": "public" }, "stack": { - "since": "7.3.0", + "since": "8.3.0", "stability": "stable" } }, - "description": "Starts a data frame analytics job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", - "name": "ml.start_data_frame_analytics", - "privileges": { - "cluster": [ - "manage_ml" - ], - "index": [ - "create_index", - "index", - "manage", - "read", - "view_index_metadata" - ] - }, + "description": "Evaluate a trained model.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", + "name": "ml.infer_trained_model", "request": { "name": "Request", - "namespace": "ml.start_data_frame_analytics" + "namespace": "ml.infer_trained_model" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.start_data_frame_analytics" + "namespace": "ml.infer_trained_model" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "8.3.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_ml/data_frame/analytics/{id}/_start" + "path": "/_ml/trained_models/{model_id}/_infer" + }, + { + "deprecation": { + "description": "/_ml/trained_models/{model_id}/deployment/_infer is deprecated. Use /_ml/trained_models/{model_id}/_infer instead", + "version": "8.3.0" + }, + "methods": [ + "POST" + ], + "path": "/_ml/trained_models/{model_id}/deployment/_infer" } ], "visibility": "public" @@ -11434,44 +11233,41 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "5.5.0", + "since": "6.3.0", "stability": "stable" } }, - "description": "Starts one or more datafeeds.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", - "name": "ml.start_datafeed", + "description": "Returns defaults and limits used by machine learning.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", + "name": "ml.info", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.start_datafeed" + "namespace": "ml.info" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "ml.start_datafeed" + "namespace": "ml.info" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "6.3.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_ml/datafeeds/{datafeed_id}/_start" + "path": "/_ml/info" } ], "visibility": "public" @@ -11483,13 +11279,13 @@ "visibility": "public" }, "stack": { - "since": "8.0.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Start a trained model deployment.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", - "name": "ml.start_trained_model_deployment", + "description": "Opens one or more anomaly detection jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", + "name": "ml.open_job", "privileges": { "cluster": [ "manage_ml" @@ -11497,7 +11293,7 @@ }, "request": { "name": "Request", - "namespace": "ml.start_trained_model_deployment" + "namespace": "ml.open_job" }, "requestBodyRequired": false, "requestMediaType": [ @@ -11505,19 +11301,19 @@ ], "response": { "name": "Response", - "namespace": "ml.start_trained_model_deployment" + "namespace": "ml.open_job" }, "responseMediaType": [ "application/json" ], - "since": "8.0.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_ml/trained_models/{model_id}/deployment/_start" + "path": "/_ml/anomaly_detectors/{job_id}/_open" } ], "visibility": "public" @@ -11529,13 +11325,13 @@ "visibility": "public" }, "stack": { - "since": "7.3.0", + "since": "6.2.0", "stability": "stable" } }, - "description": "Stops one or more data frame analytics jobs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", - "name": "ml.stop_data_frame_analytics", + "description": "Posts scheduled events in a calendar.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", + "name": "ml.post_calendar_events", "privileges": { "cluster": [ "manage_ml" @@ -11543,45 +11339,41 @@ }, "request": { "name": "Request", - "namespace": "ml.stop_data_frame_analytics" + "namespace": "ml.post_calendar_events" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.stop_data_frame_analytics" + "namespace": "ml.post_calendar_events" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "6.2.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_ml/data_frame/analytics/{id}/_stop" + "path": "/_ml/calendars/{calendar_id}/events" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { "since": "5.4.0", "stability": "stable" } }, - "description": "Stops one or more datafeeds.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", - "name": "ml.stop_datafeed", + "description": "Sends data to an anomaly detection job for analysis.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", + "name": "ml.post_data", "privileges": { "cluster": [ "manage_ml" @@ -11589,15 +11381,16 @@ }, "request": { "name": "Request", - "namespace": "ml.stop_datafeed" + "namespace": "ml.post_data" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ + "application/x-ndjson", "application/json" ], "response": { "name": "Response", - "namespace": "ml.stop_datafeed" + "namespace": "ml.post_data" }, "responseMediaType": [ "application/json" @@ -11609,7 +11402,7 @@ "methods": [ "POST" ], - "path": "/_ml/datafeeds/{datafeed_id}/_stop" + "path": "/_ml/anomaly_detectors/{job_id}/_data" } ], "visibility": "public" @@ -11621,21 +11414,21 @@ "visibility": "public" }, "stack": { - "since": "8.0.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Stop a trained model deployment.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", - "name": "ml.stop_trained_model_deployment", + "description": "Previews that will be analyzed given a data frame analytics config.", + "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", + "name": "ml.preview_data_frame_analytics", "privileges": { "cluster": [ - "manage_ml" + "monitor_ml" ] }, "request": { "name": "Request", - "namespace": "ml.stop_trained_model_deployment" + "namespace": "ml.preview_data_frame_analytics" }, "requestBodyRequired": false, "requestMediaType": [ @@ -11643,19 +11436,27 @@ ], "response": { "name": "Response", - "namespace": "ml.stop_trained_model_deployment" + "namespace": "ml.preview_data_frame_analytics" }, "responseMediaType": [ "application/json" ], - "since": "8.0.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ + "GET", + "POST" + ], + "path": "/_ml/data_frame/analytics/_preview" + }, + { + "methods": [ + "GET", "POST" ], - "path": "/_ml/trained_models/{model_id}/deployment/_stop" + "path": "/_ml/data_frame/analytics/{id}/_preview" } ], "visibility": "public" @@ -11667,48 +11468,52 @@ "visibility": "public" }, "stack": { - "since": "7.3.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Updates certain properties of a data frame analytics job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", - "name": "ml.update_data_frame_analytics", + "description": "Previews a datafeed.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", + "name": "ml.preview_datafeed", "privileges": { "cluster": [ "manage_ml" ], "index": [ - "read", - "create_index", - "manage", - "index", - "view_index_metadata" + "read" ] }, "request": { "name": "Request", - "namespace": "ml.update_data_frame_analytics" + "namespace": "ml.preview_datafeed" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.update_data_frame_analytics" + "namespace": "ml.preview_datafeed" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ + "GET", + "POST" + ], + "path": "/_ml/datafeeds/{datafeed_id}/_preview" + }, + { + "methods": [ + "GET", "POST" ], - "path": "/_ml/data_frame/analytics/{id}/_update" + "path": "/_ml/datafeeds/_preview" } ], "visibility": "public" @@ -11720,13 +11525,13 @@ "visibility": "public" }, "stack": { - "since": "6.4.0", + "since": "6.2.0", "stability": "stable" } }, - "description": "Updates certain properties of a datafeed.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", - "name": "ml.update_datafeed", + "description": "Instantiates a calendar.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", + "name": "ml.put_calendar", "privileges": { "cluster": [ "manage_ml" @@ -11734,27 +11539,27 @@ }, "request": { "name": "Request", - "namespace": "ml.update_datafeed" + "namespace": "ml.put_calendar" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.update_datafeed" + "namespace": "ml.put_calendar" }, "responseMediaType": [ "application/json" ], - "since": "6.4.0", + "since": "6.2.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/datafeeds/{datafeed_id}/_update" + "path": "/_ml/calendars/{calendar_id}" } ], "visibility": "public" @@ -11766,13 +11571,13 @@ "visibility": "public" }, "stack": { - "since": "6.4.0", + "since": "6.2.0", "stability": "stable" } }, - "description": "Updates the description of a filter, adds items, or removes items.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", - "name": "ml.update_filter", + "description": "Adds an anomaly detection job to a calendar.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", + "name": "ml.put_calendar_job", "privileges": { "cluster": [ "manage_ml" @@ -11780,27 +11585,24 @@ }, "request": { "name": "Request", - "namespace": "ml.update_filter" + "namespace": "ml.put_calendar_job" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ml.update_filter" + "namespace": "ml.put_calendar_job" }, "responseMediaType": [ "application/json" ], - "since": "6.4.0", + "since": "6.2.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/filters/{filter_id}/_update" + "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}" } ], "visibility": "public" @@ -11812,21 +11614,29 @@ "visibility": "public" }, "stack": { - "since": "5.5.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Updates certain properties of an anomaly detection job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", - "name": "ml.update_job", + "description": "Instantiates a data frame analytics job.", + "docId": "put-dfanalytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", + "name": "ml.put_data_frame_analytics", "privileges": { "cluster": [ "manage_ml" + ], + "index": [ + "create_index", + "index", + "manage", + "read", + "view_index_metadata" ] }, "request": { "name": "Request", - "namespace": "ml.update_job" + "namespace": "ml.put_data_frame_analytics" }, "requestBodyRequired": true, "requestMediaType": [ @@ -11834,19 +11644,19 @@ ], "response": { "name": "Response", - "namespace": "ml.update_job" + "namespace": "ml.put_data_frame_analytics" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/anomaly_detectors/{job_id}/_update" + "path": "/_ml/data_frame/analytics/{id}" } ], "visibility": "public" @@ -11855,24 +11665,27 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, - "description": "Updates certain properties of a snapshot.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", - "name": "ml.update_model_snapshot", + "description": "Instantiates a datafeed.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", + "name": "ml.put_datafeed", "privileges": { "cluster": [ "manage_ml" + ], + "index": [ + "read" ] }, "request": { "name": "Request", - "namespace": "ml.update_model_snapshot" + "namespace": "ml.put_datafeed" }, "requestBodyRequired": true, "requestMediaType": [ @@ -11880,7 +11693,7 @@ ], "response": { "name": "Response", - "namespace": "ml.update_model_snapshot" + "namespace": "ml.put_datafeed" }, "responseMediaType": [ "application/json" @@ -11890,39 +11703,55 @@ "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update" + "path": "/_ml/datafeeds/{datafeed_id}" } ], "visibility": "public" }, { "availability": { - "stack": { - "stability": "beta", + "serverless": { + "stability": "stable", "visibility": "public" + }, + "stack": { + "since": "5.4.0", + "stability": "stable" } }, - "description": "Updates certain properties of trained model deployment.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", - "name": "ml.update_trained_model_deployment", - "request": null, + "description": "Instantiates a filter.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", + "name": "ml.put_filter", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, + "request": { + "name": "Request", + "namespace": "ml.put_filter" + }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": null, + "response": { + "name": "Response", + "namespace": "ml.put_filter" + }, "responseMediaType": [ "application/json" ], - "stability": "beta", + "since": "5.4.0", + "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/trained_models/{model_id}/deployment/_update" + "path": "/_ml/filters/{filter_id}" } ], "visibility": "public" @@ -11931,29 +11760,35 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { "since": "5.4.0", "stability": "stable" } }, - "description": "Upgrades a given job snapshot to the current major version.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", - "name": "ml.upgrade_job_snapshot", + "description": "Instantiates an anomaly detection job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", + "name": "ml.put_job", "privileges": { "cluster": [ "manage_ml" + ], + "index": [ + "read" ] }, "request": { "name": "Request", - "namespace": "ml.upgrade_job_snapshot" + "namespace": "ml.put_job" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.upgrade_job_snapshot" + "namespace": "ml.put_job" }, "responseMediaType": [ "application/json" @@ -11963,9 +11798,9 @@ "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade" + "path": "/_ml/anomaly_detectors/{job_id}" } ], "visibility": "public" @@ -11974,20 +11809,24 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "6.3.0", - "stability": "stable", - "visibility": "private" + "since": "7.10.0", + "stability": "stable" } }, - "description": "Validates an anomaly detection job.", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", - "name": "ml.validate", - "request": { + "description": "Creates an inference trained model.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", + "name": "ml.put_trained_model", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, + "request": { "name": "Request", - "namespace": "ml.validate" + "namespace": "ml.put_trained_model" }, "requestBodyRequired": true, "requestMediaType": [ @@ -11995,113 +11834,114 @@ ], "response": { "name": "Response", - "namespace": "ml.validate" + "namespace": "ml.put_trained_model" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "7.10.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/anomaly_detectors/_validate" + "path": "/_ml/trained_models/{model_id}" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "5.4.0", - "stability": "stable", - "visibility": "private" + "since": "7.13.0", + "stability": "stable" } }, - "description": "Validates an anomaly detection detector.", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", - "name": "ml.validate_detector", + "description": "Creates a new model alias (or reassigns an existing one) to refer to the trained model", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", + "name": "ml.put_trained_model_alias", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "ml.validate_detector" + "namespace": "ml.put_trained_model_alias" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "ml.validate_detector" + "namespace": "ml.put_trained_model_alias" }, "responseMediaType": [ "application/json" ], - "since": "5.4.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_ml/anomaly_detectors/_validate/detector" + "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.3.0", + "since": "8.0.0", "stability": "stable" } }, - "description": "Used by the monitoring features to send monitoring data.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", - "name": "monitoring.bulk", + "description": "Creates part of a trained model definition", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", + "name": "ml.put_trained_model_definition_part", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "monitoring.bulk" + "namespace": "ml.put_trained_model_definition_part" }, "requestBodyRequired": true, "requestMediaType": [ - "application/x-ndjson" + "application/json" ], "response": { "name": "Response", - "namespace": "monitoring.bulk" + "namespace": "ml.put_trained_model_definition_part" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "8.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST", - "PUT" - ], - "path": "/_monitoring/bulk" - }, - { - "deprecation": { - "description": "Specifying types in urls has been deprecated", - "version": "7.0.0" - }, - "methods": [ - "POST", "PUT" ], - "path": "/_monitoring/{type}/bulk" + "path": "/_ml/trained_models/{model_id}/definition/{part}" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { @@ -12110,49 +11950,41 @@ "visibility": "public" }, "stack": { - "since": "1.3.0", + "since": "8.0.0", "stability": "stable" } }, - "description": "Allows to execute several search operations in one request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", - "name": "msearch", + "description": "Creates a trained model vocabulary", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", + "name": "ml.put_trained_model_vocabulary", "privileges": { - "index": [ - "read" + "cluster": [ + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "_global.msearch" + "namespace": "ml.put_trained_model_vocabulary" }, "requestBodyRequired": true, "requestMediaType": [ - "application/x-ndjson" + "application/json" ], "response": { "name": "Response", - "namespace": "_global.msearch" + "namespace": "ml.put_trained_model_vocabulary" }, "responseMediaType": [ "application/json" ], - "since": "1.3.0", + "since": "8.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_msearch" - }, - { - "methods": [ - "GET", - "POST" + "PUT" ], - "path": "/{index}/_msearch" + "path": "/_ml/trained_models/{model_id}/vocabulary" } ], "visibility": "public" @@ -12164,49 +11996,38 @@ "visibility": "public" }, "stack": { - "since": "5.0.0", + "since": "7.14.0", "stability": "stable" } }, - "description": "Allows to execute several search template operations in one request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", - "name": "msearch_template", + "description": "Resets an existing anomaly detection job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", + "name": "ml.reset_job", "privileges": { - "index": [ - "read" + "cluster": [ + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "_global.msearch_template" + "namespace": "ml.reset_job" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/x-ndjson" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "_global.msearch_template" + "namespace": "ml.reset_job" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", + "since": "7.14.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_msearch/template" - }, - { - "methods": [ - "GET", "POST" ], - "path": "/{index}/_msearch/template" + "path": "/_ml/anomaly_detectors/{job_id}/_reset" } ], "visibility": "public" @@ -12215,19 +12036,24 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "0.0.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Returns multiple termvectors in one request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", - "name": "mtermvectors", + "description": "Reverts to a specific snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", + "name": "ml.revert_model_snapshot", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "_global.mtermvectors" + "namespace": "ml.revert_model_snapshot" }, "requestBodyRequired": false, "requestMediaType": [ @@ -12235,27 +12061,19 @@ ], "response": { "name": "Response", - "namespace": "_global.mtermvectors" + "namespace": "ml.revert_model_snapshot" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_mtermvectors" - }, - { - "methods": [ - "GET", "POST" ], - "path": "/{index}/_mtermvectors" + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert" } ], "visibility": "public" @@ -12263,43 +12081,42 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "private" }, "stack": { - "since": "7.16.0", - "stability": "experimental" + "since": "6.7.0", + "stability": "stable" } }, - "description": "Removes the archived repositories metering information present in the cluster.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", - "name": "nodes.clear_repositories_metering_archive", + "description": "Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", + "name": "ml.set_upgrade_mode", "privileges": { "cluster": [ - "monitor", - "manage" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "nodes.clear_repositories_metering_archive" + "namespace": "ml.set_upgrade_mode" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "nodes.clear_repositories_metering_archive" + "namespace": "ml.set_upgrade_mode" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", - "stability": "experimental", + "since": "6.7.0", + "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_nodes/{node_id}/_repositories_metering/{max_archive_version}" + "path": "/_ml/set_upgrade_mode" } ], "visibility": "public" @@ -12307,43 +12124,52 @@ { "availability": { "serverless": { - "stability": "experimental", - "visibility": "private" + "stability": "stable", + "visibility": "public" }, "stack": { - "since": "7.16.0", - "stability": "experimental" + "since": "7.3.0", + "stability": "stable" } }, - "description": "Returns cluster repositories metering information.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", - "name": "nodes.get_repositories_metering_info", + "description": "Starts a data frame analytics job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", + "name": "ml.start_data_frame_analytics", "privileges": { "cluster": [ - "monitor", - "manage" + "manage_ml" + ], + "index": [ + "create_index", + "index", + "manage", + "read", + "view_index_metadata" ] }, "request": { "name": "Request", - "namespace": "nodes.get_repositories_metering_info" + "namespace": "ml.start_data_frame_analytics" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "nodes.get_repositories_metering_info" + "namespace": "ml.start_data_frame_analytics" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", - "stability": "experimental", + "since": "7.3.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_nodes/{node_id}/_repositories_metering" + "path": "/_ml/data_frame/analytics/{id}/_start" } ], "visibility": "public" @@ -12352,49 +12178,44 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Returns information about hot threads on each node in the cluster.", - "docId": "cluster-nodes-hot-threads", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html", - "name": "nodes.hot_threads", + "description": "Starts one or more datafeeds.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", + "name": "ml.start_datafeed", "privileges": { "cluster": [ - "monitor", - "manage" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "nodes.hot_threads" + "namespace": "ml.start_datafeed" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "nodes.hot_threads" + "namespace": "ml.start_datafeed" }, "responseMediaType": [ - "text/plain" + "application/json" ], - "since": "0.0.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_nodes/hot_threads" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_nodes/{node_id}/hot_threads" + "path": "/_ml/datafeeds/{datafeed_id}/_start" } ], "visibility": "public" @@ -12403,72 +12224,70 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "1.3.0", + "since": "8.0.0", "stability": "stable" } }, - "description": "Returns information about nodes in the cluster.", - "docId": "cluster-nodes-info", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html", - "name": "nodes.info", + "description": "Start a trained model deployment.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", + "name": "ml.start_trained_model_deployment", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "nodes.info" + "namespace": "ml.start_trained_model_deployment" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "nodes.info" + "namespace": "ml.start_trained_model_deployment" }, "responseMediaType": [ "application/json" ], - "since": "1.3.0", + "since": "8.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_nodes" - }, - { - "methods": [ - "GET" - ], - "path": "/_nodes/{node_id}" - }, - { - "methods": [ - "GET" - ], - "path": "/_nodes/{metric}" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_nodes/{node_id}/{metric}" + "path": "/_ml/trained_models/{model_id}/deployment/_start" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.5.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Reloads secure settings.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", - "name": "nodes.reload_secure_settings", + "description": "Stops one or more data frame analytics jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", + "name": "ml.stop_data_frame_analytics", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "nodes.reload_secure_settings" + "namespace": "ml.stop_data_frame_analytics" }, "requestBodyRequired": false, "requestMediaType": [ @@ -12476,25 +12295,19 @@ ], "response": { "name": "Response", - "namespace": "nodes.reload_secure_settings" + "namespace": "ml.stop_data_frame_analytics" }, "responseMediaType": [ "application/json" ], - "since": "6.5.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_nodes/reload_secure_settings" - }, - { - "methods": [ - "POST" - ], - "path": "/_nodes/{node_id}/reload_secure_settings" + "path": "/_ml/data_frame/analytics/{id}/_stop" } ], "visibility": "public" @@ -12503,73 +12316,44 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "5.4.0", "stability": "stable" } }, - "description": "Returns statistical information about nodes in the cluster.", - "docId": "cluster-nodes-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", - "name": "nodes.stats", + "description": "Stops one or more datafeeds.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", + "name": "ml.stop_datafeed", "privileges": { "cluster": [ - "monitor", - "manage" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "nodes.stats" + "namespace": "ml.stop_datafeed" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "nodes.stats" + "namespace": "ml.stop_datafeed" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_nodes/stats" - }, - { - "methods": [ - "GET" - ], - "path": "/_nodes/{node_id}/stats" - }, - { - "methods": [ - "GET" - ], - "path": "/_nodes/stats/{metric}" - }, - { - "methods": [ - "GET" - ], - "path": "/_nodes/{node_id}/stats/{metric}" - }, - { - "methods": [ - "GET" - ], - "path": "/_nodes/stats/{metric}/{index_metric}" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_nodes/{node_id}/stats/{metric}/{index_metric}" + "path": "/_ml/datafeeds/{datafeed_id}/_stop" } ], "visibility": "public" @@ -12578,61 +12362,44 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "6.0.0", + "since": "8.0.0", "stability": "stable" } }, - "description": "Returns low-level information about REST actions usage on nodes.", - "docId": "cluster-nodes-usage", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html", - "name": "nodes.usage", + "description": "Stop a trained model deployment.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", + "name": "ml.stop_trained_model_deployment", "privileges": { "cluster": [ - "monitor", - "manage" + "manage_ml" ] }, "request": { "name": "Request", - "namespace": "nodes.usage" + "namespace": "ml.stop_trained_model_deployment" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "nodes.usage" + "namespace": "ml.stop_trained_model_deployment" }, "responseMediaType": [ "application/json" ], - "since": "6.0.0", + "since": "8.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_nodes/usage" - }, - { - "methods": [ - "GET" - ], - "path": "/_nodes/{node_id}/usage" - }, - { - "methods": [ - "GET" - ], - "path": "/_nodes/usage/{metric}" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_nodes/{node_id}/usage/{metric}" + "path": "/_ml/trained_models/{model_id}/deployment/_stop" } ], "visibility": "public" @@ -12644,39 +12411,48 @@ "visibility": "public" }, "stack": { - "since": "7.10.0", + "since": "7.3.0", "stability": "stable" } }, - "description": "Open a point in time that can be used in subsequent searches", - "docId": "point-in-time-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", - "name": "open_point_in_time", + "description": "Updates certain properties of a data frame analytics job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", + "name": "ml.update_data_frame_analytics", "privileges": { + "cluster": [ + "manage_ml" + ], "index": [ - "read" + "read", + "create_index", + "manage", + "index", + "view_index_metadata" ] }, "request": { "name": "Request", - "namespace": "_global.open_point_in_time" + "namespace": "ml.update_data_frame_analytics" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.open_point_in_time" + "namespace": "ml.update_data_frame_analytics" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/{index}/_pit" + "path": "/_ml/data_frame/analytics/{id}/_update" } ], "visibility": "public" @@ -12688,33 +12464,41 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "6.4.0", "stability": "stable" } }, - "description": "Returns whether the cluster is running.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", - "name": "ping", - "request": { - "name": "Request", - "namespace": "_global.ping" - }, - "requestBodyRequired": false, + "description": "Updates certain properties of a datafeed.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", + "name": "ml.update_datafeed", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, + "request": { + "name": "Request", + "namespace": "ml.update_datafeed" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.ping" + "namespace": "ml.update_datafeed" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "6.4.0", "stability": "stable", "urls": [ { "methods": [ - "HEAD" + "POST" ], - "path": "/" + "path": "/_ml/datafeeds/{datafeed_id}/_update" } ], "visibility": "public" @@ -12726,16 +12510,21 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "6.4.0", "stability": "stable" } }, - "description": "Creates or updates a script.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", - "name": "put_script", + "description": "Updates the description of a filter, adds items, or removes items.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", + "name": "ml.update_filter", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "_global.put_script" + "namespace": "ml.update_filter" }, "requestBodyRequired": true, "requestMediaType": [ @@ -12743,27 +12532,19 @@ ], "response": { "name": "Response", - "namespace": "_global.put_script" + "namespace": "ml.update_filter" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "6.4.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" - ], - "path": "/_scripts/{id}" - }, - { - "methods": [ - "PUT", "POST" ], - "path": "/_scripts/{id}/{context}" + "path": "/_ml/filters/{filter_id}/_update" } ], "visibility": "public" @@ -12771,37 +12552,45 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "8.10.0", - "stability": "experimental" + "since": "5.5.0", + "stability": "stable" } }, - "description": "Deletes a query ruleset.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html", - "name": "query_ruleset.delete", + "description": "Updates certain properties of an anomaly detection job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", + "name": "ml.update_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "query_ruleset.delete" + "namespace": "ml.update_job" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "query_ruleset.delete" + "namespace": "ml.update_job" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", - "stability": "experimental", + "since": "5.5.0", + "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_query_rules/{ruleset_id}" + "path": "/_ml/anomaly_detectors/{job_id}/_update" } ], "visibility": "public" @@ -12809,75 +12598,118 @@ { "availability": { "serverless": { - "stability": "experimental", - "visibility": "public" + "stability": "stable", + "visibility": "private" }, "stack": { - "since": "8.10.0", - "stability": "experimental" + "since": "5.4.0", + "stability": "stable" } }, - "description": "Returns the details about a query ruleset.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html", - "name": "query_ruleset.get", + "description": "Updates certain properties of a snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", + "name": "ml.update_model_snapshot", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "query_ruleset.get" + "namespace": "ml.update_model_snapshot" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "query_ruleset.get" + "namespace": "ml.update_model_snapshot" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", - "stability": "experimental", + "since": "5.4.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_query_rules/{ruleset_id}" + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "experimental", + "stack": { + "stability": "beta", "visibility": "public" + } + }, + "description": "Updates certain properties of trained model deployment.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", + "name": "ml.update_trained_model_deployment", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "beta", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_ml/trained_models/{model_id}/deployment/_update" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" }, "stack": { - "since": "8.10.0", - "stability": "experimental" + "since": "5.4.0", + "stability": "stable" } }, - "description": "Lists query rulesets.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html", - "name": "query_ruleset.list", + "description": "Upgrades a given job snapshot to the current major version.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", + "name": "ml.upgrade_job_snapshot", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "query_ruleset.list" + "namespace": "ml.upgrade_job_snapshot" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "query_ruleset.list" + "namespace": "ml.upgrade_job_snapshot" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", - "stability": "experimental", + "since": "5.4.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_query_rules" + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade" } ], "visibility": "public" @@ -12885,20 +12717,21 @@ { "availability": { "serverless": { - "stability": "experimental", - "visibility": "public" + "stability": "stable", + "visibility": "private" }, "stack": { - "since": "8.10.0", - "stability": "experimental" + "since": "6.3.0", + "stability": "stable", + "visibility": "private" } }, - "description": "Creates or updates a query ruleset.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html", - "name": "query_ruleset.put", + "description": "Validates an anomaly detection job.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", + "name": "ml.validate", "request": { "name": "Request", - "namespace": "query_ruleset.put" + "namespace": "ml.validate" }, "requestBodyRequired": true, "requestMediaType": [ @@ -12906,45 +12739,41 @@ ], "response": { "name": "Response", - "namespace": "query_ruleset.put" + "namespace": "ml.validate" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", - "stability": "experimental", + "since": "6.3.0", + "stability": "stable", "urls": [ { "methods": [ - "PUT" + "POST" ], - "path": "/_query_rules/{ruleset_id}" + "path": "/_ml/anomaly_detectors/_validate" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "6.2.0", - "stability": "stable" + "since": "5.4.0", + "stability": "stable", + "visibility": "private" } }, - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", - "name": "rank_eval", - "privileges": { - "index": [ - "read" - ] - }, + "description": "Validates an anomaly detection detector.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", + "name": "ml.validate_detector", "request": { "name": "Request", - "namespace": "_global.rank_eval" + "namespace": "ml.validate_detector" }, "requestBodyRequired": true, "requestMediaType": [ @@ -12952,30 +12781,71 @@ ], "response": { "name": "Response", - "namespace": "_global.rank_eval" + "namespace": "ml.validate_detector" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "5.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET", "POST" ], - "path": "/_rank_eval" + "path": "/_ml/anomaly_detectors/_validate/detector" + } + ], + "visibility": "private" + }, + { + "availability": { + "stack": { + "since": "6.3.0", + "stability": "stable" + } + }, + "description": "Used by the monitoring features to send monitoring data.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", + "name": "monitoring.bulk", + "request": { + "name": "Request", + "namespace": "monitoring.bulk" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], + "response": { + "name": "Response", + "namespace": "monitoring.bulk" + }, + "responseMediaType": [ + "application/json" + ], + "since": "6.3.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "POST", + "PUT" + ], + "path": "/_monitoring/bulk" }, { + "deprecation": { + "description": "Specifying types in urls has been deprecated", + "version": "7.0.0" + }, "methods": [ - "GET", - "POST" + "POST", + "PUT" ], - "path": "/{index}/_rank_eval" + "path": "/_monitoring/{type}/bulk" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { @@ -12984,36 +12854,49 @@ "visibility": "public" }, "stack": { - "since": "2.3.0", + "since": "1.3.0", "stability": "stable" } }, - "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", - "name": "reindex", + "description": "Allows to execute several search operations in one request.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", + "name": "msearch", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", - "namespace": "_global.reindex" + "namespace": "_global.msearch" }, "requestBodyRequired": true, "requestMediaType": [ - "application/json" + "application/x-ndjson" ], "response": { "name": "Response", - "namespace": "_global.reindex" + "namespace": "_global.msearch" }, "responseMediaType": [ "application/json" ], - "since": "2.3.0", + "since": "1.3.0", "stability": "stable", "urls": [ { "methods": [ + "GET", + "POST" + ], + "path": "/_msearch" + }, + { + "methods": [ + "GET", "POST" ], - "path": "/_reindex" + "path": "/{index}/_msearch" } ], "visibility": "public" @@ -13022,36 +12905,52 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "2.4.0", + "since": "5.0.0", "stability": "stable" } }, - "description": "Changes the number of requests per second for a particular Reindex operation.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", - "name": "reindex_rethrottle", + "description": "Allows to execute several search template operations in one request.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", + "name": "msearch_template", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", - "namespace": "_global.reindex_rethrottle" + "namespace": "_global.msearch_template" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": { "name": "Response", - "namespace": "_global.reindex_rethrottle" + "namespace": "_global.msearch_template" }, "responseMediaType": [ "application/json" ], - "since": "2.4.0", + "since": "5.0.0", "stability": "stable", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_reindex/{task_id}/_rethrottle" + "path": "/_msearch/template" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_msearch/template" } ], "visibility": "public" @@ -13067,12 +12966,12 @@ "stability": "stable" } }, - "description": "Allows to use the Mustache language to pre-render a search definition.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", - "name": "render_search_template", + "description": "Returns multiple termvectors in one request.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", + "name": "mtermvectors", "request": { "name": "Request", - "namespace": "_global.render_search_template" + "namespace": "_global.mtermvectors" }, "requestBodyRequired": false, "requestMediaType": [ @@ -13080,7 +12979,7 @@ ], "response": { "name": "Response", - "namespace": "_global.render_search_template" + "namespace": "_global.mtermvectors" }, "responseMediaType": [ "application/json" @@ -13093,162 +12992,210 @@ "GET", "POST" ], - "path": "/_render/template" + "path": "/_mtermvectors" }, { "methods": [ "GET", "POST" ], - "path": "/_render/template/{id}" + "path": "/{index}/_mtermvectors" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "experimental", + "visibility": "private" + }, "stack": { - "since": "6.3.0", + "since": "7.16.0", "stability": "experimental" } }, - "description": "Deletes an existing rollup job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", - "name": "rollup.delete_job", + "description": "Removes the archived repositories metering information present in the cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", + "name": "nodes.clear_repositories_metering_archive", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "rollup.delete_job" + "namespace": "nodes.clear_repositories_metering_archive" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.delete_job" + "namespace": "nodes.clear_repositories_metering_archive" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "7.16.0", "stability": "experimental", "urls": [ { "methods": [ "DELETE" ], - "path": "/_rollup/job/{id}" + "path": "/_nodes/{node_id}/_repositories_metering/{max_archive_version}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "experimental", + "visibility": "private" + }, "stack": { - "since": "6.3.0", + "since": "7.16.0", "stability": "experimental" } }, - "description": "Retrieves the configuration, stats, and status of rollup jobs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", - "name": "rollup.get_jobs", + "description": "Returns cluster repositories metering information.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", + "name": "nodes.get_repositories_metering_info", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "rollup.get_jobs" + "namespace": "nodes.get_repositories_metering_info" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.get_jobs" + "namespace": "nodes.get_repositories_metering_info" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "7.16.0", "stability": "experimental", "urls": [ { "methods": [ "GET" ], - "path": "/_rollup/job/{id}" - }, - { - "methods": [ - "GET" - ], - "path": "/_rollup/job" + "path": "/_nodes/{node_id}/_repositories_metering" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "6.3.0", - "stability": "experimental" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", - "name": "rollup.get_rollup_caps", + "description": "Returns information about hot threads on each node in the cluster.", + "docId": "cluster-nodes-hot-threads", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html", + "name": "nodes.hot_threads", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "rollup.get_rollup_caps" + "namespace": "nodes.hot_threads" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.get_rollup_caps" + "namespace": "nodes.hot_threads" }, "responseMediaType": [ - "application/json" + "text/plain" ], - "since": "6.3.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_rollup/data/{id}" + "path": "/_nodes/hot_threads" }, { "methods": [ "GET" ], - "path": "/_rollup/data" + "path": "/_nodes/{node_id}/hot_threads" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "6.4.0", - "stability": "experimental" + "since": "1.3.0", + "stability": "stable" } }, - "description": "Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", - "name": "rollup.get_rollup_index_caps", + "description": "Returns information about nodes in the cluster.", + "docId": "cluster-nodes-info", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html", + "name": "nodes.info", "request": { "name": "Request", - "namespace": "rollup.get_rollup_index_caps" + "namespace": "nodes.info" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.get_rollup_index_caps" + "namespace": "nodes.info" }, "responseMediaType": [ "application/json" ], - "since": "6.4.0", - "stability": "experimental", + "since": "1.3.0", + "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/{index}/_rollup/data" + "path": "/_nodes" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{node_id}" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{metric}" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{node_id}/{metric}" } ], "visibility": "public" @@ -13256,148 +13203,224 @@ { "availability": { "stack": { - "since": "6.3.0", - "stability": "experimental" + "since": "6.5.0", + "stability": "stable" } }, - "description": "Creates a rollup job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", - "name": "rollup.put_job", - "privileges": { - "cluster": [ - "manage", - "manage_rollup" - ] - }, + "description": "Reloads secure settings.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", + "name": "nodes.reload_secure_settings", "request": { "name": "Request", - "namespace": "rollup.put_job" + "namespace": "nodes.reload_secure_settings" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "rollup.put_job" + "namespace": "nodes.reload_secure_settings" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", - "stability": "experimental", + "since": "6.5.0", + "stability": "stable", "urls": [ { "methods": [ - "PUT" + "POST" ], - "path": "/_rollup/job/{id}" + "path": "/_nodes/reload_secure_settings" + }, + { + "methods": [ + "POST" + ], + "path": "/_nodes/{node_id}/reload_secure_settings" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "6.3.0", - "stability": "experimental" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Enables searching rolled-up data using the standard query DSL.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", - "name": "rollup.rollup_search", + "description": "Returns statistical information about nodes in the cluster.", + "docId": "cluster-nodes-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", + "name": "nodes.stats", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "rollup.rollup_search" + "namespace": "nodes.stats" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.rollup_search" + "namespace": "nodes.stats" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/{index}/_rollup_search" + "path": "/_nodes/stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{node_id}/stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/stats/{metric}" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{node_id}/stats/{metric}" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/stats/{metric}/{index_metric}" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{node_id}/stats/{metric}/{index_metric}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "6.3.0", - "stability": "experimental" + "since": "6.0.0", + "stability": "stable" } }, - "description": "Starts an existing, stopped rollup job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", - "name": "rollup.start_job", + "description": "Returns low-level information about REST actions usage on nodes.", + "docId": "cluster-nodes-usage", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html", + "name": "nodes.usage", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", - "namespace": "rollup.start_job" + "namespace": "nodes.usage" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.start_job" + "namespace": "nodes.usage" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", - "stability": "experimental", + "since": "6.0.0", + "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_rollup/job/{id}/_start" + "path": "/_nodes/usage" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{node_id}/usage" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/usage/{metric}" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{node_id}/usage/{metric}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "6.3.0", - "stability": "experimental" + "since": "7.10.0", + "stability": "stable" } }, - "description": "Stops an existing, started rollup job.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", - "name": "rollup.stop_job", + "description": "Open a point in time that can be used in subsequent searches", + "docId": "point-in-time-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", + "name": "open_point_in_time", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", - "namespace": "rollup.stop_job" + "namespace": "_global.open_point_in_time" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.stop_job" + "namespace": "_global.open_point_in_time" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", - "stability": "experimental", + "since": "7.10.0", + "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_rollup/job/{id}/_stop" + "path": "/{index}/_pit" } ], "visibility": "public" @@ -13405,41 +13428,37 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "6.3.0", - "stability": "experimental" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Allows an arbitrary script to be executed and a result to be returned", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", - "name": "scripts_painless_execute", + "description": "Returns whether the cluster is running.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "name": "ping", "request": { "name": "Request", - "namespace": "_global.scripts_painless_execute" + "namespace": "_global.ping" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "_global.scripts_painless_execute" + "namespace": "_global.ping" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "HEAD" ], - "path": "/_scripts/painless/_execute" + "path": "/" } ], "visibility": "public" @@ -13455,20 +13474,20 @@ "stability": "stable" } }, - "description": "Allows to retrieve a large numbers of results from a single search request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", - "name": "scroll", + "description": "Creates or updates a script.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", + "name": "put_script", "request": { "name": "Request", - "namespace": "_global.scroll" + "namespace": "_global.put_script" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "_global.scroll" + "namespace": "_global.put_script" }, "responseMediaType": [ "application/json" @@ -13478,21 +13497,17 @@ "urls": [ { "methods": [ - "GET", + "PUT", "POST" ], - "path": "/_search/scroll" + "path": "/_scripts/{id}" }, { - "deprecation": { - "description": "A scroll id can be quite large and should be specified as part of the body", - "version": "7.0.0" - }, "methods": [ - "GET", + "PUT", "POST" ], - "path": "/_search/scroll/{scroll_id}" + "path": "/_scripts/{id}/{context}" } ], "visibility": "public" @@ -13500,53 +13515,37 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "8.10.0", + "stability": "experimental" } }, - "description": "Returns results matching a query.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", - "name": "search", - "privileges": { - "index": [ - "read" - ] - }, + "description": "Deletes a query ruleset.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html", + "name": "query_ruleset.delete", "request": { "name": "Request", - "namespace": "_global.search" + "namespace": "query_ruleset.delete" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "_global.search" + "namespace": "query_ruleset.delete" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "8.10.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_search" - }, - { - "methods": [ - "GET", - "POST" + "DELETE" ], - "path": "/{index}/_search" + "path": "/_query_rules/{ruleset_id}" } ], "visibility": "public" @@ -13554,37 +13553,37 @@ { "availability": { "serverless": { - "stability": "beta", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "8.8.0", - "stability": "beta" + "since": "8.10.0", + "stability": "experimental" } }, - "description": "Deletes a search application.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", - "name": "search_application.delete", + "description": "Returns the details about a query ruleset.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html", + "name": "query_ruleset.get", "request": { "name": "Request", - "namespace": "search_application.delete" + "namespace": "query_ruleset.get" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "search_application.delete" + "namespace": "query_ruleset.get" }, "responseMediaType": [ "application/json" ], - "since": "8.8.0", - "stability": "beta", + "since": "8.10.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_application/search_application/{name}" + "path": "/_query_rules/{ruleset_id}" } ], "visibility": "public" @@ -13596,33 +13595,33 @@ "visibility": "public" }, "stack": { - "since": "8.8.0", + "since": "8.10.0", "stability": "experimental" } }, - "description": "Delete a behavioral analytics collection.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", - "name": "search_application.delete_behavioral_analytics", + "description": "Lists query rulesets.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html", + "name": "query_ruleset.list", "request": { "name": "Request", - "namespace": "search_application.delete_behavioral_analytics" + "namespace": "query_ruleset.list" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "search_application.delete_behavioral_analytics" + "namespace": "query_ruleset.list" }, "responseMediaType": [ "application/json" ], - "since": "8.8.0", + "since": "8.10.0", "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_application/analytics/{name}" + "path": "/_query_rules" } ], "visibility": "public" @@ -13630,37 +13629,40 @@ { "availability": { "serverless": { - "stability": "beta", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "8.8.0", - "stability": "beta" + "since": "8.10.0", + "stability": "experimental" } }, - "description": "Returns the details about a search application.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", - "name": "search_application.get", + "description": "Creates or updates a query ruleset.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html", + "name": "query_ruleset.put", "request": { "name": "Request", - "namespace": "search_application.get" + "namespace": "query_ruleset.put" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "search_application.get" + "namespace": "query_ruleset.put" }, "responseMediaType": [ "application/json" ], - "since": "8.8.0", - "stability": "beta", + "since": "8.10.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/_application/search_application/{name}" + "path": "/_query_rules/{ruleset_id}" } ], "visibility": "public" @@ -13668,43 +13670,53 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "8.8.0", - "stability": "experimental" + "since": "6.2.0", + "stability": "stable" } }, - "description": "Returns the existing behavioral analytics collections.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", - "name": "search_application.get_behavioral_analytics", + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", + "name": "rank_eval", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", - "namespace": "search_application.get_behavioral_analytics" + "namespace": "_global.rank_eval" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "search_application.get_behavioral_analytics" + "namespace": "_global.rank_eval" }, "responseMediaType": [ "application/json" ], - "since": "8.8.0", - "stability": "experimental", + "since": "6.2.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_application/analytics" + "path": "/_rank_eval" }, { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_application/analytics/{name}" + "path": "/{index}/_rank_eval" } ], "visibility": "public" @@ -13712,67 +13724,78 @@ { "availability": { "serverless": { - "stability": "beta", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "8.8.0", - "stability": "beta" + "since": "2.3.0", + "stability": "stable" } }, - "description": "Returns the existing search applications.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html", - "name": "search_application.list", + "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", + "name": "reindex", "request": { "name": "Request", - "namespace": "search_application.list" + "namespace": "_global.reindex" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "search_application.list" + "namespace": "_global.reindex" }, "responseMediaType": [ "application/json" ], - "since": "8.8.0", - "stability": "beta", + "since": "2.3.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_application/search_application" + "path": "/_reindex" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "stability": "experimental", - "visibility": "public" + "since": "2.4.0", + "stability": "stable" } }, - "description": "Creates a behavioral analytics event for existing collection.", - "docUrl": "http://todo.com/tbd", - "name": "search_application.post_behavioral_analytics_event", - "request": null, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], - "response": null, + "description": "Changes the number of requests per second for a particular Reindex operation.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", + "name": "reindex_rethrottle", + "request": { + "name": "Request", + "namespace": "_global.reindex_rethrottle" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "_global.reindex_rethrottle" + }, "responseMediaType": [ "application/json" ], - "stability": "experimental", + "since": "2.4.0", + "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_application/analytics/{collection_name}/event/{event_type}" + "path": "/_reindex/{task_id}/_rethrottle" } ], "visibility": "public" @@ -13780,78 +13803,82 @@ { "availability": { "serverless": { - "stability": "beta", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "8.8.0", - "stability": "beta" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Creates or updates a search application.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", - "name": "search_application.put", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", + "name": "render_search_template", "request": { "name": "Request", - "namespace": "search_application.put" + "namespace": "_global.render_search_template" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "search_application.put" + "namespace": "_global.render_search_template" }, "responseMediaType": [ "application/json" ], - "since": "8.8.0", - "stability": "beta", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET", + "POST" ], - "path": "/_application/search_application/{name}" + "path": "/_render/template" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/_render/template/{id}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "experimental", - "visibility": "public" - }, "stack": { - "since": "8.8.0", + "since": "6.3.0", "stability": "experimental" } }, - "description": "Creates a behavioral analytics collection.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", - "name": "search_application.put_behavioral_analytics", + "description": "Deletes an existing rollup job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", + "name": "rollup.delete_job", "request": { "name": "Request", - "namespace": "search_application.put_behavioral_analytics" + "namespace": "rollup.delete_job" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "search_application.put_behavioral_analytics" + "namespace": "rollup.delete_job" }, "responseMediaType": [ "application/json" ], - "since": "8.8.0", + "since": "6.3.0", "stability": "experimental", "urls": [ { "methods": [ - "PUT" + "DELETE" ], - "path": "/_application/analytics/{name}" + "path": "/_rollup/job/{id}" } ], "visibility": "public" @@ -13859,113 +13886,113 @@ { "availability": { "stack": { - "stability": "experimental", - "visibility": "public" + "since": "6.3.0", + "stability": "experimental" } }, - "description": "Renders a query for given search application search parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-render-query.html", - "name": "search_application.render_query", - "request": null, - "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], - "response": null, + "description": "Retrieves the configuration, stats, and status of rollup jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", + "name": "rollup.get_jobs", + "request": { + "name": "Request", + "namespace": "rollup.get_jobs" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "rollup.get_jobs" + }, "responseMediaType": [ "application/json" ], + "since": "6.3.0", "stability": "experimental", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_application/search_application/{name}/_render_query" + "path": "/_rollup/job/{id}" + }, + { + "methods": [ + "GET" + ], + "path": "/_rollup/job" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "beta", - "visibility": "public" - }, "stack": { - "since": "8.8.0", - "stability": "beta" + "since": "6.3.0", + "stability": "experimental" } }, - "description": "Perform a search against a search application", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", - "name": "search_application.search", + "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", + "name": "rollup.get_rollup_caps", "request": { "name": "Request", - "namespace": "search_application.search" + "namespace": "rollup.get_rollup_caps" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "search_application.search" + "namespace": "rollup.get_rollup_caps" }, "responseMediaType": [ "application/json" ], - "since": "8.8.0", - "stability": "beta", + "since": "6.3.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_application/search_application/{name}/_search" + "path": "/_rollup/data/{id}" + }, + { + "methods": [ + "GET" + ], + "path": "/_rollup/data" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "7.15.0", - "stability": "stable" + "since": "6.4.0", + "stability": "experimental" } }, - "description": "Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", - "name": "search_mvt", + "description": "Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", + "name": "rollup.get_rollup_index_caps", "request": { "name": "Request", - "namespace": "_global.search_mvt" + "namespace": "rollup.get_rollup_index_caps" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "_global.search_mvt" + "namespace": "rollup.get_rollup_index_caps" }, "responseMediaType": [ - "application/vnd.mapbox-vector-tile" + "application/json" ], - "since": "7.15.0", - "stability": "stable", + "since": "6.4.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST", "GET" ], - "path": "/{index}/_mvt/{field}/{zoom}/{x}/{y}" + "path": "/{index}/_rollup/data" } ], "visibility": "public" @@ -13973,62 +14000,59 @@ { "availability": { "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "6.3.0", + "stability": "experimental" } }, - "description": "Returns information about the indices and shards that a search request would be executed against.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", - "name": "search_shards", + "description": "Creates a rollup job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", + "name": "rollup.put_job", + "privileges": { + "cluster": [ + "manage", + "manage_rollup" + ] + }, "request": { "name": "Request", - "namespace": "_global.search_shards" + "namespace": "rollup.put_job" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "_global.search_shards" + "namespace": "rollup.put_job" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "6.3.0", + "stability": "experimental", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_search_shards" - }, - { - "methods": [ - "GET", - "POST" + "PUT" ], - "path": "/{index}/_search_shards" + "path": "/_rollup/job/{id}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "2.0.0", - "stability": "stable" + "since": "6.3.0", + "stability": "experimental" } }, - "description": "Allows to use the Mustache language to pre-render a search definition.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", - "name": "search_template", + "description": "Enables searching rolled-up data using the standard query DSL.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", + "name": "rollup.rollup_search", "request": { "name": "Request", - "namespace": "_global.search_template" + "namespace": "rollup.rollup_search" }, "requestBodyRequired": true, "requestMediaType": [ @@ -14036,27 +14060,20 @@ ], "response": { "name": "Response", - "namespace": "_global.search_template" + "namespace": "rollup.rollup_search" }, "responseMediaType": [ "application/json" ], - "since": "2.0.0", - "stability": "stable", + "since": "6.3.0", + "stability": "experimental", "urls": [ { "methods": [ "GET", "POST" ], - "path": "/_search/template" - }, - { - "methods": [ - "GET", - "POST" - ], - "path": "/{index}/_search/template" + "path": "/{index}/_rollup_search" } ], "visibility": "public" @@ -14064,39 +14081,33 @@ { "availability": { "stack": { - "since": "7.13.0", + "since": "6.3.0", "stability": "experimental" } }, - "description": "Retrieve node-level cache statistics about searchable snapshots.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", - "name": "searchable_snapshots.cache_stats", + "description": "Starts an existing, stopped rollup job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", + "name": "rollup.start_job", "request": { "name": "Request", - "namespace": "searchable_snapshots.cache_stats" + "namespace": "rollup.start_job" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "searchable_snapshots.cache_stats" + "namespace": "rollup.start_job" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "6.3.0", "stability": "experimental", "urls": [ { "methods": [ - "GET" - ], - "path": "/_searchable_snapshots/cache/stats" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_searchable_snapshots/{node_id}/cache/stats" + "path": "/_rollup/job/{id}/_start" } ], "visibility": "public" @@ -14104,116 +14115,128 @@ { "availability": { "stack": { - "since": "7.10.0", + "since": "6.3.0", "stability": "experimental" } }, - "description": "Clear the cache of searchable snapshots.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", - "name": "searchable_snapshots.clear_cache", + "description": "Stops an existing, started rollup job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", + "name": "rollup.stop_job", "request": { "name": "Request", - "namespace": "searchable_snapshots.clear_cache" + "namespace": "rollup.stop_job" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "searchable_snapshots.clear_cache" + "namespace": "rollup.stop_job" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", + "since": "6.3.0", "stability": "experimental", "urls": [ { "methods": [ "POST" ], - "path": "/_searchable_snapshots/cache/clear" - }, - { - "methods": [ - "POST" - ], - "path": "/{index}/_searchable_snapshots/cache/clear" + "path": "/_rollup/job/{id}/_stop" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, "stack": { - "since": "7.10.0", - "stability": "stable" + "since": "6.3.0", + "stability": "experimental" } }, - "description": "Mount a snapshot as a searchable index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html", - "name": "searchable_snapshots.mount", + "description": "Allows an arbitrary script to be executed and a result to be returned", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", + "name": "scripts_painless_execute", "request": { "name": "Request", - "namespace": "searchable_snapshots.mount" + "namespace": "_global.scripts_painless_execute" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "searchable_snapshots.mount" + "namespace": "_global.scripts_painless_execute" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", - "stability": "stable", + "since": "6.3.0", + "stability": "experimental", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_snapshot/{repository}/{snapshot}/_mount" + "path": "/_scripts/painless/_execute" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "7.10.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieve shard-level statistics about searchable snapshots.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", - "name": "searchable_snapshots.stats", + "description": "Allows to retrieve a large numbers of results from a single search request.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", + "name": "scroll", "request": { "name": "Request", - "namespace": "searchable_snapshots.stats" + "namespace": "_global.scroll" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "searchable_snapshots.stats" + "namespace": "_global.scroll" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_searchable_snapshots/stats" + "path": "/_search/scroll" }, { + "deprecation": { + "description": "A scroll id can be quite large and should be specified as part of the body", + "version": "7.0.0" + }, "methods": [ - "GET" + "GET", + "POST" ], - "path": "/{index}/_searchable_snapshots/stats" + "path": "/_search/scroll/{scroll_id}" } ], "visibility": "public" @@ -14222,157 +14245,166 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "8.2.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Creates or updates the user profile on behalf of another user.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", - "name": "security.activate_user_profile", + "description": "Returns results matching a query.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", + "name": "search", "privileges": { - "cluster": [ - "manage_user_profile" + "index": [ + "read" ] }, "request": { "name": "Request", - "namespace": "security.activate_user_profile" + "namespace": "_global.search" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "security.activate_user_profile" + "namespace": "_global.search" }, "responseMediaType": [ "application/json" ], - "since": "8.2.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ + "GET", + "POST" + ], + "path": "/_search" + }, + { + "methods": [ + "GET", "POST" ], - "path": "/_security/profile/_activate" + "path": "/{index}/_search" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { "serverless": { - "stability": "stable", + "stability": "beta", "visibility": "public" }, "stack": { - "since": "5.5.0", - "stability": "stable" + "since": "8.8.0", + "stability": "beta" } }, - "description": "Enables authentication as a user and retrieve information about the authenticated user.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", - "name": "security.authenticate", + "description": "Deletes a search application.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", + "name": "search_application.delete", "request": { "name": "Request", - "namespace": "security.authenticate" + "namespace": "search_application.delete" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.authenticate" + "namespace": "search_application.delete" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", - "stability": "stable", + "since": "8.8.0", + "stability": "beta", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_security/_authenticate" + "path": "/_application/search_application/{name}" } ], "visibility": "public" }, { "availability": { - "stack": { - "stability": "stable", + "serverless": { + "stability": "experimental", "visibility": "public" + }, + "stack": { + "since": "8.8.0", + "stability": "experimental" } }, - "description": "Updates the attributes of multiple existing API keys.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html", - "name": "security.bulk_update_api_keys", - "request": null, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], - "response": null, + "description": "Delete a behavioral analytics collection.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", + "name": "search_application.delete_behavioral_analytics", + "request": { + "name": "Request", + "namespace": "search_application.delete_behavioral_analytics" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "search_application.delete_behavioral_analytics" + }, "responseMediaType": [ "application/json" ], - "stability": "stable", + "since": "8.8.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "DELETE" ], - "path": "/_security/api_key/_bulk_update" + "path": "/_application/analytics/{name}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "beta", + "visibility": "public" + }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "8.8.0", + "stability": "beta" } }, - "description": "Changes the passwords of users in the native realm and built-in users.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", - "name": "security.change_password", + "description": "Returns the details about a search application.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", + "name": "search_application.get", "request": { "name": "Request", - "namespace": "security.change_password" + "namespace": "search_application.get" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.change_password" + "namespace": "search_application.get" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "8.8.0", + "stability": "beta", "urls": [ { "methods": [ - "PUT", - "POST" - ], - "path": "/_security/user/{username}/_password" - }, - { - "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_security/user/_password" + "path": "/_application/search_application/{name}" } ], "visibility": "public" @@ -14380,42 +14412,43 @@ { "availability": { "serverless": { - "stability": "stable", - "visibility": "private" + "stability": "experimental", + "visibility": "public" }, "stack": { - "since": "7.10.0", - "stability": "stable" + "since": "8.8.0", + "stability": "experimental" } }, - "description": "Clear a subset or all entries from the API key cache.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", - "name": "security.clear_api_key_cache", - "privileges": { - "cluster": [ - "manage_security" - ] - }, + "description": "Returns the existing behavioral analytics collections.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", + "name": "search_application.get_behavioral_analytics", "request": { "name": "Request", - "namespace": "security.clear_api_key_cache" + "namespace": "search_application.get_behavioral_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.clear_api_key_cache" + "namespace": "search_application.get_behavioral_analytics" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", - "stability": "stable", + "since": "8.8.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_security/api_key/{ids}/_clear_cache" + "path": "/_application/analytics" + }, + { + "methods": [ + "GET" + ], + "path": "/_application/analytics/{name}" } ], "visibility": "public" @@ -14423,75 +14456,67 @@ { "availability": { "serverless": { - "stability": "stable", - "visibility": "private" + "stability": "beta", + "visibility": "public" }, "stack": { - "since": "7.9.0", - "stability": "stable" + "since": "8.8.0", + "stability": "beta" } }, - "description": "Evicts application privileges from the native application privileges cache.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", - "name": "security.clear_cached_privileges", + "description": "Returns the existing search applications.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html", + "name": "search_application.list", "request": { "name": "Request", - "namespace": "security.clear_cached_privileges" + "namespace": "search_application.list" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.clear_cached_privileges" + "namespace": "search_application.list" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", - "stability": "stable", + "since": "8.8.0", + "stability": "beta", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_security/privilege/{application}/_clear_cache" + "path": "/_application/search_application" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "0.0.0", - "stability": "stable" + "stability": "experimental", + "visibility": "public" } }, - "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", - "name": "security.clear_cached_realms", - "request": { - "name": "Request", - "namespace": "security.clear_cached_realms" - }, - "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "security.clear_cached_realms" - }, + "description": "Creates a behavioral analytics event for existing collection.", + "docUrl": "http://todo.com/tbd", + "name": "search_application.post_behavioral_analytics_event", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "stability": "experimental", "urls": [ { "methods": [ "POST" ], - "path": "/_security/realm/{realms}/_clear_cache" + "path": "/_application/analytics/{collection_name}/event/{event_type}" } ], "visibility": "public" @@ -14499,37 +14524,40 @@ { "availability": { "serverless": { - "stability": "stable", - "visibility": "private" + "stability": "beta", + "visibility": "public" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "8.8.0", + "stability": "beta" } }, - "description": "Evicts roles from the native role cache.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", - "name": "security.clear_cached_roles", + "description": "Creates or updates a search application.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", + "name": "search_application.put", "request": { "name": "Request", - "namespace": "security.clear_cached_roles" + "namespace": "search_application.put" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "security.clear_cached_roles" + "namespace": "search_application.put" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "8.8.0", + "stability": "beta", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_security/role/{name}/_clear_cache" + "path": "/_application/search_application/{name}" } ], "visibility": "public" @@ -14537,114 +14565,109 @@ { "availability": { "serverless": { - "stability": "stable", - "visibility": "private" + "stability": "experimental", + "visibility": "public" }, "stack": { - "since": "0.0.0", - "stability": "stable" + "since": "8.8.0", + "stability": "experimental" } }, - "description": "Evicts tokens from the service account token caches.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", - "name": "security.clear_cached_service_tokens", + "description": "Creates a behavioral analytics collection.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", + "name": "search_application.put_behavioral_analytics", "request": { "name": "Request", - "namespace": "security.clear_cached_service_tokens" + "namespace": "search_application.put_behavioral_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.clear_cached_service_tokens" + "namespace": "search_application.put_behavioral_analytics" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", - "stability": "stable", + "since": "8.8.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache" + "path": "/_application/analytics/{name}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "6.7.0", - "stability": "stable" + "stability": "experimental", + "visibility": "public" } }, - "description": "Creates an API key for access without requiring basic authentication.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", - "name": "security.create_api_key", - "privileges": { - "cluster": [ - "manage_own_api_key" - ] - }, - "request": { - "name": "Request", - "namespace": "security.create_api_key" - }, - "requestBodyRequired": true, + "description": "Renders a query for given search application search parameters", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-render-query.html", + "name": "search_application.render_query", + "request": null, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.create_api_key" - }, + "response": null, "responseMediaType": [ "application/json" ], - "since": "6.7.0", - "stability": "stable", + "stability": "experimental", "urls": [ { "methods": [ - "PUT", "POST" ], - "path": "/_security/api_key" + "path": "/_application/search_application/{name}/_render_query" } ], "visibility": "public" }, { "availability": { - "stack": { + "serverless": { "stability": "beta", "visibility": "public" + }, + "stack": { + "since": "8.8.0", + "stability": "beta" } }, - "description": "Creates a cross-cluster API key for API key based remote cluster access.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", - "name": "security.create_cross_cluster_api_key", - "request": null, - "requestBodyRequired": true, + "description": "Perform a search against a search application", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", + "name": "search_application.search", + "request": { + "name": "Request", + "namespace": "search_application.search" + }, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], - "response": null, + "response": { + "name": "Response", + "namespace": "search_application.search" + }, "responseMediaType": [ "application/json" ], + "since": "8.8.0", "stability": "beta", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_security/cross_cluster/api_key" + "path": "/_application/search_application/{name}/_search" } ], "visibility": "public" @@ -14653,81 +14676,82 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.15.0", "stability": "stable" } }, - "description": "Creates a service account token for access without requiring basic authentication.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", - "name": "security.create_service_token", + "description": "Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", + "name": "search_mvt", "request": { "name": "Request", - "namespace": "security.create_service_token" + "namespace": "_global.search_mvt" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "security.create_service_token" + "namespace": "_global.search_mvt" }, "responseMediaType": [ - "application/json" + "application/vnd.mapbox-vector-tile" ], - "since": "0.0.0", + "since": "7.15.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" - ], - "path": "/_security/service/{namespace}/{service}/credential/token/{name}" - }, - { - "methods": [ - "POST" + "POST", + "GET" ], - "path": "/_security/service/{namespace}/{service}/credential/token" + "path": "/{index}/_mvt/{field}/{zoom}/{x}/{y}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "6.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Removes application privileges.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", - "name": "security.delete_privileges", + "description": "Returns information about the indices and shards that a search request would be executed against.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", + "name": "search_shards", "request": { "name": "Request", - "namespace": "security.delete_privileges" + "namespace": "_global.search_shards" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.delete_privileges" + "namespace": "_global.search_shards" }, "responseMediaType": [ "application/json" ], - "since": "6.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET", + "POST" ], - "path": "/_security/privilege/{application}/{name}" + "path": "/_search_shards" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_search_shards" } ], "visibility": "public" @@ -14736,112 +14760,127 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "2.0.0", "stability": "stable" } }, - "description": "Removes roles in the native realm.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", - "name": "security.delete_role", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "name": "search_template", "request": { "name": "Request", - "namespace": "security.delete_role" + "namespace": "_global.search_template" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "security.delete_role" + "namespace": "_global.search_template" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "2.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET", + "POST" ], - "path": "/_security/role/{name}" + "path": "/_search/template" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_search/template" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "5.5.0", - "stability": "stable" + "since": "7.13.0", + "stability": "experimental" } }, - "description": "Removes role mappings.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", - "name": "security.delete_role_mapping", + "description": "Retrieve node-level cache statistics about searchable snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", + "name": "searchable_snapshots.cache_stats", "request": { "name": "Request", - "namespace": "security.delete_role_mapping" + "namespace": "searchable_snapshots.cache_stats" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.delete_role_mapping" + "namespace": "searchable_snapshots.cache_stats" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", - "stability": "stable", + "since": "7.13.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_security/role_mapping/{name}" + "path": "/_searchable_snapshots/cache/stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_searchable_snapshots/{node_id}/cache/stats" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "5.5.0", - "stability": "stable" + "since": "7.10.0", + "stability": "experimental" } }, - "description": "Deletes a service account token.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", - "name": "security.delete_service_token", + "description": "Clear the cache of searchable snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", + "name": "searchable_snapshots.clear_cache", "request": { "name": "Request", - "namespace": "security.delete_service_token" + "namespace": "searchable_snapshots.clear_cache" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.delete_service_token" + "namespace": "searchable_snapshots.clear_cache" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", - "stability": "stable", + "since": "7.10.0", + "stability": "experimental", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_security/service/{namespace}/{service}/credential/token/{name}" + "path": "/_searchable_snapshots/cache/clear" + }, + { + "methods": [ + "POST" + ], + "path": "/{index}/_searchable_snapshots/cache/clear" } ], "visibility": "public" @@ -14849,33 +14888,36 @@ { "availability": { "stack": { - "since": "0.0.0", + "since": "7.10.0", "stability": "stable" } }, - "description": "Deletes users from the native realm.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", - "name": "security.delete_user", + "description": "Mount a snapshot as a searchable index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html", + "name": "searchable_snapshots.mount", "request": { "name": "Request", - "namespace": "security.delete_user" + "namespace": "searchable_snapshots.mount" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "security.delete_user" + "namespace": "searchable_snapshots.mount" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.10.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_security/user/{username}" + "path": "/_snapshot/{repository}/{snapshot}/_mount" } ], "visibility": "public" @@ -14883,34 +14925,39 @@ { "availability": { "stack": { - "since": "0.0.0", + "since": "7.10.0", "stability": "stable" } }, - "description": "Disables users in the native realm.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", - "name": "security.disable_user", + "description": "Retrieve shard-level statistics about searchable snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", + "name": "searchable_snapshots.stats", "request": { "name": "Request", - "namespace": "security.disable_user" + "namespace": "searchable_snapshots.stats" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.disable_user" + "namespace": "searchable_snapshots.stats" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.10.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_security/user/{username}/_disable" + "path": "/_searchable_snapshots/stats" + }, + { + "methods": [ + "GET" + ], + "path": "/{index}/_searchable_snapshots/stats" } ], "visibility": "public" @@ -14926,9 +14973,9 @@ "stability": "stable" } }, - "description": "Disables a user profile so it's not visible in user profile searches.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", - "name": "security.disable_user_profile", + "description": "Creates or updates the user profile on behalf of another user.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", + "name": "security.activate_user_profile", "privileges": { "cluster": [ "manage_user_profile" @@ -14936,12 +14983,15 @@ }, "request": { "name": "Request", - "namespace": "security.disable_user_profile" + "namespace": "security.activate_user_profile" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "security.disable_user_profile" + "namespace": "security.activate_user_profile" }, "responseMediaType": [ "application/json" @@ -14951,163 +15001,165 @@ "urls": [ { "methods": [ - "PUT", "POST" ], - "path": "/_security/profile/{uid}/_disable" + "path": "/_security/profile/_activate" } ], "visibility": "private" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Enables users in the native realm.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", - "name": "security.enable_user", + "description": "Enables authentication as a user and retrieve information about the authenticated user.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", + "name": "security.authenticate", "request": { "name": "Request", - "namespace": "security.enable_user" + "namespace": "security.authenticate" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.enable_user" + "namespace": "security.authenticate" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_security/user/{username}/_enable" + "path": "/_security/_authenticate" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "8.2.0", - "stability": "stable" + "stability": "stable", + "visibility": "public" } }, - "description": "Enables a user profile so it's visible in user profile searches.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", - "name": "security.enable_user_profile", - "privileges": { - "cluster": [ - "manage_user_profile" - ] - }, - "request": { - "name": "Request", - "namespace": "security.enable_user_profile" - }, - "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "security.enable_user_profile" - }, + "description": "Updates the attributes of multiple existing API keys.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html", + "name": "security.bulk_update_api_keys", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, "responseMediaType": [ "application/json" ], - "since": "8.2.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", "POST" ], - "path": "/_security/profile/{uid}/_enable" + "path": "/_security/api_key/_bulk_update" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { "stack": { - "since": "8.0.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", - "name": "security.enroll_kibana", + "description": "Changes the passwords of users in the native realm and built-in users.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", + "name": "security.change_password", "request": { "name": "Request", - "namespace": "security.enroll_kibana" + "namespace": "security.change_password" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "security.enroll_kibana" + "namespace": "security.change_password" }, "responseMediaType": [ "application/json" ], - "since": "8.0.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "PUT", + "POST" ], - "path": "/_security/enroll/kibana" + "path": "/_security/user/{username}/_password" + }, + { + "methods": [ + "PUT", + "POST" + ], + "path": "/_security/user/_password" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "8.0.0", + "since": "7.10.0", "stability": "stable" } }, - "description": "Allows a new node to enroll to an existing cluster with security enabled.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", - "name": "security.enroll_node", + "description": "Clear a subset or all entries from the API key cache.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", + "name": "security.clear_api_key_cache", + "privileges": { + "cluster": [ + "manage_security" + ] + }, "request": { "name": "Request", - "namespace": "security.enroll_node" + "namespace": "security.clear_api_key_cache" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "security.enroll_node" + "namespace": "security.clear_api_key_cache" }, "responseMediaType": [ "application/json" ], - "since": "8.0.0", + "since": "7.10.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_security/enroll/node" + "path": "/_security/api_key/{ids}/_clear_cache" } ], "visibility": "public" @@ -15116,42 +15168,36 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "6.7.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Retrieves information for one or more API keys.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", - "name": "security.get_api_key", - "privileges": { - "cluster": [ - "manage_own_api_key", - "read_security" - ] - }, + "description": "Evicts application privileges from the native application privileges cache.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", + "name": "security.clear_cached_privileges", "request": { "name": "Request", - "namespace": "security.get_api_key" + "namespace": "security.clear_cached_privileges" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_api_key" + "namespace": "security.clear_cached_privileges" }, "responseMediaType": [ "application/json" ], - "since": "6.7.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_security/api_key" + "path": "/_security/privilege/{application}/_clear_cache" } ], "visibility": "public" @@ -15163,38 +15209,33 @@ "visibility": "private" }, "stack": { - "since": "7.3.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", - "name": "security.get_builtin_privileges", - "privileges": { - "cluster": [ - "manage_security" - ] - }, + "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", + "name": "security.clear_cached_realms", "request": { "name": "Request", - "namespace": "security.get_builtin_privileges" + "namespace": "security.clear_cached_realms" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_builtin_privileges" + "namespace": "security.clear_cached_realms" }, "responseMediaType": [ "application/json" ], - "since": "7.3.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_security/privilege/_builtin" + "path": "/_security/realm/{realms}/_clear_cache" } ], "visibility": "public" @@ -15206,45 +15247,33 @@ "visibility": "private" }, "stack": { - "since": "6.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves application privileges.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", - "name": "security.get_privileges", + "description": "Evicts roles from the native role cache.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", + "name": "security.clear_cached_roles", "request": { "name": "Request", - "namespace": "security.get_privileges" + "namespace": "security.clear_cached_roles" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_privileges" + "namespace": "security.clear_cached_roles" }, "responseMediaType": [ "application/json" ], - "since": "6.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_security/privilege" - }, - { - "methods": [ - "GET" - ], - "path": "/_security/privilege/{application}" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_security/privilege/{application}/{name}" + "path": "/_security/role/{name}/_clear_cache" } ], "visibility": "public" @@ -15260,22 +15289,17 @@ "stability": "stable" } }, - "description": "Retrieves roles in the native realm.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", - "name": "security.get_role", - "privileges": { - "cluster": [ - "manage_security" - ] - }, + "description": "Evicts tokens from the service account token caches.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", + "name": "security.clear_cached_service_tokens", "request": { "name": "Request", - "namespace": "security.get_role" + "namespace": "security.clear_cached_service_tokens" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_role" + "namespace": "security.clear_cached_service_tokens" }, "responseMediaType": [ "application/json" @@ -15285,15 +15309,9 @@ "urls": [ { "methods": [ - "GET" - ], - "path": "/_security/role/{name}" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_security/role" + "path": "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache" } ], "visibility": "public" @@ -15302,47 +15320,75 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "5.5.0", + "since": "6.7.0", "stability": "stable" } }, - "description": "Retrieves role mappings.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", - "name": "security.get_role_mapping", + "description": "Creates an API key for access without requiring basic authentication.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", + "name": "security.create_api_key", "privileges": { "cluster": [ - "manage_security" + "manage_own_api_key" ] }, "request": { "name": "Request", - "namespace": "security.get_role_mapping" + "namespace": "security.create_api_key" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "security.get_role_mapping" + "namespace": "security.create_api_key" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "6.7.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "PUT", + "POST" ], - "path": "/_security/role_mapping/{name}" - }, + "path": "/_security/api_key" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "beta", + "visibility": "public" + } + }, + "description": "Creates a cross-cluster API key for API key based remote cluster access.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", + "name": "security.create_cross_cluster_api_key", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "beta", + "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_security/role_mapping" + "path": "/_security/cross_cluster/api_key" } ], "visibility": "public" @@ -15354,50 +15400,40 @@ "visibility": "private" }, "stack": { - "since": "7.13.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves information about service accounts.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", - "name": "security.get_service_accounts", - "privileges": { - "cluster": [ - "manage_service_account" - ] - }, + "description": "Creates a service account token for access without requiring basic authentication.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", + "name": "security.create_service_token", "request": { "name": "Request", - "namespace": "security.get_service_accounts" + "namespace": "security.create_service_token" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_service_accounts" + "namespace": "security.create_service_token" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_security/service/{namespace}/{service}" - }, - { - "methods": [ - "GET" + "PUT", + "POST" ], - "path": "/_security/service/{namespace}" + "path": "/_security/service/{namespace}/{service}/credential/token/{name}" }, { "methods": [ - "GET" + "POST" ], - "path": "/_security/service" + "path": "/_security/service/{namespace}/{service}/credential/token" } ], "visibility": "public" @@ -15409,63 +15445,71 @@ "visibility": "private" }, "stack": { - "since": "7.13.0", + "since": "6.4.0", "stability": "stable" } }, - "description": "Retrieves information of all service credentials for a service account.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", - "name": "security.get_service_credentials", + "description": "Removes application privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", + "name": "security.delete_privileges", "request": { "name": "Request", - "namespace": "security.get_service_credentials" + "namespace": "security.delete_privileges" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_service_credentials" + "namespace": "security.delete_privileges" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "6.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_security/service/{namespace}/{service}/credential" + "path": "/_security/privilege/{application}/{name}" } ], "visibility": "public" }, { "availability": { - "stack": { + "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" + }, + "stack": { + "since": "0.0.0", + "stability": "stable" } }, - "description": "Retrieve settings for the security system indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html", - "name": "security.get_settings", - "request": null, + "description": "Removes roles in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", + "name": "security.delete_role", + "request": { + "name": "Request", + "namespace": "security.delete_role" + }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], - "response": null, + "response": { + "name": "Response", + "namespace": "security.delete_role" + }, "responseMediaType": [ "application/json" ], + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_security/settings" + "path": "/_security/role/{name}" } ], "visibility": "public" @@ -15481,20 +15525,17 @@ "stability": "stable" } }, - "description": "Creates a bearer token for access without requiring basic authentication.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", - "name": "security.get_token", + "description": "Removes role mappings.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", + "name": "security.delete_role_mapping", "request": { "name": "Request", - "namespace": "security.get_token" + "namespace": "security.delete_role_mapping" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_token" + "namespace": "security.delete_role_mapping" }, "responseMediaType": [ "application/json" @@ -15504,133 +15545,119 @@ "urls": [ { "methods": [ - "POST" + "DELETE" ], - "path": "/_security/oauth2/token" + "path": "/_security/role_mapping/{name}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "0.0.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Retrieves information about users in the native realm and built-in users.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", - "name": "security.get_user", + "description": "Deletes a service account token.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", + "name": "security.delete_service_token", "request": { "name": "Request", - "namespace": "security.get_user" + "namespace": "security.delete_service_token" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_user" + "namespace": "security.delete_service_token" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_security/user/{username}" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_security/user" + "path": "/_security/service/{namespace}/{service}/credential/token/{name}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "6.5.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves security privileges for the logged in user.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", - "name": "security.get_user_privileges", + "description": "Deletes users from the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", + "name": "security.delete_user", "request": { "name": "Request", - "namespace": "security.get_user_privileges" + "namespace": "security.delete_user" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_user_privileges" + "namespace": "security.delete_user" }, "responseMediaType": [ "application/json" ], - "since": "6.5.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_security/user/_privileges" + "path": "/_security/user/{username}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "8.2.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves user profiles for the given unique ID(s).", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html", - "name": "security.get_user_profile", - "privileges": { - "cluster": [ - "manage_user_profile" - ] - }, + "description": "Disables users in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", + "name": "security.disable_user", "request": { "name": "Request", - "namespace": "security.get_user_profile" + "namespace": "security.disable_user" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.get_user_profile" + "namespace": "security.disable_user" }, "responseMediaType": [ "application/json" ], - "since": "8.2.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "PUT", + "POST" ], - "path": "/_security/profile/{uid}" + "path": "/_security/user/{username}/_disable" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { @@ -15639,90 +15666,74 @@ "visibility": "private" }, "stack": { - "since": "7.9.0", + "since": "8.2.0", "stability": "stable" } }, - "description": "Creates an API key on behalf of another user.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", - "name": "security.grant_api_key", + "description": "Disables a user profile so it's not visible in user profile searches.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", + "name": "security.disable_user_profile", "privileges": { "cluster": [ - "grant_api_key" + "manage_user_profile" ] }, "request": { "name": "Request", - "namespace": "security.grant_api_key" + "namespace": "security.disable_user_profile" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.grant_api_key" + "namespace": "security.disable_user_profile" }, "responseMediaType": [ "application/json" ], - "since": "7.9.0", + "since": "8.2.0", "stability": "stable", "urls": [ { "methods": [ + "PUT", "POST" ], - "path": "/_security/api_key/grant" + "path": "/_security/profile/{uid}/_disable" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "6.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Determines whether the specified user has a specified list of privileges.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", - "name": "security.has_privileges", + "description": "Enables users in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", + "name": "security.enable_user", "request": { "name": "Request", - "namespace": "security.has_privileges" + "namespace": "security.enable_user" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.has_privileges" + "namespace": "security.enable_user" }, "responseMediaType": [ "application/json" ], - "since": "6.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_security/user/_has_privileges" - }, - { - "methods": [ - "GET", + "PUT", "POST" ], - "path": "/_security/user/{user}/_has_privileges" + "path": "/_security/user/{username}/_enable" } ], "visibility": "public" @@ -15734,13 +15745,13 @@ "visibility": "private" }, "stack": { - "since": "8.3.0", + "since": "8.2.0", "stability": "stable" } }, - "description": "Determines whether the users associated with the specified profile IDs have all the requested privileges.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html", - "name": "security.has_privileges_user_profile", + "description": "Enables a user profile so it's visible in user profile searches.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", + "name": "security.enable_user_profile", "privileges": { "cluster": [ "manage_user_profile" @@ -15748,206 +15759,236 @@ }, "request": { "name": "Request", - "namespace": "security.has_privileges_user_profile" + "namespace": "security.enable_user_profile" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.has_privileges_user_profile" + "namespace": "security.enable_user_profile" }, "responseMediaType": [ "application/json" ], - "since": "8.3.0", + "since": "8.2.0", "stability": "stable", "urls": [ { "methods": [ - "GET", + "PUT", "POST" ], - "path": "/_security/profile/_has_privileges" + "path": "/_security/profile/{uid}/_enable" } ], "visibility": "private" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, "stack": { - "since": "6.7.0", + "since": "8.0.0", "stability": "stable" } }, - "description": "Invalidates one or more API keys.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", - "name": "security.invalidate_api_key", - "privileges": { - "cluster": [ - "manage_api_key", - "manage_own_api_key" - ] - }, + "description": "Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", + "name": "security.enroll_kibana", "request": { "name": "Request", - "namespace": "security.invalidate_api_key" + "namespace": "security.enroll_kibana" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "security.invalidate_api_key" + "namespace": "security.enroll_kibana" }, "responseMediaType": [ "application/json" ], - "since": "6.7.0", + "since": "8.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_security/api_key" + "path": "/_security/enroll/kibana" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "5.5.0", + "since": "8.0.0", "stability": "stable" } }, - "description": "Invalidates one or more access tokens or refresh tokens.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", - "name": "security.invalidate_token", + "description": "Allows a new node to enroll to an existing cluster with security enabled.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", + "name": "security.enroll_node", "request": { "name": "Request", - "namespace": "security.invalidate_token" + "namespace": "security.enroll_node" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "security.invalidate_token" + "namespace": "security.enroll_node" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "8.0.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_security/oauth2/token" + "path": "/_security/enroll/node" } ], "visibility": "public" }, { "availability": { - "stack": { + "serverless": { "stability": "stable", "visibility": "public" + }, + "stack": { + "since": "6.7.0", + "stability": "stable" } }, - "description": "Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html", - "name": "security.oidc_authenticate", - "request": null, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], - "response": null, + "description": "Retrieves information for one or more API keys.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", + "name": "security.get_api_key", + "privileges": { + "cluster": [ + "manage_own_api_key", + "read_security" + ] + }, + "request": { + "name": "Request", + "namespace": "security.get_api_key" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "security.get_api_key" + }, "responseMediaType": [ "application/json" ], + "since": "6.7.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_security/oidc/authenticate" + "path": "/_security/api_key" } ], "visibility": "public" }, { "availability": { - "stack": { + "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" + }, + "stack": { + "since": "7.3.0", + "stability": "stable" } }, - "description": "Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html", - "name": "security.oidc_logout", - "request": null, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], - "response": null, + "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", + "name": "security.get_builtin_privileges", + "privileges": { + "cluster": [ + "manage_security" + ] + }, + "request": { + "name": "Request", + "namespace": "security.get_builtin_privileges" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "security.get_builtin_privileges" + }, "responseMediaType": [ "application/json" ], + "since": "7.3.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_security/oidc/logout" + "path": "/_security/privilege/_builtin" } ], "visibility": "public" }, { "availability": { - "stack": { + "serverless": { "stability": "stable", - "visibility": "public" - } - }, - "description": "Creates an OAuth 2.0 authentication request as a URL string", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html", - "name": "security.oidc_prepare_authentication", - "request": null, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], - "response": null, + "visibility": "private" + }, + "stack": { + "since": "6.4.0", + "stability": "stable" + } + }, + "description": "Retrieves application privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", + "name": "security.get_privileges", + "request": { + "name": "Request", + "namespace": "security.get_privileges" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "security.get_privileges" + }, "responseMediaType": [ "application/json" ], + "since": "6.4.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_security/oidc/prepare" + "path": "/_security/privilege" + }, + { + "methods": [ + "GET" + ], + "path": "/_security/privilege/{application}" + }, + { + "methods": [ + "GET" + ], + "path": "/_security/privilege/{application}/{name}" } ], "visibility": "public" @@ -15959,37 +16000,44 @@ "visibility": "private" }, "stack": { - "since": "6.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Adds or updates application privileges.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", - "name": "security.put_privileges", + "description": "Retrieves roles in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", + "name": "security.get_role", + "privileges": { + "cluster": [ + "manage_security" + ] + }, "request": { "name": "Request", - "namespace": "security.put_privileges" + "namespace": "security.get_role" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.put_privileges" + "namespace": "security.get_role" }, "responseMediaType": [ "application/json" ], - "since": "6.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_security/privilege" + "path": "/_security/role/{name}" + }, + { + "methods": [ + "GET" + ], + "path": "/_security/role" } ], "visibility": "public" @@ -16001,13 +16049,13 @@ "visibility": "private" }, "stack": { - "since": "0.0.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Adds and updates roles in the native realm.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", - "name": "security.put_role", + "description": "Retrieves role mappings.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", + "name": "security.get_role_mapping", "privileges": { "cluster": [ "manage_security" @@ -16015,28 +16063,30 @@ }, "request": { "name": "Request", - "namespace": "security.put_role" + "namespace": "security.get_role_mapping" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.put_role" + "namespace": "security.get_role_mapping" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_security/role/{name}" + "path": "/_security/role_mapping/{name}" + }, + { + "methods": [ + "GET" + ], + "path": "/_security/role_mapping" } ], "visibility": "public" @@ -16048,123 +16098,118 @@ "visibility": "private" }, "stack": { - "since": "5.5.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Creates and updates role mappings.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", - "name": "security.put_role_mapping", + "description": "Retrieves information about service accounts.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", + "name": "security.get_service_accounts", + "privileges": { + "cluster": [ + "manage_service_account" + ] + }, "request": { "name": "Request", - "namespace": "security.put_role_mapping" + "namespace": "security.get_service_accounts" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.put_role_mapping" + "namespace": "security.get_service_accounts" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_security/role_mapping/{name}" + "path": "/_security/service/{namespace}/{service}" + }, + { + "methods": [ + "GET" + ], + "path": "/_security/service/{namespace}" + }, + { + "methods": [ + "GET" + ], + "path": "/_security/service" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "0.0.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Adds and updates users in the native realm. These users are commonly referred to as native users.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", - "name": "security.put_user", + "description": "Retrieves information of all service credentials for a service account.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", + "name": "security.get_service_credentials", "request": { "name": "Request", - "namespace": "security.put_user" + "namespace": "security.get_service_credentials" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.put_user" + "namespace": "security.get_service_credentials" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_security/user/{username}" + "path": "/_security/service/{namespace}/{service}/credential" } ], "visibility": "public" }, { "availability": { - "serverless": { + "stack": { "stability": "stable", "visibility": "public" - }, - "stack": { - "since": "7.15.0", - "stability": "stable" } }, - "description": "Retrieves information for API keys using a subset of query DSL", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", - "name": "security.query_api_keys", - "privileges": { - "cluster": [ - "manage_own_api_key", - "read_security" - ] - }, - "request": { - "name": "Request", - "namespace": "security.query_api_keys" - }, + "description": "Retrieve settings for the security system indices", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html", + "name": "security.get_settings", + "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.query_api_keys" - }, + "response": null, "responseMediaType": [ "application/json" ], - "since": "7.15.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_security/_query/api_key" + "path": "/_security/settings" } ], "visibility": "public" @@ -16176,16 +16221,16 @@ "visibility": "private" }, "stack": { - "since": "7.5.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", - "name": "security.saml_authenticate", + "description": "Creates a bearer token for access without requiring basic authentication.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", + "name": "security.get_token", "request": { "name": "Request", - "namespace": "security.saml_authenticate" + "namespace": "security.get_token" }, "requestBodyRequired": true, "requestMediaType": [ @@ -16193,60 +16238,59 @@ ], "response": { "name": "Response", - "namespace": "security.saml_authenticate" + "namespace": "security.get_token" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_security/saml/authenticate" + "path": "/_security/oauth2/token" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "7.14.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Verifies the logout response sent from the SAML IdP", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", - "name": "security.saml_complete_logout", + "description": "Retrieves information about users in the native realm and built-in users.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", + "name": "security.get_user", "request": { "name": "Request", - "namespace": "security.saml_complete_logout" + "namespace": "security.get_user" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.saml_complete_logout" + "namespace": "security.get_user" }, "responseMediaType": [ "application/json" ], - "since": "7.14.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_security/saml/complete_logout" + "path": "/_security/user/{username}" + }, + { + "methods": [ + "GET" + ], + "path": "/_security/user" } ], "visibility": "public" @@ -16258,36 +16302,33 @@ "visibility": "private" }, "stack": { - "since": "7.5.0", + "since": "6.5.0", "stability": "stable" } }, - "description": "Consumes a SAML LogoutRequest", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", - "name": "security.saml_invalidate", + "description": "Retrieves security privileges for the logged in user.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", + "name": "security.get_user_privileges", "request": { "name": "Request", - "namespace": "security.saml_invalidate" + "namespace": "security.get_user_privileges" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.saml_invalidate" + "namespace": "security.get_user_privileges" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "6.5.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_security/saml/invalidate" + "path": "/_security/user/_privileges" } ], "visibility": "public" @@ -16299,39 +16340,41 @@ "visibility": "private" }, "stack": { - "since": "7.5.0", + "since": "8.2.0", "stability": "stable" } }, - "description": "Invalidates an access token and a refresh token that were generated via the SAML Authenticate API", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", - "name": "security.saml_logout", + "description": "Retrieves user profiles for the given unique ID(s).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html", + "name": "security.get_user_profile", + "privileges": { + "cluster": [ + "manage_user_profile" + ] + }, "request": { "name": "Request", - "namespace": "security.saml_logout" + "namespace": "security.get_user_profile" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "security.saml_logout" + "namespace": "security.get_user_profile" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "8.2.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_security/saml/logout" + "path": "/_security/profile/{uid}" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { @@ -16340,16 +16383,21 @@ "visibility": "private" }, "stack": { - "since": "7.5.0", + "since": "7.9.0", "stability": "stable" } }, - "description": "Creates a SAML authentication request", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", - "name": "security.saml_prepare_authentication", + "description": "Creates an API key on behalf of another user.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", + "name": "security.grant_api_key", + "privileges": { + "cluster": [ + "grant_api_key" + ] + }, "request": { "name": "Request", - "namespace": "security.saml_prepare_authentication" + "namespace": "security.grant_api_key" }, "requestBodyRequired": true, "requestMediaType": [ @@ -16357,19 +16405,19 @@ ], "response": { "name": "Response", - "namespace": "security.saml_prepare_authentication" + "namespace": "security.grant_api_key" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "7.9.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_security/saml/prepare" + "path": "/_security/api_key/grant" } ], "visibility": "public" @@ -16378,39 +16426,47 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "7.11.0", + "since": "6.4.0", "stability": "stable" } }, - "description": "Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", - "name": "security.saml_service_provider_metadata", + "description": "Determines whether the specified user has a specified list of privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", + "name": "security.has_privileges", "request": { "name": "Request", - "namespace": "security.saml_service_provider_metadata" + "namespace": "security.has_privileges" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "security.saml_service_provider_metadata" + "namespace": "security.has_privileges" }, "responseMediaType": [ "application/json" ], - "since": "7.11.0", + "since": "6.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/_security/saml/metadata/{realm_name}" + "path": "/_security/user/_has_privileges" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/_security/user/{user}/_has_privileges" } ], "visibility": "public" @@ -16422,29 +16478,34 @@ "visibility": "private" }, "stack": { - "since": "8.2.0", + "since": "8.3.0", "stability": "stable" } }, - "description": "Get suggestions for user profiles that match specified search criteria.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html", - "name": "security.suggest_user_profiles", + "description": "Determines whether the users associated with the specified profile IDs have all the requested privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html", + "name": "security.has_privileges_user_profile", + "privileges": { + "cluster": [ + "manage_user_profile" + ] + }, "request": { "name": "Request", - "namespace": "security.suggest_user_profiles" + "namespace": "security.has_privileges_user_profile" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "security.suggest_user_profiles" + "namespace": "security.has_privileges_user_profile" }, "responseMediaType": [ "application/json" ], - "since": "8.2.0", + "since": "8.3.0", "stability": "stable", "urls": [ { @@ -16452,7 +16513,7 @@ "GET", "POST" ], - "path": "/_security/profile/_suggest" + "path": "/_security/profile/_has_privileges" } ], "visibility": "private" @@ -16464,71 +16525,83 @@ "visibility": "public" }, "stack": { - "since": "8.4.0", + "since": "6.7.0", "stability": "stable" } }, - "description": "Updates attributes of an existing API key.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", - "name": "security.update_api_key", + "description": "Invalidates one or more API keys.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", + "name": "security.invalidate_api_key", "privileges": { "cluster": [ + "manage_api_key", "manage_own_api_key" ] }, "request": { "name": "Request", - "namespace": "security.update_api_key" + "namespace": "security.invalidate_api_key" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "security.update_api_key" + "namespace": "security.invalidate_api_key" }, "responseMediaType": [ "application/json" ], - "since": "8.4.0", + "since": "6.7.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "DELETE" ], - "path": "/_security/api_key/{id}" + "path": "/_security/api_key" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "stability": "beta", - "visibility": "public" + "since": "5.5.0", + "stability": "stable" } }, - "description": "Updates attributes of an existing cross-cluster API key.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", - "name": "security.update_cross_cluster_api_key", - "request": null, + "description": "Invalidates one or more access tokens or refresh tokens.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", + "name": "security.invalidate_token", + "request": { + "name": "Request", + "namespace": "security.invalidate_token" + }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": null, + "response": { + "name": "Response", + "namespace": "security.invalidate_token" + }, "responseMediaType": [ "application/json" ], - "stability": "beta", + "since": "5.5.0", + "stability": "stable", "urls": [ { "methods": [ - "PUT" + "DELETE" ], - "path": "/_security/cross_cluster/api_key/{id}" + "path": "/_security/oauth2/token" } ], "visibility": "public" @@ -16540,9 +16613,9 @@ "visibility": "public" } }, - "description": "Update settings for the security system index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html", - "name": "security.update_settings", + "description": "Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html", + "name": "security.oidc_authenticate", "request": null, "requestBodyRequired": true, "requestMediaType": [ @@ -16556,153 +16629,137 @@ "urls": [ { "methods": [ - "PUT" + "POST" ], - "path": "/_security/settings" + "path": "/_security/oidc/authenticate" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "8.2.0", - "stability": "stable" + "stability": "stable", + "visibility": "public" } }, - "description": "Update application specific data for the user profile of the given unique ID.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html", - "name": "security.update_user_profile_data", - "privileges": { - "cluster": [ - "manage_user_profile" - ] - }, - "request": { - "name": "Request", - "namespace": "security.update_user_profile_data" - }, + "description": "Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html", + "name": "security.oidc_logout", + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.update_user_profile_data" - }, + "response": null, "responseMediaType": [ "application/json" ], - "since": "8.2.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", "POST" ], - "path": "/_security/profile/{uid}/_data" + "path": "/_security/oidc/logout" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { "stack": { - "since": "7.13.0", - "stability": "stable" + "stability": "stable", + "visibility": "public" } }, - "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "name": "shutdown.delete_node", - "request": { - "name": "Request", - "namespace": "shutdown.delete_node" - }, - "requestBodyRequired": false, + "description": "Creates an OAuth 2.0 authentication request as a URL string", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html", + "name": "security.oidc_prepare_authentication", + "request": null, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "shutdown.delete_node" - }, + "response": null, "responseMediaType": [ "application/json" ], - "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_nodes/{node_id}/shutdown" + "path": "/_security/oidc/prepare" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "7.13.0", + "since": "6.4.0", "stability": "stable" } }, - "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "name": "shutdown.get_node", + "description": "Adds or updates application privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", + "name": "security.put_privileges", "request": { "name": "Request", - "namespace": "shutdown.get_node" + "namespace": "security.put_privileges" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "shutdown.get_node" + "namespace": "security.put_privileges" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "6.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_nodes/shutdown" - }, - { - "methods": [ - "GET" + "PUT", + "POST" ], - "path": "/_nodes/{node_id}/shutdown" + "path": "/_security/privilege" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "7.13.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "name": "shutdown.put_node", + "description": "Adds and updates roles in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", + "name": "security.put_role", + "privileges": { + "cluster": [ + "manage_security" + ] + }, "request": { "name": "Request", - "namespace": "shutdown.put_node" + "namespace": "security.put_role" }, "requestBodyRequired": true, "requestMediaType": [ @@ -16710,22 +16767,23 @@ ], "response": { "name": "Response", - "namespace": "shutdown.put_node" + "namespace": "security.put_role" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "PUT", + "POST" ], - "path": "/_nodes/{node_id}/shutdown" + "path": "/_security/role/{name}" } ], - "visibility": "private" + "visibility": "public" }, { "availability": { @@ -16734,71 +16792,75 @@ "visibility": "private" }, "stack": { - "since": "7.4.0", + "since": "5.5.0", "stability": "stable" } }, - "description": "Deletes an existing snapshot lifecycle policy.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", - "name": "slm.delete_lifecycle", + "description": "Creates and updates role mappings.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", + "name": "security.put_role_mapping", "request": { "name": "Request", - "namespace": "slm.delete_lifecycle" + "namespace": "security.put_role_mapping" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "slm.delete_lifecycle" + "namespace": "security.put_role_mapping" }, "responseMediaType": [ "application/json" ], - "since": "7.4.0", + "since": "5.5.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "PUT", + "POST" ], - "path": "/_slm/policy/{policy_id}" + "path": "/_security/role_mapping/{name}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "7.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", - "name": "slm.execute_lifecycle", + "description": "Adds and updates users in the native realm. These users are commonly referred to as native users.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", + "name": "security.put_user", "request": { "name": "Request", - "namespace": "slm.execute_lifecycle" + "namespace": "security.put_user" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "slm.execute_lifecycle" + "namespace": "security.put_user" }, "responseMediaType": [ "application/json" ], - "since": "7.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "PUT", + "POST" ], - "path": "/_slm/policy/{policy_id}/_execute" + "path": "/_security/user/{username}" } ], "visibility": "public" @@ -16807,36 +16869,46 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "7.5.0", + "since": "7.15.0", "stability": "stable" } }, - "description": "Deletes any snapshots that are expired according to the policy's retention rules.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", - "name": "slm.execute_retention", + "description": "Retrieves information for API keys using a subset of query DSL", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", + "name": "security.query_api_keys", + "privileges": { + "cluster": [ + "manage_own_api_key", + "read_security" + ] + }, "request": { "name": "Request", - "namespace": "slm.execute_retention" + "namespace": "security.query_api_keys" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "slm.execute_retention" + "namespace": "security.query_api_keys" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "7.15.0", "stability": "stable", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_slm/_execute_retention" + "path": "/_security/_query/api_key" } ], "visibility": "public" @@ -16848,39 +16920,36 @@ "visibility": "private" }, "stack": { - "since": "7.4.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", - "name": "slm.get_lifecycle", + "description": "Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", + "name": "security.saml_authenticate", "request": { "name": "Request", - "namespace": "slm.get_lifecycle" + "namespace": "security.saml_authenticate" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "slm.get_lifecycle" + "namespace": "security.saml_authenticate" }, "responseMediaType": [ "application/json" ], - "since": "7.4.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_slm/policy/{policy_id}" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_slm/policy" + "path": "/_security/saml/authenticate" } ], "visibility": "public" @@ -16892,33 +16961,36 @@ "visibility": "private" }, "stack": { - "since": "7.5.0", + "since": "7.14.0", "stability": "stable" } }, - "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", - "name": "slm.get_stats", + "description": "Verifies the logout response sent from the SAML IdP", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", + "name": "security.saml_complete_logout", "request": { "name": "Request", - "namespace": "slm.get_stats" + "namespace": "security.saml_complete_logout" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "slm.get_stats" + "namespace": "security.saml_complete_logout" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "7.14.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_slm/stats" + "path": "/_security/saml/complete_logout" } ], "visibility": "public" @@ -16930,33 +17002,36 @@ "visibility": "private" }, "stack": { - "since": "7.6.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Retrieves the status of snapshot lifecycle management (SLM).", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", - "name": "slm.get_status", + "description": "Consumes a SAML LogoutRequest", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", + "name": "security.saml_invalidate", "request": { "name": "Request", - "namespace": "slm.get_status" + "namespace": "security.saml_invalidate" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "slm.get_status" + "namespace": "security.saml_invalidate" }, "responseMediaType": [ "application/json" ], - "since": "7.6.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_slm/status" + "path": "/_security/saml/invalidate" } ], "visibility": "public" @@ -16968,36 +17043,36 @@ "visibility": "private" }, "stack": { - "since": "7.4.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Creates or updates a snapshot lifecycle policy.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", - "name": "slm.put_lifecycle", + "description": "Invalidates an access token and a refresh token that were generated via the SAML Authenticate API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", + "name": "security.saml_logout", "request": { "name": "Request", - "namespace": "slm.put_lifecycle" + "namespace": "security.saml_logout" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "slm.put_lifecycle" + "namespace": "security.saml_logout" }, "responseMediaType": [ "application/json" ], - "since": "7.4.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "POST" ], - "path": "/_slm/policy/{policy_id}" + "path": "/_security/saml/logout" } ], "visibility": "public" @@ -17009,33 +17084,36 @@ "visibility": "private" }, "stack": { - "since": "7.6.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Turns on snapshot lifecycle management (SLM).", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", - "name": "slm.start", + "description": "Creates a SAML authentication request", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", + "name": "security.saml_prepare_authentication", "request": { "name": "Request", - "namespace": "slm.start" + "namespace": "security.saml_prepare_authentication" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "slm.start" + "namespace": "security.saml_prepare_authentication" }, "responseMediaType": [ "application/json" ], - "since": "7.6.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_slm/start" + "path": "/_security/saml/prepare" } ], "visibility": "public" @@ -17047,33 +17125,36 @@ "visibility": "private" }, "stack": { - "since": "7.6.0", + "since": "7.11.0", "stability": "stable" } }, - "description": "Turns off snapshot lifecycle management (SLM).", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", - "name": "slm.stop", + "description": "Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", + "name": "security.saml_service_provider_metadata", "request": { "name": "Request", - "namespace": "slm.stop" + "namespace": "security.saml_service_provider_metadata" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "slm.stop" + "namespace": "security.saml_service_provider_metadata" }, "responseMediaType": [ "application/json" ], - "since": "7.6.0", + "since": "7.11.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_slm/stop" + "path": "/_security/saml/metadata/{realm_name}" } ], "visibility": "public" @@ -17085,116 +17166,143 @@ "visibility": "private" }, "stack": { - "since": "7.4.0", + "since": "8.2.0", "stability": "stable" } }, - "description": "Removes stale data from repository.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", - "name": "snapshot.cleanup_repository", + "description": "Get suggestions for user profiles that match specified search criteria.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html", + "name": "security.suggest_user_profiles", "request": { "name": "Request", - "namespace": "snapshot.cleanup_repository" + "namespace": "security.suggest_user_profiles" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "snapshot.cleanup_repository" + "namespace": "security.suggest_user_profiles" }, "responseMediaType": [ "application/json" ], - "since": "7.4.0", + "since": "8.2.0", "stability": "stable", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/_snapshot/{repository}/_cleanup" + "path": "/_security/profile/_suggest" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "7.10.0", + "since": "8.4.0", "stability": "stable" } }, - "description": "Clones indices from one snapshot into another snapshot in the same repository.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.clone", + "description": "Updates attributes of an existing API key.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", + "name": "security.update_api_key", + "privileges": { + "cluster": [ + "manage_own_api_key" + ] + }, "request": { "name": "Request", - "namespace": "snapshot.clone" + "namespace": "security.update_api_key" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "snapshot.clone" + "namespace": "security.update_api_key" }, "responseMediaType": [ "application/json" ], - "since": "7.10.0", + "since": "8.4.0", "stability": "stable", "urls": [ { "methods": [ "PUT" ], - "path": "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}" + "path": "/_security/api_key/{id}" } ], "visibility": "public" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "0.0.0", - "stability": "stable" + "stability": "beta", + "visibility": "public" } }, - "description": "Creates a snapshot in a repository.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.create", - "request": { - "name": "Request", - "namespace": "snapshot.create" - }, - "requestBodyRequired": false, + "description": "Updates attributes of an existing cross-cluster API key.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", + "name": "security.update_cross_cluster_api_key", + "request": null, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "snapshot.create" + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "beta", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_security/cross_cluster/api_key/{id}" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } }, + "description": "Update settings for the security system index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html", + "name": "security.update_settings", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, "responseMediaType": [ "application/json" ], - "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "PUT" ], - "path": "/_snapshot/{repository}/{snapshot}" + "path": "/_security/settings" } ], "visibility": "public" @@ -17206,16 +17314,21 @@ "visibility": "private" }, "stack": { - "since": "0.0.0", + "since": "8.2.0", "stability": "stable" } }, - "description": "Creates a repository.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.create_repository", + "description": "Update application specific data for the user profile of the given unique ID.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html", + "name": "security.update_user_profile_data", + "privileges": { + "cluster": [ + "manage_user_profile" + ] + }, "request": { "name": "Request", - "namespace": "snapshot.create_repository" + "namespace": "security.update_user_profile_data" }, "requestBodyRequired": true, "requestMediaType": [ @@ -17223,12 +17336,12 @@ ], "response": { "name": "Response", - "namespace": "snapshot.create_repository" + "namespace": "security.update_user_profile_data" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "8.2.0", "stability": "stable", "urls": [ { @@ -17236,124 +17349,127 @@ "PUT", "POST" ], - "path": "/_snapshot/{repository}" + "path": "/_security/profile/{uid}/_data" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "0.0.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Deletes one or more snapshots.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.delete", + "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", + "name": "shutdown.delete_node", "request": { "name": "Request", - "namespace": "snapshot.delete" + "namespace": "shutdown.delete_node" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "snapshot.delete" + "namespace": "shutdown.delete_node" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ "DELETE" ], - "path": "/_snapshot/{repository}/{snapshot}" + "path": "/_nodes/{node_id}/shutdown" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "0.0.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Deletes a repository.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.delete_repository", + "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", + "name": "shutdown.get_node", "request": { "name": "Request", - "namespace": "snapshot.delete_repository" + "namespace": "shutdown.get_node" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "snapshot.delete_repository" + "namespace": "shutdown.get_node" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_snapshot/{repository}" + "path": "/_nodes/shutdown" + }, + { + "methods": [ + "GET" + ], + "path": "/_nodes/{node_id}/shutdown" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { - "serverless": { - "stability": "stable", - "visibility": "private" - }, "stack": { - "since": "0.0.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Returns information about a snapshot.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.get", + "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", + "name": "shutdown.put_node", "request": { "name": "Request", - "namespace": "snapshot.get" + "namespace": "shutdown.put_node" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "snapshot.get" + "namespace": "shutdown.put_node" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/_snapshot/{repository}/{snapshot}" + "path": "/_nodes/{node_id}/shutdown" } ], - "visibility": "public" + "visibility": "private" }, { "availability": { @@ -17362,66 +17478,71 @@ "visibility": "private" }, "stack": { - "since": "0.0.0", + "since": "7.4.0", "stability": "stable" } }, - "description": "Returns information about a repository.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.get_repository", + "description": "Deletes an existing snapshot lifecycle policy.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", + "name": "slm.delete_lifecycle", "request": { "name": "Request", - "namespace": "snapshot.get_repository" + "namespace": "slm.delete_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "snapshot.get_repository" + "namespace": "slm.delete_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_snapshot" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_snapshot/{repository}" + "path": "/_slm/policy/{policy_id}" } ], "visibility": "public" }, { "availability": { - "stack": { + "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" + }, + "stack": { + "since": "7.4.0", + "stability": "stable" } }, - "description": "Analyzes a repository for correctness and performance", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.repository_analyze", - "request": null, + "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", + "name": "slm.execute_lifecycle", + "request": { + "name": "Request", + "namespace": "slm.execute_lifecycle" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "slm.execute_lifecycle" + }, "responseMediaType": [ "application/json" ], + "since": "7.4.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_snapshot/{repository}/_analyze" + "path": "/_slm/policy/{policy_id}/_execute" } ], "visibility": "public" @@ -17433,36 +17554,33 @@ "visibility": "private" }, "stack": { - "since": "0.0.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Restores a snapshot.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.restore", + "description": "Deletes any snapshots that are expired according to the policy's retention rules.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", + "name": "slm.execute_retention", "request": { "name": "Request", - "namespace": "snapshot.restore" + "namespace": "slm.execute_retention" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "snapshot.restore" + "namespace": "slm.execute_retention" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_snapshot/{repository}/{snapshot}/_restore" + "path": "/_slm/_execute_retention" } ], "visibility": "public" @@ -17474,45 +17592,77 @@ "visibility": "private" }, "stack": { - "since": "7.8.0", + "since": "7.4.0", "stability": "stable" } }, - "description": "Returns information about the status of a snapshot.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.status", + "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", + "name": "slm.get_lifecycle", "request": { "name": "Request", - "namespace": "snapshot.status" + "namespace": "slm.get_lifecycle" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "snapshot.status" + "namespace": "slm.get_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "7.8.0", + "since": "7.4.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_snapshot/_status" + "path": "/_slm/policy/{policy_id}" }, { "methods": [ "GET" ], - "path": "/_snapshot/{repository}/_status" + "path": "/_slm/policy" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" }, + "stack": { + "since": "7.5.0", + "stability": "stable" + } + }, + "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", + "name": "slm.get_stats", + "request": { + "name": "Request", + "namespace": "slm.get_stats" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "slm.get_stats" + }, + "responseMediaType": [ + "application/json" + ], + "since": "7.5.0", + "stability": "stable", + "urls": [ { "methods": [ "GET" ], - "path": "/_snapshot/{repository}/{snapshot}/_status" + "path": "/_slm/stats" } ], "visibility": "public" @@ -17524,33 +17674,33 @@ "visibility": "private" }, "stack": { - "since": "0.0.0", + "since": "7.6.0", "stability": "stable" } }, - "description": "Verifies a repository.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "name": "snapshot.verify_repository", + "description": "Retrieves the status of snapshot lifecycle management (SLM).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", + "name": "slm.get_status", "request": { "name": "Request", - "namespace": "snapshot.verify_repository" + "namespace": "slm.get_status" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "snapshot.verify_repository" + "namespace": "slm.get_status" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.6.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_snapshot/{repository}/_verify" + "path": "/_slm/status" } ], "visibility": "public" @@ -17559,39 +17709,39 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "6.3.0", + "since": "7.4.0", "stability": "stable" } }, - "description": "Clears the SQL cursor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", - "name": "sql.clear_cursor", + "description": "Creates or updates a snapshot lifecycle policy.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", + "name": "slm.put_lifecycle", "request": { "name": "Request", - "namespace": "sql.clear_cursor" + "namespace": "slm.put_lifecycle" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "sql.clear_cursor" + "namespace": "slm.put_lifecycle" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "7.4.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_sql/close" + "path": "/_slm/policy/{policy_id}" } ], "visibility": "public" @@ -17600,36 +17750,36 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.15.0", + "since": "7.6.0", "stability": "stable" } }, - "description": "Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", - "name": "sql.delete_async", + "description": "Turns on snapshot lifecycle management (SLM).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", + "name": "slm.start", "request": { "name": "Request", - "namespace": "sql.delete_async" + "namespace": "slm.start" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "sql.delete_async" + "namespace": "slm.start" }, "responseMediaType": [ "application/json" ], - "since": "7.15.0", + "since": "7.6.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "POST" ], - "path": "/_sql/async/delete/{id}" + "path": "/_slm/start" } ], "visibility": "public" @@ -17638,36 +17788,36 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.15.0", + "since": "7.6.0", "stability": "stable" } }, - "description": "Returns the current status and available results for an async SQL search or stored synchronous SQL search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", - "name": "sql.get_async", + "description": "Turns off snapshot lifecycle management (SLM).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", + "name": "slm.stop", "request": { "name": "Request", - "namespace": "sql.get_async" + "namespace": "slm.stop" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "sql.get_async" + "namespace": "slm.stop" }, "responseMediaType": [ "application/json" ], - "since": "7.15.0", + "since": "7.6.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_sql/async/{id}" + "path": "/_slm/stop" } ], "visibility": "public" @@ -17676,36 +17826,36 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.15.0", + "since": "7.4.0", "stability": "stable" } }, - "description": "Returns the current status of an async SQL search or a stored synchronous SQL search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", - "name": "sql.get_async_status", + "description": "Removes stale data from repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", + "name": "snapshot.cleanup_repository", "request": { "name": "Request", - "namespace": "sql.get_async_status" + "namespace": "snapshot.cleanup_repository" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "sql.get_async_status" + "namespace": "snapshot.cleanup_repository" }, "responseMediaType": [ "application/json" ], - "since": "7.15.0", + "since": "7.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_sql/async/status/{id}" + "path": "/_snapshot/{repository}/_cleanup" } ], "visibility": "public" @@ -17714,19 +17864,19 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "6.3.0", + "since": "7.10.0", "stability": "stable" } }, - "description": "Executes a SQL request", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", - "name": "sql.query", + "description": "Clones indices from one snapshot into another snapshot in the same repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.clone", "request": { "name": "Request", - "namespace": "sql.query" + "namespace": "snapshot.clone" }, "requestBodyRequired": true, "requestMediaType": [ @@ -17734,20 +17884,19 @@ ], "response": { "name": "Response", - "namespace": "sql.query" + "namespace": "snapshot.clone" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "7.10.0", "stability": "stable", "urls": [ { "methods": [ - "POST", - "GET" + "PUT" ], - "path": "/_sql" + "path": "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}" } ], "visibility": "public" @@ -17756,40 +17905,40 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "6.3.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Translates SQL into Elasticsearch queries", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", - "name": "sql.translate", + "description": "Creates a snapshot in a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.create", "request": { "name": "Request", - "namespace": "sql.translate" + "namespace": "snapshot.create" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "sql.translate" + "namespace": "snapshot.create" }, "responseMediaType": [ "application/json" ], - "since": "6.3.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "POST", - "GET" + "PUT", + "POST" ], - "path": "/_sql/translate" + "path": "/_snapshot/{repository}/{snapshot}" } ], "visibility": "public" @@ -17801,33 +17950,37 @@ "visibility": "private" }, "stack": { - "since": "6.2.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves information about the X.509 certificates used to encrypt communications in the cluster.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", - "name": "ssl.certificates", + "description": "Creates a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.create_repository", "request": { "name": "Request", - "namespace": "ssl.certificates" + "namespace": "snapshot.create_repository" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ssl.certificates" + "namespace": "snapshot.create_repository" }, "responseMediaType": [ "application/json" ], - "since": "6.2.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "PUT", + "POST" ], - "path": "/_ssl/certificates" + "path": "/_snapshot/{repository}" } ], "visibility": "public" @@ -17836,36 +17989,36 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "8.10.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Deletes a synonym set", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html", - "name": "synonyms.delete_synonym", + "description": "Deletes one or more snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.delete", "request": { "name": "Request", - "namespace": "synonyms.delete_synonym" + "namespace": "snapshot.delete" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "synonyms.delete_synonym" + "namespace": "snapshot.delete" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ "DELETE" ], - "path": "/_synonyms/{id}" + "path": "/_snapshot/{repository}/{snapshot}" } ], "visibility": "public" @@ -17874,39 +18027,36 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "8.10.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Deletes a synonym rule in a synonym set", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html", - "name": "synonyms.delete_synonym_rule", + "description": "Deletes a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.delete_repository", "request": { "name": "Request", - "namespace": "synonyms.delete_synonym_rule" + "namespace": "snapshot.delete_repository" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "synonyms.delete_synonym_rule" + "namespace": "snapshot.delete_repository" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ "DELETE" ], - "path": "/_synonyms/{set_id}/{rule_id}" + "path": "/_snapshot/{repository}" } ], "visibility": "public" @@ -17915,36 +18065,36 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "8.10.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves a synonym set", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html", - "name": "synonyms.get_synonym", + "description": "Returns information about a snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.get", "request": { "name": "Request", - "namespace": "synonyms.get_synonym" + "namespace": "snapshot.get" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "synonyms.get_synonym" + "namespace": "snapshot.get" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_synonyms/{id}" + "path": "/_snapshot/{repository}/{snapshot}" } ], "visibility": "public" @@ -17953,77 +18103,69 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "8.10.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Retrieves a synonym rule from a synonym set", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html", - "name": "synonyms.get_synonym_rule", + "description": "Returns information about a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.get_repository", "request": { "name": "Request", - "namespace": "synonyms.get_synonym_rule" + "namespace": "snapshot.get_repository" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "synonyms.get_synonym_rule" + "namespace": "snapshot.get_repository" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ "GET" ], - "path": "/_synonyms/{set_id}/{rule_id}" + "path": "/_snapshot" + }, + { + "methods": [ + "GET" + ], + "path": "/_snapshot/{repository}" } ], "visibility": "public" }, { "availability": { - "serverless": { + "stack": { "stability": "stable", "visibility": "public" - }, - "stack": { - "since": "8.10.0", - "stability": "stable" } }, - "description": "Retrieves a summary of all defined synonym sets", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html", - "name": "synonyms.get_synonyms_sets", - "request": { - "name": "Request", - "namespace": "synonyms.get_synonyms_sets" - }, + "description": "Analyzes a repository for correctness and performance", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.repository_analyze", + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "synonyms.get_synonyms_sets" - }, + "response": null, "responseMediaType": [ "application/json" ], - "since": "8.10.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_synonyms" + "path": "/_snapshot/{repository}/_analyze" } ], "visibility": "public" @@ -18032,39 +18174,39 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "8.10.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Creates or updates a synonyms set", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html", - "name": "synonyms.put_synonym", + "description": "Restores a snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.restore", "request": { "name": "Request", - "namespace": "synonyms.put_synonym" + "namespace": "snapshot.restore" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "synonyms.put_synonym" + "namespace": "snapshot.restore" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "POST" ], - "path": "/_synonyms/{id}" + "path": "/_snapshot/{repository}/{snapshot}/_restore" } ], "visibility": "public" @@ -18073,39 +18215,48 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "8.10.0", + "since": "7.8.0", "stability": "stable" } }, - "description": "Creates or updates a synonym rule in a synonym set", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html", - "name": "synonyms.put_synonym_rule", + "description": "Returns information about the status of a snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.status", "request": { "name": "Request", - "namespace": "synonyms.put_synonym_rule" + "namespace": "snapshot.status" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "synonyms.put_synonym_rule" + "namespace": "snapshot.status" }, "responseMediaType": [ "application/json" ], - "since": "8.10.0", + "since": "7.8.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_synonyms/{set_id}/{rule_id}" + "path": "/_snapshot/_status" + }, + { + "methods": [ + "GET" + ], + "path": "/_snapshot/{repository}/_status" + }, + { + "methods": [ + "GET" + ], + "path": "/_snapshot/{repository}/{snapshot}/_status" } ], "visibility": "public" @@ -18113,44 +18264,37 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "private" }, "stack": { - "since": "2.3.0", - "stability": "experimental" + "since": "0.0.0", + "stability": "stable" } }, - "description": "Cancels a task, if it can be cancelled through an API.", - "docId": "tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", - "name": "tasks.cancel", + "description": "Verifies a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "name": "snapshot.verify_repository", "request": { "name": "Request", - "namespace": "tasks.cancel" + "namespace": "snapshot.verify_repository" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "tasks.cancel" + "namespace": "snapshot.verify_repository" }, "responseMediaType": [ "application/json" ], - "since": "2.3.0", - "stability": "experimental", + "since": "0.0.0", + "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_tasks/_cancel" - }, - { - "methods": [ - "POST" - ], - "path": "/_tasks/{task_id}/_cancel" + "path": "/_snapshot/{repository}/_verify" } ], "visibility": "public" @@ -18158,38 +18302,40 @@ { "availability": { "serverless": { - "stability": "experimental", + "stability": "stable", "visibility": "public" }, "stack": { - "since": "5.0.0", - "stability": "experimental" + "since": "6.3.0", + "stability": "stable" } }, - "description": "Returns information about a task.", - "docId": "tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", - "name": "tasks.get", + "description": "Clears the SQL cursor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", + "name": "sql.clear_cursor", "request": { "name": "Request", - "namespace": "tasks.get" + "namespace": "sql.clear_cursor" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "tasks.get" + "namespace": "sql.clear_cursor" }, "responseMediaType": [ "application/json" ], - "since": "5.0.0", - "stability": "experimental", + "since": "6.3.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_tasks/{task_id}" + "path": "/_sql/close" } ], "visibility": "public" @@ -18197,44 +18343,37 @@ { "availability": { "serverless": { - "stability": "experimental", - "visibility": "private" + "stability": "stable", + "visibility": "public" }, "stack": { - "since": "2.3.0", - "stability": "experimental" + "since": "7.15.0", + "stability": "stable" } }, - "description": "Returns a list of tasks.", - "docId": "tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", - "name": "tasks.list", - "privileges": { - "cluster": [ - "monitor", - "manage" - ] - }, + "description": "Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", + "name": "sql.delete_async", "request": { "name": "Request", - "namespace": "tasks.list" + "namespace": "sql.delete_async" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "tasks.list" + "namespace": "sql.delete_async" }, "responseMediaType": [ "application/json" ], - "since": "2.3.0", - "stability": "experimental", + "since": "7.15.0", + "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_tasks" + "path": "/_sql/async/delete/{id}" } ], "visibility": "public" @@ -18246,37 +18385,33 @@ "visibility": "public" }, "stack": { - "since": "7.14.0", + "since": "7.15.0", "stability": "stable" } }, - "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", - "name": "terms_enum", + "description": "Returns the current status and available results for an async SQL search or stored synchronous SQL search", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", + "name": "sql.get_async", "request": { "name": "Request", - "namespace": "_global.terms_enum" + "namespace": "sql.get_async" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "_global.terms_enum" + "namespace": "sql.get_async" }, "responseMediaType": [ "application/json" ], - "since": "7.14.0", + "since": "7.15.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "GET" ], - "path": "/{index}/_terms_enum" + "path": "/_sql/async/{id}" } ], "visibility": "public" @@ -18288,44 +18423,33 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.15.0", "stability": "stable" } }, - "description": "Returns information and statistics about terms in the fields of a particular document.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", - "name": "termvectors", + "description": "Returns the current status of an async SQL search or a stored synchronous SQL search", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", + "name": "sql.get_async_status", "request": { "name": "Request", - "namespace": "_global.termvectors" + "namespace": "sql.get_async_status" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "_global.termvectors" + "namespace": "sql.get_async_status" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.15.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/{index}/_termvectors/{id}" - }, - { - "methods": [ - "GET", - "POST" + "GET" ], - "path": "/{index}/_termvectors" + "path": "/_sql/async/status/{id}" } ], "visibility": "public" @@ -18334,39 +18458,40 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "7.13.0", + "since": "6.3.0", "stability": "stable" } }, - "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", - "name": "text_structure.find_structure", + "description": "Executes a SQL request", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", + "name": "sql.query", "request": { "name": "Request", - "namespace": "text_structure.find_structure" + "namespace": "sql.query" }, "requestBodyRequired": true, "requestMediaType": [ - "application/x-ndjson" + "application/json" ], "response": { "name": "Response", - "namespace": "text_structure.find_structure" + "namespace": "sql.query" }, "responseMediaType": [ "application/json" ], - "since": "7.13.0", + "since": "6.3.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "POST", + "GET" ], - "path": "/_text_structure/find_structure" + "path": "/_sql" } ], "visibility": "public" @@ -18375,19 +18500,19 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "8.13.0", + "since": "6.3.0", "stability": "stable" } }, - "description": "Tests a Grok pattern on some text.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html", - "name": "text_structure.test_grok_pattern", + "description": "Translates SQL into Elasticsearch queries", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", + "name": "sql.translate", "request": { "name": "Request", - "namespace": "text_structure.test_grok_pattern" + "namespace": "sql.translate" }, "requestBodyRequired": true, "requestMediaType": [ @@ -18395,20 +18520,20 @@ ], "response": { "name": "Response", - "namespace": "text_structure.test_grok_pattern" + "namespace": "sql.translate" }, "responseMediaType": [ "application/json" ], - "since": "8.13.0", + "since": "6.3.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" + "POST", + "GET" ], - "path": "/_text_structure/test_grok_pattern" + "path": "/_sql/translate" } ], "visibility": "public" @@ -18417,41 +18542,36 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { - "since": "7.5.0", + "since": "6.2.0", "stability": "stable" } }, - "description": "Deletes an existing transform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", - "name": "transform.delete_transform", - "privileges": { - "cluster": [ - "manage_transform" - ] - }, + "description": "Retrieves information about the X.509 certificates used to encrypt communications in the cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", + "name": "ssl.certificates", "request": { "name": "Request", - "namespace": "transform.delete_transform" + "namespace": "ssl.certificates" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "transform.delete_transform" + "namespace": "ssl.certificates" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "6.2.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_transform/{transform_id}" + "path": "/_ssl/certificates" } ], "visibility": "public" @@ -18463,44 +18583,33 @@ "visibility": "public" }, "stack": { - "since": "7.5.0", + "since": "8.10.0", "stability": "stable" } }, - "description": "Retrieves configuration information for transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", - "name": "transform.get_transform", - "privileges": { - "cluster": [ - "monitor_transform" - ] - }, + "description": "Deletes a synonym set", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html", + "name": "synonyms.delete_synonym", "request": { "name": "Request", - "namespace": "transform.get_transform" + "namespace": "synonyms.delete_synonym" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "transform.get_transform" + "namespace": "synonyms.delete_synonym" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "8.10.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_transform/{transform_id}" - }, - { - "methods": [ - "GET" + "DELETE" ], - "path": "/_transform" + "path": "/_synonyms/{id}" } ], "visibility": "public" @@ -18512,42 +18621,36 @@ "visibility": "public" }, "stack": { - "since": "7.5.0", + "since": "8.10.0", "stability": "stable" } }, - "description": "Retrieves usage information for transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", - "name": "transform.get_transform_stats", - "privileges": { - "cluster": [ - "monitor_transform" - ], - "index": [ - "read", - "view_index_metadata" - ] - }, + "description": "Deletes a synonym rule in a synonym set", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html", + "name": "synonyms.delete_synonym_rule", "request": { "name": "Request", - "namespace": "transform.get_transform_stats" + "namespace": "synonyms.delete_synonym_rule" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "transform.get_transform_stats" + "namespace": "synonyms.delete_synonym_rule" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "8.10.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "DELETE" ], - "path": "/_transform/{transform_id}/_stats" + "path": "/_synonyms/{set_id}/{rule_id}" } ], "visibility": "public" @@ -18559,53 +18662,33 @@ "visibility": "public" }, "stack": { - "since": "7.2.0", + "since": "8.10.0", "stability": "stable" } }, - "description": "Previews a transform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", - "name": "transform.preview_transform", - "privileges": { - "cluster": [ - "manage_transform" - ], - "index": [ - "read", - "view_index_metadata" - ] - }, + "description": "Retrieves a synonym set", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html", + "name": "synonyms.get_synonym", "request": { "name": "Request", - "namespace": "transform.preview_transform" + "namespace": "synonyms.get_synonym" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "transform.preview_transform" + "namespace": "synonyms.get_synonym" }, "responseMediaType": [ "application/json" ], - "since": "7.2.0", + "since": "8.10.0", "stability": "stable", "urls": [ { "methods": [ - "GET", - "POST" - ], - "path": "/_transform/{transform_id}/_preview" - }, - { - "methods": [ - "GET", - "POST" + "GET" ], - "path": "/_transform/_preview" + "path": "/_synonyms/{id}" } ], "visibility": "public" @@ -18617,47 +18700,36 @@ "visibility": "public" }, "stack": { - "since": "7.2.0", + "since": "8.10.0", "stability": "stable" } }, - "description": "Instantiates a transform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", - "name": "transform.put_transform", - "privileges": { - "cluster": [ - "manage_transform" - ], - "index": [ - "create_index", - "read", - "index", - "view_index_metadata" - ] - }, + "description": "Retrieves a synonym rule from a synonym set", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html", + "name": "synonyms.get_synonym_rule", "request": { "name": "Request", - "namespace": "transform.put_transform" + "namespace": "synonyms.get_synonym_rule" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "transform.put_transform" + "namespace": "synonyms.get_synonym_rule" }, "responseMediaType": [ "application/json" ], - "since": "7.2.0", + "since": "8.10.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "GET" ], - "path": "/_transform/{transform_id}" + "path": "/_synonyms/{set_id}/{rule_id}" } ], "visibility": "public" @@ -18669,38 +18741,33 @@ "visibility": "public" }, "stack": { - "since": "8.1.0", + "since": "8.10.0", "stability": "stable" } }, - "description": "Resets an existing transform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", - "name": "transform.reset_transform", - "privileges": { - "cluster": [ - "manage_transform" - ] - }, + "description": "Retrieves a summary of all defined synonym sets", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html", + "name": "synonyms.get_synonyms_sets", "request": { "name": "Request", - "namespace": "transform.reset_transform" + "namespace": "synonyms.get_synonyms_sets" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "transform.reset_transform" + "namespace": "synonyms.get_synonyms_sets" }, "responseMediaType": [ "application/json" ], - "since": "8.1.0", + "since": "8.10.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_transform/{transform_id}/_reset" + "path": "/_synonyms" } ], "visibility": "public" @@ -18712,41 +18779,36 @@ "visibility": "public" }, "stack": { - "since": "8.7.0", + "since": "8.10.0", "stability": "stable" } }, - "description": "Schedules now a transform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", - "name": "transform.schedule_now_transform", - "privileges": { - "cluster": [ - "manage_transform" - ] - }, + "description": "Creates or updates a synonyms set", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html", + "name": "synonyms.put_synonym", "request": { "name": "Request", - "namespace": "transform.schedule_now_transform" + "namespace": "synonyms.put_synonym" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "transform.schedule_now_transform" + "namespace": "synonyms.put_synonym" }, "responseMediaType": [ "application/json" ], - "since": "8.7.0", + "since": "8.10.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_transform/{transform_id}/_schedule_now" + "path": "/_synonyms/{id}" } ], "visibility": "public" @@ -18758,42 +18820,36 @@ "visibility": "public" }, "stack": { - "since": "7.5.0", + "since": "8.10.0", "stability": "stable" } }, - "description": "Starts one or more transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", - "name": "transform.start_transform", - "privileges": { - "cluster": [ - "manage_transform" - ], - "index": [ - "read", - "view_index_metadata" - ] - }, + "description": "Creates or updates a synonym rule in a synonym set", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html", + "name": "synonyms.put_synonym_rule", "request": { "name": "Request", - "namespace": "transform.start_transform" + "namespace": "synonyms.put_synonym_rule" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "transform.start_transform" + "namespace": "synonyms.put_synonym_rule" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", + "since": "8.10.0", "stability": "stable", "urls": [ { "methods": [ - "POST" + "PUT" ], - "path": "/_transform/{transform_id}/_start" + "path": "/_synonyms/{set_id}/{rule_id}" } ], "visibility": "public" @@ -18801,42 +18857,44 @@ { "availability": { "serverless": { - "stability": "stable", - "visibility": "public" + "stability": "experimental", + "visibility": "private" }, "stack": { - "since": "7.5.0", - "stability": "stable" + "since": "2.3.0", + "stability": "experimental" } }, - "description": "Stops one or more transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", - "name": "transform.stop_transform", - "privileges": { - "cluster": [ - "manage_transform" - ] - }, + "description": "Cancels a task, if it can be cancelled through an API.", + "docId": "tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", + "name": "tasks.cancel", "request": { "name": "Request", - "namespace": "transform.stop_transform" + "namespace": "tasks.cancel" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "transform.stop_transform" + "namespace": "tasks.cancel" }, "responseMediaType": [ "application/json" ], - "since": "7.5.0", - "stability": "stable", + "since": "2.3.0", + "stability": "experimental", "urls": [ { "methods": [ "POST" ], - "path": "/_transform/{transform_id}/_stop" + "path": "/_tasks/_cancel" + }, + { + "methods": [ + "POST" + ], + "path": "/_tasks/{task_id}/_cancel" } ], "visibility": "public" @@ -18844,50 +18902,38 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "public" }, "stack": { - "since": "7.2.0", - "stability": "stable" + "since": "5.0.0", + "stability": "experimental" } }, - "description": "Updates certain properties of a transform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", - "name": "transform.update_transform", - "privileges": { - "cluster": [ - "manage_transform" - ], - "index": [ - "read", - "index", - "view_index_metadata" - ] - }, + "description": "Returns information about a task.", + "docId": "tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", + "name": "tasks.get", "request": { "name": "Request", - "namespace": "transform.update_transform" + "namespace": "tasks.get" }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], + "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "transform.update_transform" + "namespace": "tasks.get" }, "responseMediaType": [ "application/json" ], - "since": "7.2.0", - "stability": "stable", + "since": "5.0.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_transform/{transform_id}/_update" + "path": "/_tasks/{task_id}" } ], "visibility": "public" @@ -18895,45 +18941,44 @@ { "availability": { "serverless": { - "stability": "stable", + "stability": "experimental", "visibility": "private" }, "stack": { - "since": "7.16.0", - "stability": "stable" + "since": "2.3.0", + "stability": "experimental" } }, - "description": "Upgrades all transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", - "name": "transform.upgrade_transforms", + "description": "Returns a list of tasks.", + "docId": "tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", + "name": "tasks.list", "privileges": { "cluster": [ - "manage_transform" + "monitor", + "manage" ] }, "request": { "name": "Request", - "namespace": "transform.upgrade_transforms" + "namespace": "tasks.list" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "transform.upgrade_transforms" + "namespace": "tasks.list" }, "responseMediaType": [ "application/json" ], - "since": "7.16.0", - "stability": "stable", + "since": "2.3.0", + "stability": "experimental", "urls": [ { "methods": [ - "POST" + "GET" ], - "path": "/_transform/_upgrade" + "path": "/_tasks" } ], "visibility": "public" @@ -18945,36 +18990,37 @@ "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "7.14.0", "stability": "stable" } }, - "description": "Updates a document with a script or partial document.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", - "name": "update", + "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", + "name": "terms_enum", "request": { "name": "Request", - "namespace": "_global.update" + "namespace": "_global.terms_enum" }, - "requestBodyRequired": true, + "requestBodyRequired": false, "requestMediaType": [ "application/json" ], "response": { "name": "Response", - "namespace": "_global.update" + "namespace": "_global.terms_enum" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.14.0", "stability": "stable", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/{index}/_update/{id}" + "path": "/{index}/_terms_enum" } ], "visibility": "public" @@ -18986,16 +19032,16 @@ "visibility": "public" }, "stack": { - "since": "2.4.0", + "since": "0.0.0", "stability": "stable" } }, - "description": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", - "name": "update_by_query", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", + "name": "termvectors", "request": { "name": "Request", - "namespace": "_global.update_by_query" + "namespace": "_global.termvectors" }, "requestBodyRequired": false, "requestMediaType": [ @@ -19003,19 +19049,27 @@ ], "response": { "name": "Response", - "namespace": "_global.update_by_query" + "namespace": "_global.termvectors" }, "responseMediaType": [ "application/json" ], - "since": "2.4.0", + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ + "GET", "POST" ], - "path": "/{index}/_update_by_query" + "path": "/{index}/_termvectors/{id}" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_termvectors" } ], "visibility": "public" @@ -19027,201 +19081,247 @@ "visibility": "private" }, "stack": { - "since": "6.5.0", + "since": "7.13.0", "stability": "stable" } }, - "description": "Changes the number of requests per second for a particular Update By Query operation.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", - "name": "update_by_query_rethrottle", + "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", + "name": "text_structure.find_structure", "request": { "name": "Request", - "namespace": "_global.update_by_query_rethrottle" + "namespace": "text_structure.find_structure" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": { "name": "Response", - "namespace": "_global.update_by_query_rethrottle" + "namespace": "text_structure.find_structure" }, "responseMediaType": [ "application/json" ], - "since": "6.5.0", + "since": "7.13.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_update_by_query/{task_id}/_rethrottle" + "path": "/_text_structure/find_structure" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "0.0.0", + "since": "8.13.0", "stability": "stable" } }, - "description": "Acknowledges a watch, manually throttling the execution of the watch's actions.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", - "name": "watcher.ack_watch", + "description": "Tests a Grok pattern on some text.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html", + "name": "text_structure.test_grok_pattern", "request": { "name": "Request", - "namespace": "watcher.ack_watch" + "namespace": "text_structure.test_grok_pattern" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "watcher.ack_watch" + "namespace": "text_structure.test_grok_pattern" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "8.13.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" - ], - "path": "/_watcher/watch/{watch_id}/_ack" - }, - { - "methods": [ - "PUT", + "GET", "POST" ], - "path": "/_watcher/watch/{watch_id}/_ack/{action_id}" + "path": "/_text_structure/test_grok_pattern" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Activates a currently inactive watch.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", - "name": "watcher.activate_watch", + "description": "Deletes an existing transform.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", + "name": "transform.delete_transform", + "privileges": { + "cluster": [ + "manage_transform" + ] + }, "request": { "name": "Request", - "namespace": "watcher.activate_watch" + "namespace": "transform.delete_transform" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "watcher.activate_watch" + "namespace": "transform.delete_transform" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "DELETE" ], - "path": "/_watcher/watch/{watch_id}/_activate" + "path": "/_transform/{transform_id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Deactivates a currently active watch.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", - "name": "watcher.deactivate_watch", + "description": "Retrieves configuration information for transforms.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", + "name": "transform.get_transform", + "privileges": { + "cluster": [ + "monitor_transform" + ] + }, "request": { "name": "Request", - "namespace": "watcher.deactivate_watch" + "namespace": "transform.get_transform" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "watcher.deactivate_watch" + "namespace": "transform.get_transform" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", - "POST" + "GET" ], - "path": "/_watcher/watch/{watch_id}/_deactivate" + "path": "/_transform/{transform_id}" + }, + { + "methods": [ + "GET" + ], + "path": "/_transform" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Removes a watch from Watcher.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", - "name": "watcher.delete_watch", + "description": "Retrieves usage information for transforms.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", + "name": "transform.get_transform_stats", + "privileges": { + "cluster": [ + "monitor_transform" + ], + "index": [ + "read", + "view_index_metadata" + ] + }, "request": { "name": "Request", - "namespace": "watcher.delete_watch" + "namespace": "transform.get_transform_stats" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "watcher.delete_watch" + "namespace": "transform.get_transform_stats" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ - "DELETE" + "GET" ], - "path": "/_watcher/watch/{id}" + "path": "/_transform/{transform_id}/_stats" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.2.0", "stability": "stable" } }, - "description": "Forces the execution of a stored watch.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", - "name": "watcher.execute_watch", + "description": "Previews a transform.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", + "name": "transform.preview_transform", "privileges": { "cluster": [ - "manage_watcher" + "manage_transform" + ], + "index": [ + "read", + "view_index_metadata" ] }, "request": { "name": "Request", - "namespace": "watcher.execute_watch" + "namespace": "transform.preview_transform" }, "requestBodyRequired": false, "requestMediaType": [ @@ -19229,108 +19329,148 @@ ], "response": { "name": "Response", - "namespace": "watcher.execute_watch" + "namespace": "transform.preview_transform" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.2.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", + "GET", "POST" ], - "path": "/_watcher/watch/{id}/_execute" + "path": "/_transform/{transform_id}/_preview" }, { "methods": [ - "PUT", + "GET", "POST" ], - "path": "/_watcher/watch/_execute" + "path": "/_transform/_preview" } ], "visibility": "public" }, { "availability": { - "stack": { + "serverless": { "stability": "stable", "visibility": "public" + }, + "stack": { + "since": "7.2.0", + "stability": "stable" } }, - "description": "Retrieve settings for the watcher system index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html", - "name": "watcher.get_settings", - "request": null, - "requestBodyRequired": false, + "description": "Instantiates a transform.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", + "name": "transform.put_transform", + "privileges": { + "cluster": [ + "manage_transform" + ], + "index": [ + "create_index", + "read", + "index", + "view_index_metadata" + ] + }, + "request": { + "name": "Request", + "namespace": "transform.put_transform" + }, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": null, + "response": { + "name": "Response", + "namespace": "transform.put_transform" + }, "responseMediaType": [ "application/json" ], + "since": "7.2.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "PUT" ], - "path": "/_watcher/settings" + "path": "/_transform/{transform_id}" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "5.6.0", + "since": "8.1.0", "stability": "stable" } }, - "description": "Retrieves a watch by its ID.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", - "name": "watcher.get_watch", + "description": "Resets an existing transform.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", + "name": "transform.reset_transform", + "privileges": { + "cluster": [ + "manage_transform" + ] + }, "request": { "name": "Request", - "namespace": "watcher.get_watch" + "namespace": "transform.reset_transform" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "watcher.get_watch" + "namespace": "transform.reset_transform" }, "responseMediaType": [ "application/json" ], - "since": "5.6.0", + "since": "8.1.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_watcher/watch/{id}" + "path": "/_transform/{transform_id}/_reset" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "8.7.0", "stability": "stable" } }, - "description": "Creates a new watch, or updates an existing one.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", - "name": "watcher.put_watch", + "description": "Schedules now a transform.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", + "name": "transform.schedule_now_transform", + "privileges": { + "cluster": [ + "manage_transform" + ] + }, "request": { "name": "Request", - "namespace": "watcher.put_watch" + "namespace": "transform.schedule_now_transform" }, "requestBodyRequired": false, "requestMediaType": [ @@ -19338,196 +19478,247 @@ ], "response": { "name": "Response", - "namespace": "watcher.put_watch" + "namespace": "transform.schedule_now_transform" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "8.7.0", "stability": "stable", "urls": [ { "methods": [ - "PUT", "POST" ], - "path": "/_watcher/watch/{id}" + "path": "/_transform/{transform_id}/_schedule_now" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "7.11.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Retrieves stored watches.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", - "name": "watcher.query_watches", + "description": "Starts one or more transforms.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", + "name": "transform.start_transform", + "privileges": { + "cluster": [ + "manage_transform" + ], + "index": [ + "read", + "view_index_metadata" + ] + }, "request": { "name": "Request", - "namespace": "watcher.query_watches" + "namespace": "transform.start_transform" }, "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], "response": { "name": "Response", - "namespace": "watcher.query_watches" + "namespace": "transform.start_transform" }, "responseMediaType": [ "application/json" ], - "since": "7.11.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET", "POST" ], - "path": "/_watcher/_query/watches" + "path": "/_transform/{transform_id}/_start" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "0.0.0", + "since": "7.5.0", "stability": "stable" } }, - "description": "Starts Watcher if it is not already running.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", - "name": "watcher.start", + "description": "Stops one or more transforms.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", + "name": "transform.stop_transform", + "privileges": { + "cluster": [ + "manage_transform" + ] + }, "request": { "name": "Request", - "namespace": "watcher.start" + "namespace": "transform.stop_transform" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "watcher.start" + "namespace": "transform.stop_transform" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.5.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_watcher/_start" + "path": "/_transform/{transform_id}/_stop" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, "stack": { - "since": "5.5.0", + "since": "7.2.0", "stability": "stable" } }, - "description": "Retrieves the current Watcher metrics.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", - "name": "watcher.stats", + "description": "Updates certain properties of a transform.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", + "name": "transform.update_transform", + "privileges": { + "cluster": [ + "manage_transform" + ], + "index": [ + "read", + "index", + "view_index_metadata" + ] + }, "request": { "name": "Request", - "namespace": "watcher.stats" + "namespace": "transform.update_transform" }, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "watcher.stats" + "namespace": "transform.update_transform" }, "responseMediaType": [ "application/json" ], - "since": "5.5.0", + "since": "7.2.0", "stability": "stable", "urls": [ { "methods": [ - "GET" - ], - "path": "/_watcher/stats" - }, - { - "methods": [ - "GET" + "POST" ], - "path": "/_watcher/stats/{metric}" + "path": "/_transform/{transform_id}/_update" } ], "visibility": "public" }, { "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, "stack": { - "since": "0.0.0", + "since": "7.16.0", "stability": "stable" } }, - "description": "Stops Watcher if it is running.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", - "name": "watcher.stop", + "description": "Upgrades all transforms.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", + "name": "transform.upgrade_transforms", + "privileges": { + "cluster": [ + "manage_transform" + ] + }, "request": { "name": "Request", - "namespace": "watcher.stop" + "namespace": "transform.upgrade_transforms" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "watcher.stop" + "namespace": "transform.upgrade_transforms" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "7.16.0", "stability": "stable", "urls": [ { "methods": [ "POST" ], - "path": "/_watcher/_stop" + "path": "/_transform/_upgrade" } ], "visibility": "public" }, { "availability": { - "stack": { + "serverless": { "stability": "stable", "visibility": "public" + }, + "stack": { + "since": "0.0.0", + "stability": "stable" } }, - "description": "Update settings for the watcher system index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html", - "name": "watcher.update_settings", - "request": null, + "description": "Updates a document with a script or partial document.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", + "name": "update", + "request": { + "name": "Request", + "namespace": "_global.update" + }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": null, + "response": { + "name": "Response", + "namespace": "_global.update" + }, "responseMediaType": [ "application/json" ], + "since": "0.0.0", "stability": "stable", "urls": [ { "methods": [ - "PUT" + "POST" ], - "path": "/_watcher/settings" + "path": "/{index}/_update/{id}" } ], "visibility": "public" @@ -19536,42 +19727,39 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "private" + "visibility": "public" }, "stack": { - "since": "0.0.0", + "since": "2.4.0", "stability": "stable" } }, - "description": "Retrieves information about the installed X-Pack features.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", - "name": "xpack.info", - "privileges": { - "cluster": [ - "monitor", - "manage" - ] - }, + "description": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", + "name": "update_by_query", "request": { "name": "Request", - "namespace": "xpack.info" + "namespace": "_global.update_by_query" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "xpack.info" + "namespace": "_global.update_by_query" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "2.4.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_xpack" + "path": "/{index}/_update_by_query" } ], "visibility": "public" @@ -19583,624 +19771,1180 @@ "visibility": "private" }, "stack": { - "since": "0.0.0", + "since": "6.5.0", "stability": "stable" } }, - "description": "Retrieves usage information about the installed X-Pack features.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", - "name": "xpack.usage", - "privileges": { - "cluster": [ - "monitor", - "manage" - ] - }, + "description": "Changes the number of requests per second for a particular Update By Query operation.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", + "name": "update_by_query_rethrottle", "request": { "name": "Request", - "namespace": "xpack.usage" + "namespace": "_global.update_by_query_rethrottle" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "xpack.usage" + "namespace": "_global.update_by_query_rethrottle" }, "responseMediaType": [ "application/json" ], - "since": "0.0.0", + "since": "6.5.0", "stability": "stable", "urls": [ { "methods": [ - "GET" + "POST" ], - "path": "/_xpack/usage" + "path": "/_update_by_query/{task_id}/_rethrottle" } ], "visibility": "public" - } - ], - "types": [ - { - "inherits": { - "type": { - "name": "WriteOperation", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "CreateOperation", - "namespace": "_global.bulk" - }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L130-L130" }, { - "inherits": { - "type": { - "name": "OperationBase", - "namespace": "_global.bulk" + "availability": { + "stack": { + "since": "0.0.0", + "stability": "stable" } }, - "kind": "interface", - "name": { - "name": "DeleteOperation", - "namespace": "_global.bulk" - }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L134-L134" + "description": "Acknowledges a watch, manually throttling the execution of the watch's actions.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", + "name": "watcher.ack_watch", + "request": { + "name": "Request", + "namespace": "watcher.ack_watch" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "watcher.ack_watch" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "PUT", + "POST" + ], + "path": "/_watcher/watch/{watch_id}/_ack" + }, + { + "methods": [ + "PUT", + "POST" + ], + "path": "/_watcher/watch/{watch_id}/_ack/{action_id}" + } + ], + "visibility": "public" }, { - "inherits": { - "type": { - "name": "WriteOperation", - "namespace": "_global.bulk" + "availability": { + "stack": { + "since": "0.0.0", + "stability": "stable" } }, - "kind": "interface", - "name": { - "name": "IndexOperation", - "namespace": "_global.bulk" + "description": "Activates a currently inactive watch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", + "name": "watcher.activate_watch", + "request": { + "name": "Request", + "namespace": "watcher.activate_watch" }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L132-L132" + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "watcher.activate_watch" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "PUT", + "POST" + ], + "path": "/_watcher/watch/{watch_id}/_activate" + } + ], + "visibility": "public" }, { - "kind": "interface", - "name": { - "name": "OperationBase", - "namespace": "_global.bulk" + "availability": { + "stack": { + "since": "0.0.0", + "stability": "stable" + } }, - "properties": [ - { - "description": "The document ID.", - "name": "_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "Name of the index or index alias to perform the action on.", - "name": "_index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "description": "Custom value used to route operations to a specific shard.", - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } - } - }, - { - "name": "if_primary_term", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "if_seq_no", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SequenceNumber", - "namespace": "_types" - } - } - }, - { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, + "description": "Deactivates a currently active watch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", + "name": "watcher.deactivate_watch", + "request": { + "name": "Request", + "namespace": "watcher.deactivate_watch" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "watcher.deactivate_watch" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ { - "name": "version_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionType", - "namespace": "_types" - } - } + "methods": [ + "PUT", + "POST" + ], + "path": "/_watcher/watch/{watch_id}/_deactivate" } ], - "specLocation": "_global/bulk/types.ts#L90-L107" + "visibility": "public" }, { - "kind": "interface", - "name": { - "name": "OperationContainer", - "namespace": "_global.bulk" + "availability": { + "stack": { + "since": "0.0.0", + "stability": "stable" + } }, - "properties": [ - { - "description": "Indexes the specified document.\nIf the document exists, replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexOperation", - "namespace": "_global.bulk" - } - } - }, - { - "description": "Indexes the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", - "name": "create", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CreateOperation", - "namespace": "_global.bulk" - } - } - }, - { - "description": "Performs a partial document update.\nThe following line must contain the partial document and update options.", - "name": "update", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "UpdateOperation", - "namespace": "_global.bulk" - } - } - }, + "description": "Removes a watch from Watcher.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", + "name": "watcher.delete_watch", + "request": { + "name": "Request", + "namespace": "watcher.delete_watch" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "watcher.delete_watch" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ { - "description": "Removes the specified document from the index.", - "name": "delete", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DeleteOperation", - "namespace": "_global.bulk" - } - } + "methods": [ + "DELETE" + ], + "path": "/_watcher/watch/{id}" } ], - "specLocation": "_global/bulk/types.ts#L145-L167", - "variants": { - "kind": "container" - } + "visibility": "public" }, { - "kind": "enum", - "members": [ - { - "name": "index" - }, - { - "name": "create" - }, + "availability": { + "stack": { + "since": "0.0.0", + "stability": "stable" + } + }, + "description": "Forces the execution of a stored watch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", + "name": "watcher.execute_watch", + "privileges": { + "cluster": [ + "manage_watcher" + ] + }, + "request": { + "name": "Request", + "namespace": "watcher.execute_watch" + }, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "watcher.execute_watch" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ { - "name": "update" + "methods": [ + "PUT", + "POST" + ], + "path": "/_watcher/watch/{id}/_execute" }, { - "name": "delete" + "methods": [ + "PUT", + "POST" + ], + "path": "/_watcher/watch/_execute" } ], - "name": { - "name": "OperationType", - "namespace": "_global.bulk" - }, - "specLocation": "_global/bulk/types.ts#L83-L88" + "visibility": "public" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "codegenName": "operations", - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "OperationContainer", - "namespace": "_global.bulk" - } - }, - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.bulk" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TPartialDocument", - "namespace": "_global.bulk" - } - } - ], - "kind": "instance_of", - "type": { - "name": "UpdateAction", - "namespace": "_global.bulk" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.bulk" - } - } - ], - "kind": "union_of" - } + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" } }, - "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", - "generics": [ - { - "name": "TDocument", - "namespace": "_global.bulk" - }, + "description": "Retrieve settings for the watcher system index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html", + "name": "watcher.get_settings", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ { - "name": "TPartialDocument", - "namespace": "_global.bulk" + "methods": [ + "GET" + ], + "path": "/_watcher/settings" } ], - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" + "visibility": "public" + }, + { + "availability": { + "stack": { + "since": "5.6.0", + "stability": "stable" } }, - "kind": "request", - "name": { + "description": "Retrieves a watch by its ID.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", + "name": "watcher.get_watch", + "request": { "name": "Request", - "namespace": "_global.bulk" + "namespace": "watcher.get_watch" }, - "path": [ + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "watcher.get_watch" + }, + "responseMediaType": [ + "application/json" + ], + "since": "5.6.0", + "stability": "stable", + "urls": [ { - "description": "Name of the data stream, index, or index alias to perform bulk actions on.", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } + "methods": [ + "GET" + ], + "path": "/_watcher/watch/{id}" } ], - "query": [ - { - "description": "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.", - "name": "pipeline", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, Elasticsearch refreshes 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` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", - "name": "refresh", - "required": false, - "serverDefault": "false", - "type": { - "kind": "instance_of", - "type": { - "name": "Refresh", - "namespace": "_types" - } - } - }, + "visibility": "public" + }, + { + "availability": { + "stack": { + "since": "0.0.0", + "stability": "stable" + } + }, + "description": "Creates a new watch, or updates an existing one.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", + "name": "watcher.put_watch", + "request": { + "name": "Request", + "namespace": "watcher.put_watch" + }, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "watcher.put_watch" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ { - "description": "Custom value used to route operations to a specific shard.", - "name": "routing", - "required": false, + "methods": [ + "PUT", + "POST" + ], + "path": "/_watcher/watch/{id}" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "since": "7.11.0", + "stability": "stable" + } + }, + "description": "Retrieves stored watches.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", + "name": "watcher.query_watches", + "request": { + "name": "Request", + "namespace": "watcher.query_watches" + }, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "watcher.query_watches" + }, + "responseMediaType": [ + "application/json" + ], + "since": "7.11.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "GET", + "POST" + ], + "path": "/_watcher/_query/watches" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "since": "0.0.0", + "stability": "stable" + } + }, + "description": "Starts Watcher if it is not already running.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", + "name": "watcher.start", + "request": { + "name": "Request", + "namespace": "watcher.start" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "watcher.start" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_watcher/_start" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "since": "5.5.0", + "stability": "stable" + } + }, + "description": "Retrieves the current Watcher metrics.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", + "name": "watcher.stats", + "request": { + "name": "Request", + "namespace": "watcher.stats" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "watcher.stats" + }, + "responseMediaType": [ + "application/json" + ], + "since": "5.5.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_watcher/stats" + }, + { + "methods": [ + "GET" + ], + "path": "/_watcher/stats/{metric}" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "since": "0.0.0", + "stability": "stable" + } + }, + "description": "Stops Watcher if it is running.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", + "name": "watcher.stop", + "request": { + "name": "Request", + "namespace": "watcher.stop" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "watcher.stop" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_watcher/_stop" + } + ], + "visibility": "public" + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Update settings for the watcher system index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html", + "name": "watcher.update_settings", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_watcher/settings" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, + "stack": { + "since": "0.0.0", + "stability": "stable" + } + }, + "description": "Retrieves information about the installed X-Pack features.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", + "name": "xpack.info", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, + "request": { + "name": "Request", + "namespace": "xpack.info" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "xpack.info" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_xpack" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "private" + }, + "stack": { + "since": "0.0.0", + "stability": "stable" + } + }, + "description": "Retrieves usage information about the installed X-Pack features.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", + "name": "xpack.usage", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, + "request": { + "name": "Request", + "namespace": "xpack.usage" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "xpack.usage" + }, + "responseMediaType": [ + "application/json" + ], + "since": "0.0.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_xpack/usage" + } + ], + "visibility": "public" + } + ], + "types": [ + { + "inherits": { + "type": { + "name": "WriteOperation", + "namespace": "_global.bulk" + } + }, + "kind": "interface", + "name": { + "name": "CreateOperation", + "namespace": "_global.bulk" + }, + "properties": [], + "specLocation": "_global/bulk/types.ts#L130-L130" + }, + { + "inherits": { + "type": { + "name": "OperationBase", + "namespace": "_global.bulk" + } + }, + "kind": "interface", + "name": { + "name": "DeleteOperation", + "namespace": "_global.bulk" + }, + "properties": [], + "specLocation": "_global/bulk/types.ts#L134-L134" + }, + { + "inherits": { + "type": { + "name": "WriteOperation", + "namespace": "_global.bulk" + } + }, + "kind": "interface", + "name": { + "name": "IndexOperation", + "namespace": "_global.bulk" + }, + "properties": [], + "specLocation": "_global/bulk/types.ts#L132-L132" + }, + { + "kind": "interface", + "name": { + "name": "OperationBase", + "namespace": "_global.bulk" + }, + "properties": [ + { + "description": "The document ID.", + "name": "_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "Id", "namespace": "_types" } } }, { - "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", - "name": "_source", + "description": "Name of the index or index alias to perform the action on.", + "name": "_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SourceConfigParam", - "namespace": "_global.search._types" + "name": "IndexName", + "namespace": "_types" } } }, { - "description": "A comma-separated list of source fields to exclude from the response.", - "name": "_source_excludes", + "description": "Custom value used to route operations to a specific shard.", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Routing", "namespace": "_types" } } }, { - "description": "A comma-separated list of source fields to include in the response.", - "name": "_source_includes", + "name": "if_primary_term", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "long", "namespace": "_types" } } }, { - "description": "Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", - "name": "timeout", + "name": "if_seq_no", "required": false, - "serverDefault": "1m", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "SequenceNumber", "namespace": "_types" } } }, { - "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`).", - "name": "wait_for_active_shards", + "name": "version", "required": false, - "serverDefault": "1", "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", + "name": "VersionNumber", "namespace": "_types" } } }, { - "description": "If `true`, the request’s actions must target an index alias.", - "name": "require_alias", + "name": "version_type", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "VersionType", + "namespace": "_types" } } } ], - "specLocation": "_global/bulk/BulkRequest.ts#L32-L103" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "errors", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "items", - "required": true, - "type": { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "OperationType", - "namespace": "_global.bulk" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "ResponseItem", - "namespace": "_global.bulk" - } - } - } - } - }, - { - "name": "took", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "ingest_took", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "_global.bulk" - }, - "specLocation": "_global/bulk/BulkResponse.ts#L24-L31" + "specLocation": "_global/bulk/types.ts#L90-L107" }, { "kind": "interface", "name": { - "name": "ResponseItem", + "name": "OperationContainer", "namespace": "_global.bulk" }, "properties": [ { - "description": "The document ID associated with the operation.", - "name": "_id", + "description": "Indexes the specified document.\nIf the document exists, replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", + "name": "index", "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "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.", - "name": "_index", - "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexOperation", + "namespace": "_global.bulk" } } }, { - "description": "HTTP status code returned for the operation.", - "name": "status", - "required": true, + "description": "Indexes the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", + "name": "create", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "CreateOperation", + "namespace": "_global.bulk" } } }, { - "description": "Contains additional information about the failed operation.\nThe parameter is only returned for failed operations.", - "name": "error", + "description": "Performs a partial document update.\nThe following line must contain the partial document and update options.", + "name": "update", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", - "namespace": "_types" + "name": "UpdateOperation", + "namespace": "_global.bulk" } } }, { - "description": "The primary term assigned to the document for the operation.", - "name": "_primary_term", + "description": "Removes the specified document from the index.", + "name": "delete", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DeleteOperation", + "namespace": "_global.bulk" } } - }, - { - "description": "Result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", - "name": "result", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "_global/bulk/types.ts#L145-L167", + "variants": { + "kind": "container" + } + }, + { + "kind": "enum", + "members": [ + { + "name": "index" + }, + { + "name": "create" + }, + { + "name": "update" + }, + { + "name": "delete" + } + ], + "name": { + "name": "OperationType", + "namespace": "_global.bulk" + }, + "specLocation": "_global/bulk/types.ts#L83-L88" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "codegenName": "operations", + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "OperationContainer", + "namespace": "_global.bulk" + } + }, + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.bulk" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TPartialDocument", + "namespace": "_global.bulk" + } + } + ], + "kind": "instance_of", + "type": { + "name": "UpdateAction", + "namespace": "_global.bulk" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.bulk" + } + } + ], + "kind": "union_of" + } + } + }, + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", + "generics": [ + { + "name": "TDocument", + "namespace": "_global.bulk" + }, + { + "name": "TPartialDocument", + "namespace": "_global.bulk" + } + ], + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.bulk" + }, + "path": [ + { + "description": "Name of the data stream, index, or index alias to perform bulk actions on.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "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.", + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, Elasticsearch refreshes 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` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", + "name": "refresh", + "required": false, + "serverDefault": "false", + "type": { + "kind": "instance_of", + "type": { + "name": "Refresh", + "namespace": "_types" + } + } + }, + { + "description": "Custom value used to route operations to a specific shard.", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } + } + }, + { + "description": "A comma-separated list of source fields to exclude from the response.", + "name": "_source_excludes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of source fields to include in the response.", + "name": "_source_includes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", + "name": "timeout", + "required": false, + "serverDefault": "1m", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "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`).", + "name": "wait_for_active_shards", + "required": false, + "serverDefault": "1", + "type": { + "kind": "instance_of", + "type": { + "name": "WaitForActiveShards", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, the request’s actions must target an index alias.", + "name": "require_alias", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_global/bulk/BulkRequest.ts#L32-L103" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "errors", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "items", + "required": true, + "type": { + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "OperationType", + "namespace": "_global.bulk" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "ResponseItem", + "namespace": "_global.bulk" + } + } + } + } + }, + { + "name": "took", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "ingest_took", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.bulk" + }, + "specLocation": "_global/bulk/BulkResponse.ts#L24-L31" + }, + { + "kind": "interface", + "name": { + "name": "ResponseItem", + "namespace": "_global.bulk" + }, + "properties": [ + { + "description": "The document ID associated with the operation.", + "name": "_id", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "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.", + "name": "_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "HTTP status code returned for the operation.", + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Contains additional information about the failed operation.\nThe parameter is only returned for failed operations.", + "name": "error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } + } + }, + { + "description": "The primary term assigned to the document for the operation.", + "name": "_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", + "name": "result", + "required": false, + "type": { + "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" @@ -40423,6 +41167,22 @@ ], "specLocation": "_spec_utils/BaseNode.ts#L25-L32" }, + { + "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.", + "kind": "type_alias", + "name": { + "name": "NullValue", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/utils.ts#L22-L27", + "type": { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + }, { "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.", "generics": [ @@ -40507,6 +41267,40 @@ } } }, + { + "description": "`WithNullValue` allows for explicit null assignments in contexts where `null` should be interpreted as an\nactual value.", + "generics": [ + { + "name": "T", + "namespace": "_spec_utils" + } + ], + "kind": "type_alias", + "name": { + "name": "WithNullValue", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/utils.ts#L29-L33", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_spec_utils" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NullValue", + "namespace": "_spec_utils" + } + } + ], + "kind": "union_of" + } + }, { "kind": "interface", "name": { @@ -81541,444 +82335,2406 @@ } }, { - "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", - "name": "pit", - "required": false, + "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", + "name": "pit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "PointInTimeReference", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "name": "runtime_mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "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.", + "name": "stats", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ] + }, + "description": "Runs a search request asynchronously.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "async_search.submit" + }, + "path": [ + { + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "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.", + "name": "wait_for_completion_timeout", + "required": false, + "serverDefault": "1s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.", + "name": "keep_on_completion", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", + "name": "keep_alive", + "required": false, + "serverDefault": "5d", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Indicate if an error should be returned if there is a partial search failure or timeout", + "name": "allow_partial_search_results", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The analyzer to use for the query string", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", + "name": "analyze_wildcard", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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).", + "name": "batched_reduce_size", + "required": false, + "serverDefault": 5, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The default value is the only supported value.", + "name": "ccs_minimize_roundtrips", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The default operator for query string query (AND or OR)", + "name": "default_operator", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Operator", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "The field to use as default where no field prefix is given in the query string", + "name": "df", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit", + "name": "docvalue_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Specify whether to return detailed information about score computation as part of a hit", + "name": "explain", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", + "name": "ignore_throttled", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", + "name": "lenient", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", + "name": "max_concurrent_shard_requests", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "min_compatible_shard_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + }, + { + "description": "Specify the node or shard the operation should be performed on (default: random)", + "name": "preference", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.", + "name": "pre_filter_shard_size", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Specify if request cache should be used for this request or not, defaults to true", + "name": "request_cache", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "A comma-separated list of specific routing values", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "name": "scroll", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Search operation type", + "name": "search_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SearchType", + "namespace": "_types" + } + } + }, + { + "description": "Specific 'tag' of the request for logging and statistical purposes", + "name": "stats", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "A comma-separated list of stored fields to return as part of a hit", + "name": "stored_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Specifies which field to use for suggestions.", + "name": "suggest_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Specify suggest mode", + "name": "suggest_mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SuggestMode", + "namespace": "_types" + } + } + }, + { + "description": "How many suggestions to return in response", + "name": "suggest_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The source text for which the suggestions should be returned.", + "name": "suggest_text", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "name": "terminate_after", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.", + "name": "track_total_hits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TrackHits", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Whether to calculate and return scores even if they are not used for sorting", + "name": "track_scores", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "name": "typed_keys", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "rest_total_hits_as_int", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify whether to return document version as part of a hit", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "True or false to return the _source field or not, or a list of fields to return", + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } + } + }, + { + "description": "A list of fields to exclude from the returned _source field", + "name": "_source_excludes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "A list of fields to extract and return from the _source field", + "name": "_source_includes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Specify whether to return sequence number and primary term of the last modification of each hit", + "name": "seq_no_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Query in the Lucene query string syntax", + "name": "q", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Number of hits to return (default: 10)", + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Starting offset (default: 0)", + "name": "from", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of : pairs", + "name": "sort", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L286" + }, + { + "body": { + "kind": "value", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "async_search.submit" + } + } + ], + "kind": "instance_of", + "type": { + "name": "AsyncSearchDocumentResponseBase", + "namespace": "async_search._types" + } + } + }, + "generics": [ + { + "name": "TDocument", + "namespace": "async_search.submit" + } + ], + "kind": "response", + "name": { + "name": "Response", + "namespace": "async_search.submit" + }, + "specLocation": "async_search/submit/AsyncSearchSubmitResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingPolicy", + "namespace": "autoscaling._types" + }, + "properties": [ + { + "name": "roles", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Decider settings", + "name": "deciders", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ], + "specLocation": "autoscaling/_types/AutoscalingPolicy.ts#L23-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "autoscaling.delete_autoscaling_policy" + }, + "path": [ + { + "description": "the name of the autoscaling policy", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "autoscaling.delete_autoscaling_policy" + }, + "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingCapacity", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ + { + "name": "node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AutoscalingResources", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } + }, + { + "name": "total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AutoscalingResources", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L38-L41" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingDecider", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ + { + "name": "required_capacity", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AutoscalingCapacity", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } + }, + { + "name": "reason_summary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "reason_details", + "required": false, + "type": { + "kind": "user_defined_value" + } + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L52-L56" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingDeciders", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ + { + "name": "required_capacity", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AutoscalingCapacity", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } + }, + { + "name": "current_capacity", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AutoscalingCapacity", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } + }, + { + "name": "current_nodes", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingNode", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } + } + }, + { + "name": "deciders", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingDecider", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } + } + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L31-L36" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingNode", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeName", + "namespace": "_types" + } + } + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L48-L50" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingResources", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ + { + "name": "storage", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "memory", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L43-L46" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "path": [], + "query": [], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "policies", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingDeciders", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L25-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "autoscaling.get_autoscaling_policy" + }, + "path": [ + { + "description": "the name of the autoscaling policy", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingPolicy", + "namespace": "autoscaling._types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "autoscaling.get_autoscaling_policy" + }, + "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "codegenName": "policy", + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingPolicy", + "namespace": "autoscaling._types" + } + } + }, + "description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "autoscaling.put_autoscaling_policy" + }, + "path": [ + { + "description": "the name of the autoscaling policy", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L24-L35" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "autoscaling.put_autoscaling_policy" + }, + "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyResponse.ts#L22-L24" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "ae" + ], + "description": "For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.", + "name": "assignment_explanation" + }, + { + "aliases": [ + "bc", + "bucketsCount" + ], + "description": "The number of bucket results produced by the job.", + "name": "buckets.count" + }, + { + "aliases": [ + "btea", + "bucketsTimeExpAvg" + ], + "description": "Exponential moving average of all bucket processing times, in milliseconds.", + "name": "buckets.time.exp_avg" + }, + { + "aliases": [ + "bteah", + "bucketsTimeExpAvgHour" + ], + "description": "Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.", + "name": "buckets.time.exp_avg_hour" + }, + { + "aliases": [ + "btmax", + "bucketsTimeMax" + ], + "description": "Maximum among all bucket processing times, in milliseconds.", + "name": "buckets.time.max" + }, + { + "aliases": [ + "btmin", + "bucketsTimeMin" + ], + "description": "Minimum among all bucket processing times, in milliseconds.", + "name": "buckets.time.min" + }, + { + "aliases": [ + "btt", + "bucketsTimeTotal" + ], + "description": "Sum of all bucket processing times, in milliseconds.", + "name": "buckets.time.total" + }, + { + "aliases": [ + "db", + "dataBuckets" + ], + "description": "The number of buckets processed.", + "name": "data.buckets" + }, + { + "aliases": [ + "der", + "dataEarliestRecord" + ], + "description": "The timestamp of the earliest chronologically input document.", + "name": "data.earliest_record" + }, + { + "aliases": [ + "deb", + "dataEmptyBuckets" + ], + "description": "The number of buckets which did not contain any data.", + "name": "data.empty_buckets" + }, + { + "aliases": [ + "dib", + "dataInputBytes" + ], + "description": "The number of bytes of input data posted to the anomaly detection job.", + "name": "data.input_bytes" + }, + { + "aliases": [ + "dif", + "dataInputFields" + ], + "description": "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.", + "name": "data.input_fields" + }, + { + "aliases": [ + "dir", + "dataInputRecords" + ], + "description": "The number of input documents posted to the anomaly detection job.", + "name": "data.input_records" + }, + { + "aliases": [ + "did", + "dataInvalidDates" + ], + "description": "The number of input documents with either a missing date field or a date\nthat could not be parsed.", + "name": "data.invalid_dates" + }, + { + "aliases": [ + "dl", + "dataLast" + ], + "description": "The timestamp at which data was last analyzed, according to server time.", + "name": "data.last" + }, + { + "aliases": [ + "dleb", + "dataLastEmptyBucket" + ], + "description": "The timestamp of the last bucket that did not contain any data.", + "name": "data.last_empty_bucket" + }, + { + "aliases": [ + "dlsb", + "dataLastSparseBucket" + ], + "description": "The timestamp of the last bucket that was considered sparse.", + "name": "data.last_sparse_bucket" + }, + { + "aliases": [ + "dlr", + "dataLatestRecord" + ], + "description": "The timestamp of the latest chronologically input document.", + "name": "data.latest_record" + }, + { + "aliases": [ + "dmf", + "dataMissingFields" + ], + "description": "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.", + "name": "data.missing_fields" + }, + { + "aliases": [ + "doot", + "dataOutOfOrderTimestamps" + ], + "description": "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.", + "name": "data.out_of_order_timestamps" + }, + { + "aliases": [ + "dpf", + "dataProcessedFields" + ], + "description": "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.", + "name": "data.processed_fields" + }, + { + "aliases": [ + "dpr", + "dataProcessedRecords" + ], + "description": "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.", + "name": "data.processed_records" + }, + { + "aliases": [ + "dsb", + "dataSparseBuckets" + ], + "description": "The number of buckets that contained few data points compared to the\nexpected number of data points.", + "name": "data.sparse_buckets" + }, + { + "aliases": [ + "fmavg", + "forecastsMemoryAvg" + ], + "description": "The average memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.avg" + }, + { + "aliases": [ + "fmmax", + "forecastsMemoryMax" + ], + "description": "The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.max" + }, + { + "aliases": [ + "fmmin", + "forecastsMemoryMin" + ], + "description": "The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.min" + }, + { + "aliases": [ + "fmt", + "forecastsMemoryTotal" + ], + "description": "The total memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.total" + }, + { + "aliases": [ + "fravg", + "forecastsRecordsAvg" + ], + "description": "The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.avg" + }, + { + "aliases": [ + "frmax", + "forecastsRecordsMax" + ], + "description": "The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.max" + }, + { + "aliases": [ + "frmin", + "forecastsRecordsMin" + ], + "description": "The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.min" + }, + { + "aliases": [ + "frt", + "forecastsRecordsTotal" + ], + "description": "The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.total" + }, + { + "aliases": [ + "ftavg", + "forecastsTimeAvg" + ], + "description": "The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.avg" + }, + { + "aliases": [ + "ftmax", + "forecastsTimeMax" + ], + "description": "The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.max" + }, + { + "aliases": [ + "ftmin", + "forecastsTimeMin" + ], + "description": "The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.min" + }, + { + "aliases": [ + "ftt", + "forecastsTimeTotal" + ], + "description": "The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.total" + }, + { + "aliases": [ + "ft", + "forecastsTotal" + ], + "description": "The number of individual forecasts currently available for the job.", + "name": "forecasts.total" + }, + { + "description": "Identifier for the anomaly detection job.", + "name": "id" + }, + { + "aliases": [ + "mbaf", + "modelBucketAllocationFailures" + ], + "description": "The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.", + "name": "model.bucket_allocation_failures" + }, + { + "aliases": [ + "mbf", + "modelByFields" + ], + "description": "The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.", + "name": "model.by_fields" + }, + { + "aliases": [ + "mb", + "modelBytes" + ], + "description": "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.", + "name": "model.bytes" + }, + { + "aliases": [ + "mbe", + "modelBytesExceeded" + ], + "description": "The number of bytes over the high limit for memory usage at the last\nallocation failure.", + "name": "model.bytes_exceeded" + }, + { + "aliases": [ + "mcs", + "modelCategorizationStatus" + ], + "description": "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.", + "name": "model.categorization_status" + }, + { + "aliases": [ + "mcdc", + "modelCategorizedDocCount" + ], + "description": "The number of documents that have had a field categorized.", + "name": "model.categorized_doc_count" + }, + { + "aliases": [ + "mdcc", + "modelDeadCategoryCount" + ], + "description": "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.", + "name": "model.dead_category_count" + }, + { + "aliases": [ + "mdcc", + "modelFailedCategoryCount" + ], + "description": "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.", + "name": "model.failed_category_count" + }, + { + "aliases": [ + "mfcc", + "modelFrequentCategoryCount" + ], + "description": "The number of categories that match more than 1% of categorized documents.", + "name": "model.frequent_category_count" + }, + { + "aliases": [ + "mlt", + "modelLogTime" + ], + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.log_time" + }, + { + "aliases": [ + "mml", + "modelMemoryLimit" + ], + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.memory_limit" + }, + { + "aliases": [ + "mms", + "modelMemoryStatus" + ], + "description": "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.", + "name": "model.memory_status" + }, + { + "aliases": [ + "mof", + "modelOverFields" + ], + "description": "The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", + "name": "model.over_fields" + }, + { + "aliases": [ + "mpf", + "modelPartitionFields" + ], + "description": "The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", + "name": "model.partition_fields" + }, + { + "aliases": [ + "mrcc", + "modelRareCategoryCount" + ], + "description": "The number of categories that match just one categorized document.", + "name": "model.rare_category_count" + }, + { + "aliases": [ + "mt", + "modelTimestamp" + ], + "description": "The timestamp of the last record when the model stats were gathered.", + "name": "model.timestamp" + }, + { + "aliases": [ + "mtcc", + "modelTotalCategoryCount" + ], + "description": "The number of categories created by categorization.", + "name": "model.total_category_count" + }, + { + "aliases": [ + "na", + "nodeAddress" + ], + "description": "The network address of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.address" + }, + { + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.ephemeral_id" + }, + { + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.id" + }, + { + "aliases": [ + "nn", + "nodeName" + ], + "description": "The name of the node that runs the job. This information is available only\nfor open jobs.", + "name": "node.name" + }, + { + "aliases": [ + "ot" + ], + "description": "For open jobs only, the elapsed time for which the job has been open.", + "name": "opened_time" + }, + { + "aliases": [ + "s" + ], + "description": "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.", + "name": "state" + } + ], + "name": { + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L32-L401" + }, + { + "kind": "type_alias", + "name": { + "name": "CatAnonalyDetectorColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L402-L404", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "assignment_explanation" + ], + "description": "For started datafeeds only, contains messages relating to the selection of\na node.", + "name": "ae" + }, + { + "aliases": [ + "buckets.count", + "bucketsCount" + ], + "description": "The number of buckets processed.", + "name": "bc" + }, + { + "description": "A numerical character string that uniquely identifies the datafeed.", + "name": "id" + }, + { + "aliases": [ + "node.address", + "nodeAddress" + ], + "description": "For started datafeeds only, the network address of the node where the\ndatafeed is started.", + "name": "na" + }, + { + "aliases": [ + "node.ephemeral_id", + "nodeEphemeralId" + ], + "description": "For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.", + "name": "ne" + }, + { + "aliases": [ + "node.id", + "nodeId" + ], + "description": "For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.", + "name": "ni" + }, + { + "aliases": [ + "node.name", + "nodeName" + ], + "description": "For started datafeeds only, the name of the node where the datafeed is\nstarted.", + "name": "nn" + }, + { + "aliases": [ + "search.bucket_avg", + "searchBucketAvg" + ], + "description": "The average search time per bucket, in milliseconds.", + "name": "sba" + }, + { + "aliases": [ + "search.count", + "searchCount" + ], + "description": "The number of searches run by the datafeed.", + "name": "sc" + }, + { + "aliases": [ + "search.exp_avg_hour", + "searchExpAvgHour" + ], + "description": "The exponential average search time per hour, in milliseconds.", + "name": "seah" + }, + { + "aliases": [ + "search.time", + "searchTime" + ], + "description": "The total time the datafeed spent searching, in milliseconds.", + "name": "st" + }, + { + "aliases": [ + "state" + ], + "description": "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.", + "name": "s" + } + ], + "name": { + "name": "CatDatafeedColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L405-L471" + }, + { + "kind": "type_alias", + "name": { + "name": "CatDatafeedColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L559-L559", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CatDatafeedColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatDatafeedColumn", + "namespace": "cat._types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "ae" + ], + "description": "Contains messages relating to the selection of a node.", + "name": "assignment_explanation" + }, + { + "aliases": [ + "ct", + "createTime" + ], + "description": "The time when the data frame analytics job was created.", + "name": "create_time" + }, + { + "aliases": [ + "d" + ], + "description": "A description of a job.", + "name": "description" + }, + { + "aliases": [ + "di", + "destIndex" + ], + "description": "Name of the destination index.", + "name": "dest_index" + }, + { + "aliases": [ + "fr", + "failureReason" + ], + "description": "Contains messages about the reason why a data frame analytics job failed.", + "name": "failure_reason" + }, + { + "description": "Identifier for the data frame analytics job.", + "name": "id" + }, + { + "aliases": [ + "mml", + "modelMemoryLimit" + ], + "description": "The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.", + "name": "model_memory_limit" + }, + { + "aliases": [ + "na", + "nodeAddress" + ], + "description": "The network address of the node that the data frame analytics job is\nassigned to.", + "name": "node.address" + }, + { + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral ID of the node that the data frame analytics job is assigned\nto.", + "name": "node.ephemeral_id" + }, + { + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the node that the data frame analytics job is\nassigned to.", + "name": "node.id" + }, + { + "aliases": [ + "nn", + "nodeName" + ], + "description": "The name of the node that the data frame analytics job is assigned to.", + "name": "node.name" + }, + { + "aliases": [ + "p" + ], + "description": "The progress report of the data frame analytics job by phase.", + "name": "progress" + }, + { + "aliases": [ + "si", + "sourceIndex" + ], + "description": "Name of the source index.", + "name": "source_index" + }, + { + "aliases": [ + "s" + ], + "description": "Current state of the data frame analytics job.", + "name": "state" + }, + { + "aliases": [ + "t" + ], + "description": "The type of analysis that the data frame analytics job performs.", + "name": "type" + }, + { + "aliases": [ + "v" + ], + "description": "The Elasticsearch version number in which the data frame analytics job was\ncreated.", + "name": "version" + } + ], + "name": { + "name": "CatDfaColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L472-L557" + }, + { + "kind": "type_alias", + "name": { + "name": "CatDfaColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L558-L558", + "type": { + "items": [ + { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "PointInTimeReference", - "namespace": "_global.search._types" - } + "name": "CatDfaColumn", + "namespace": "cat._types" } }, { - "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", - "name": "runtime_mappings", - "required": false, - "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - } - } - }, - { - "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.", - "name": "stats", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "CatDfaColumn", + "namespace": "cat._types" } } } - ] - }, - "description": "Runs a search request asynchronously.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + ], + "kind": "union_of" + } + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "behaviors": [ + { + "type": { + "name": "CommonCatQueryParameters", + "namespace": "_spec_utils" + } + } + ], "inherits": { "type": { "name": "RequestBase", "namespace": "_types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "async_search.submit" + "name": "CatRequestBase", + "namespace": "cat._types" }, - "path": [ + "properties": [], + "specLocation": "cat/_types/CatBase.ts#L28-L30" + }, + { + "kind": "enum", + "members": [ { - "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } + "aliases": [ + "ct" + ], + "description": "The time when the trained model was created.", + "name": "create_time" + }, + { + "aliases": [ + "c", + "createdBy" + ], + "description": "Information on the creator of the trained model.", + "name": "created_by" + }, + { + "aliases": [ + "df", + "dataFrameAnalytics", + "dfid" + ], + "description": "Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.", + "name": "data_frame_analytics_id" + }, + { + "aliases": [ + "d" + ], + "description": "The description of the trained model.", + "name": "description" + }, + { + "aliases": [ + "hs", + "modelHeapSize" + ], + "description": "The estimated heap size to keep the trained model in memory.", + "name": "heap_size" + }, + { + "description": "Identifier for the trained model.", + "name": "id" + }, + { + "aliases": [ + "ic", + "ingestCount" + ], + "description": "The total number of documents that are processed by the model.", + "name": "ingest.count" + }, + { + "aliases": [ + "icurr", + "ingestCurrent" + ], + "description": "The total number of document that are currently being handled by the\ntrained model.", + "name": "ingest.current" + }, + { + "aliases": [ + "if", + "ingestFailed" + ], + "description": "The total number of failed ingest attempts with the trained model.", + "name": "ingest.failed" + }, + { + "aliases": [ + "ip", + "ingestPipelines" + ], + "description": "The total number of ingest pipelines that are referencing the trained\nmodel.", + "name": "ingest.pipelines" + }, + { + "aliases": [ + "it", + "ingestTime" + ], + "description": "The total time that is spent processing documents with the trained model.", + "name": "ingest.time" + }, + { + "aliases": [ + "l" + ], + "description": "The license level of the trained model.", + "name": "license" + }, + { + "aliases": [ + "o", + "modelOperations" + ], + "description": "The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.", + "name": "operations" + }, + { + "aliases": [ + "v" + ], + "description": "The Elasticsearch version number in which the trained model was created.", + "name": "version" } ], - "query": [ - { - "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.", - "name": "wait_for_completion_timeout", - "required": false, - "serverDefault": "1s", - "type": { + "name": { + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L561-L635" + }, + { + "kind": "type_alias", + "name": { + "name": "CatTrainedModelsColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L636-L638", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" + } } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "cldt" + ], + "description": "The timestamp when changes were last detected in the source indices.", + "name": "changes_last_detection_time" }, { - "description": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.", - "name": "keep_on_completion", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "cp" + ], + "description": "The sequence number for the checkpoint.", + "name": "checkpoint" }, { - "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", - "name": "keep_alive", - "required": false, - "serverDefault": "5d", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "aliases": [ + "cdtea", + "checkpointTimeExpAvg" + ], + "description": "Exponential moving average of the duration of the checkpoint, in\nmilliseconds.", + "name": "checkpoint_duration_time_exp_avg" }, { - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", - "name": "allow_no_indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "c", + "checkpointProgress" + ], + "description": "The progress of the next checkpoint that is currently in progress.", + "name": "checkpoint_progress" }, { - "description": "Indicate if an error should be returned if there is a partial search failure or timeout", - "name": "allow_partial_search_results", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "ct", + "createTime" + ], + "description": "The time the transform was created.", + "name": "create_time" }, { - "description": "The analyzer to use for the query string", - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "dtime" + ], + "description": "The amount of time spent deleting, in milliseconds.", + "name": "delete_time" }, { - "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", - "name": "analyze_wildcard", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "d" + ], + "description": "The description of the transform.", + "name": "description" }, { - "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).", - "name": "batched_reduce_size", - "required": false, - "serverDefault": 5, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "aliases": [ + "di", + "destIndex" + ], + "description": "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.", + "name": "dest_index" }, { - "description": "The default value is the only supported value.", - "name": "ccs_minimize_roundtrips", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "docd" + ], + "description": "The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.", + "name": "documents_deleted" }, { - "description": "The default operator for query string query (AND or OR)", - "name": "default_operator", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Operator", - "namespace": "_types.query_dsl" - } - } + "aliases": [ + "doci" + ], + "description": "The number of documents that have been indexed into the destination index\nfor the transform.", + "name": "documents_indexed" }, { - "description": "The field to use as default where no field prefix is given in the query string", - "name": "df", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "dps" + ], + "description": "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.", + "name": "docs_per_second" }, { - "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit", - "name": "docvalue_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } + "aliases": [ + "docp" + ], + "description": "The number of documents that have been processed from the source index of\nthe transform.", + "name": "documents_processed" }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } + "aliases": [ + "f" + ], + "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`. The default\nvalue is `1m`.", + "name": "frequency" }, { - "description": "Specify whether to return detailed information about score computation as part of a hit", - "name": "explain", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "description": "Identifier for the transform.", + "name": "id" }, { - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", - "name": "ignore_throttled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "if" + ], + "description": "The number of indexing failures.", + "name": "index_failure" + }, + { + "aliases": [ + "itime" + ], + "description": "The amount of time spent indexing, in milliseconds.", + "name": "index_time" + }, + { + "aliases": [ + "it" + ], + "description": "The number of index operations.", + "name": "index_total" + }, + { + "aliases": [ + "idea" + ], + "description": "Exponential moving average of the number of new documents that have been\nindexed.", + "name": "indexed_documents_exp_avg" }, { - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", - "name": "ignore_unavailable", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "lst", + "lastSearchTime" + ], + "description": "The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.", + "name": "last_search_time" }, { - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", - "name": "lenient", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "mpsz" + ], + "description": "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`.", + "name": "max_page_search_size" }, { - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", - "name": "max_concurrent_shard_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "aliases": [ + "pp" + ], + "description": "The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.", + "name": "pages_processed" }, { - "name": "min_compatible_shard_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } - } + "aliases": [ + "p" + ], + "description": "The unique identifier for an ingest pipeline.", + "name": "pipeline" }, { - "description": "Specify the node or shard the operation should be performed on (default: random)", - "name": "preference", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "pdea" + ], + "description": "Exponential moving average of the number of documents that have been\nprocessed.", + "name": "processed_documents_exp_avg" }, { - "description": "The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.", - "name": "pre_filter_shard_size", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "aliases": [ + "pt" + ], + "description": "The amount of time spent processing results, in milliseconds.", + "name": "processing_time" }, { - "description": "Specify if request cache should be used for this request or not, defaults to true", - "name": "request_cache", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "r" + ], + "description": "If a transform has a `failed` state, this property provides details about\nthe reason for the failure.", + "name": "reason" }, { - "description": "A comma-separated list of specific routing values", - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } - } + "aliases": [ + "sf" + ], + "description": "The number of search failures.", + "name": "search_failure" }, { - "name": "scroll", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "aliases": [ + "stime" + ], + "description": "The amount of time spent searching, in milliseconds.", + "name": "search_time" }, { - "description": "Search operation type", - "name": "search_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SearchType", - "namespace": "_types" - } - } + "aliases": [ + "st" + ], + "description": "The number of search operations on the source index for the transform.", + "name": "search_total" }, { - "description": "Specific 'tag' of the request for logging and statistical purposes", - "name": "stats", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "aliases": [ + "si", + "sourceIndex" + ], + "description": "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.", + "name": "source_index" }, { - "description": "A comma-separated list of stored fields to return as part of a hit", - "name": "stored_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } + "aliases": [ + "s" + ], + "description": "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.", + "name": "state" }, { - "description": "Specifies which field to use for suggestions.", - "name": "suggest_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } + "aliases": [ + "tt" + ], + "description": "Indicates the type of transform: `batch` or `continuous`.", + "name": "transform_type" }, { - "description": "Specify suggest mode", - "name": "suggest_mode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SuggestMode", - "namespace": "_types" - } - } + "aliases": [ + "tc" + ], + "description": "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.", + "name": "trigger_count" }, { - "description": "How many suggestions to return in response", - "name": "suggest_size", - "required": false, - "type": { + "aliases": [ + "v" + ], + "description": "The version of Elasticsearch that existed on the node when the transform\nwas created.", + "name": "version" + } + ], + "name": { + "name": "CatTransformColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L640-L844" + }, + { + "kind": "type_alias", + "name": { + "name": "CatTransformColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L845-L845", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "CatTransformColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatTransformColumn", + "namespace": "cat._types" + } } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "AliasesRecord", + "namespace": "cat.aliases" + }, + "properties": [ { - "description": "The source text for which the suggestions should be returned.", - "name": "suggest_text", + "aliases": [ + "a" + ], + "description": "alias name", + "name": "alias", "required": false, "type": { "kind": "instance_of", @@ -81989,385 +84745,504 @@ } }, { - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "name": "terminate_after", + "aliases": [ + "i", + "idx" + ], + "description": "index alias points to", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "IndexName", "namespace": "_types" } } }, { - "description": "Explicit operation timeout", - "name": "timeout", + "aliases": [ + "f", + "fi" + ], + "description": "filter", + "name": "filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.", - "name": "track_total_hits", + "aliases": [ + "ri", + "routingIndex" + ], + "description": "index routing", + "name": "routing.index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TrackHits", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Whether to calculate and return scores even if they are not used for sorting", - "name": "track_scores", + "aliases": [ + "rs", + "routingSearch" + ], + "description": "search routing", + "name": "routing.search", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", - "name": "typed_keys", + "aliases": [ + "w", + "isWriteIndex" + ], + "description": "write index", + "name": "is_write_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/aliases/types.ts#L22-L53" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.aliases" + }, + "path": [ { - "name": "rest_total_hits_as_int", + "description": "A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Names", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "Specify whether to return document version as part of a hit", - "name": "version", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ExpandWildcards", + "namespace": "_types" } } - }, - { - "description": "True or false to return the _source field or not, or a list of fields to return", - "name": "_source", - "required": false, - "type": { + } + ], + "specLocation": "cat/aliases/CatAliasesRequest.ts#L23-L41" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "SourceConfigParam", - "namespace": "_global.search._types" + "name": "AliasesRecord", + "namespace": "cat.aliases" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.aliases" + }, + "specLocation": "cat/aliases/CatAliasesResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "AllocationRecord", + "namespace": "cat.allocation" + }, + "properties": [ { - "description": "A list of fields to exclude from the returned _source field", - "name": "_source_excludes", + "aliases": [ + "s" + ], + "description": "Number of primary and replica shards assigned to the node.", + "name": "shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "A list of fields to extract and return from the _source field", - "name": "_source_includes", + "aliases": [ + "di", + "diskIndices" + ], + "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.", + "name": "disk.indices", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "Specify whether to return sequence number and primary term of the last modification of each hit", - "name": "seq_no_primary_term", + "aliases": [ + "du", + "diskUsed" + ], + "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.", + "name": "disk.used", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "Query in the Lucene query string syntax", - "name": "q", + "aliases": [ + "da", + "diskAvail" + ], + "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.", + "name": "disk.avail", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "Number of hits to return (default: 10)", - "name": "size", + "aliases": [ + "dt", + "diskTotal" + ], + "description": "Total disk space for the node, including in-use and available space.", + "name": "disk.total", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "Starting offset (default: 0)", - "name": "from", + "aliases": [ + "dp", + "diskPercent" + ], + "description": "Total percentage of disk space in use. Calculated as `disk.used / disk.total`.", + "name": "disk.percent", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Percentage", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "A comma-separated list of : pairs", - "name": "sort", + "aliases": [ + "h" + ], + "description": "Network host for the node. Set using the `network.host` setting.", + "name": "host", "required": false, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Host", + "namespace": "_types" } }, { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } } ], "kind": "union_of" } - } - ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L286" - }, - { - "body": { - "kind": "value", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search.submit" - } - } - ], - "kind": "instance_of", - "type": { - "name": "AsyncSearchDocumentResponseBase", - "namespace": "async_search._types" - } - } - }, - "generics": [ - { - "name": "TDocument", - "namespace": "async_search.submit" - } - ], - "kind": "response", - "name": { - "name": "Response", - "namespace": "async_search.submit" - }, - "specLocation": "async_search/submit/AsyncSearchSubmitResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "AutoscalingPolicy", - "namespace": "autoscaling._types" - }, - "properties": [ + }, { - "name": "roles", - "required": true, + "description": "IP address and port for the node.", + "name": "ip", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Ip", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } - } + ], + "kind": "union_of" } }, { - "description": "Decider settings", - "name": "deciders", - "required": true, + "aliases": [ + "n" + ], + "description": "Name for the node. Set using the `node.name` setting.", + "name": "node", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "autoscaling/_types/AutoscalingPolicy.ts#L23-L27" + "specLocation": "cat/allocation/types.ts#L24-L75" }, { "attachedBehaviors": [ + "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, - "description": "Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Provides a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "CatRequestBase", + "namespace": "cat._types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "autoscaling.delete_autoscaling_policy" + "namespace": "cat.allocation" }, "path": [ { - "description": "the name of the autoscaling policy", - "name": "name", - "required": true, + "description": "Comma-separated list of node identifiers or names used to limit the returned information.", + "name": "node_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "NodeIds", "namespace": "_types" } } } ], - "query": [], - "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L23-L32" + "query": [ + { + "description": "The unit used to display byte values.", + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Bytes", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/allocation/CatAllocationRequest.ts#L23-L41" }, { "body": { "kind": "value", "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AllocationRecord", + "namespace": "cat.allocation" + } } } }, "kind": "response", "name": { "name": "Response", - "namespace": "autoscaling.delete_autoscaling_policy" + "namespace": "cat.allocation" }, - "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyResponse.ts#L22-L24" + "specLocation": "cat/allocation/CatAllocationResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "AutoscalingCapacity", - "namespace": "autoscaling.get_autoscaling_capacity" + "name": "ComponentTemplate", + "namespace": "cat.component_templates" }, "properties": [ { - "name": "node", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AutoscalingResources", - "namespace": "autoscaling.get_autoscaling_capacity" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "total", + "name": "version", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AutoscalingResources", - "namespace": "autoscaling.get_autoscaling_capacity" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L38-L41" - }, - { - "kind": "interface", - "name": { - "name": "AutoscalingDecider", - "namespace": "autoscaling.get_autoscaling_capacity" - }, - "properties": [ + }, { - "name": "required_capacity", + "name": "alias_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AutoscalingCapacity", - "namespace": "autoscaling.get_autoscaling_capacity" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "reason_summary", - "required": false, + "name": "mapping_count", + "required": true, "type": { "kind": "instance_of", "type": { @@ -82377,1570 +85252,2559 @@ } }, { - "name": "reason_details", - "required": false, - "type": { - "kind": "user_defined_value" - } - } - ], - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L52-L56" - }, - { - "kind": "interface", - "name": { - "name": "AutoscalingDeciders", - "namespace": "autoscaling.get_autoscaling_capacity" - }, - "properties": [ - { - "name": "required_capacity", + "name": "settings_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AutoscalingCapacity", - "namespace": "autoscaling.get_autoscaling_capacity" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "current_capacity", + "name": "metadata_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AutoscalingCapacity", - "namespace": "autoscaling.get_autoscaling_capacity" - } - } - }, - { - "name": "current_nodes", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AutoscalingNode", - "namespace": "autoscaling.get_autoscaling_capacity" - } + "name": "string", + "namespace": "_builtins" } } }, { - "name": "deciders", + "name": "included_in", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AutoscalingDecider", - "namespace": "autoscaling.get_autoscaling_capacity" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L31-L36" + "specLocation": "cat/component_templates/types.ts#L20-L28" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", "name": { - "name": "AutoscalingNode", - "namespace": "autoscaling.get_autoscaling_capacity" + "name": "Request", + "namespace": "cat.component_templates" }, - "properties": [ + "path": [ { + "description": "The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.", "name": "name", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L48-L50" + "query": [], + "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L22-L37" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ComponentTemplate", + "namespace": "cat.component_templates" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.component_templates" + }, + "specLocation": "cat/component_templates/CatComponentTemplatesResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "AutoscalingResources", - "namespace": "autoscaling.get_autoscaling_capacity" + "name": "CountRecord", + "namespace": "cat.count" }, "properties": [ { - "name": "storage", - "required": true, + "aliases": [ + "t", + "time" + ], + "description": "seconds since 1970-01-01 00:00:00", + "name": "epoch", + "required": false, "type": { + "generics": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitSeconds", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "memory", - "required": true, + "aliases": [ + "ts", + "hms", + "hhmmss" + ], + "description": "time in HH:MM:SS", + "name": "timestamp", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "TimeOfDay", "namespace": "_types" } } - } - ], - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L43-L46" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "autoscaling.get_autoscaling_capacity" - }, - "path": [], - "query": [], - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L22-L27" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "policies", - "required": true, + }, + { + "aliases": [ + "dc", + "docs.count", + "docsCount" + ], + "description": "the document count", + "name": "count", + "required": false, + "type": { + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AutoscalingDeciders", - "namespace": "autoscaling.get_autoscaling_capacity" - } - } + "name": "string", + "namespace": "_builtins" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "autoscaling.get_autoscaling_capacity" - }, - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L25-L29" + } + ], + "specLocation": "cat/count/types.ts#L23-L39" }, { "attachedBehaviors": [ + "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, - "description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.\nNOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "CatRequestBase", + "namespace": "cat._types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "autoscaling.get_autoscaling_policy" + "namespace": "cat.count" }, "path": [ { - "description": "the name of the autoscaling policy", - "name": "name", - "required": true, + "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`.", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Indices", "namespace": "_types" } } } ], "query": [], - "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L23-L32" + "specLocation": "cat/count/CatCountRequest.ts#L23-L42" }, { "body": { "kind": "value", "value": { - "kind": "instance_of", - "type": { - "name": "AutoscalingPolicy", - "namespace": "autoscaling._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CountRecord", + "namespace": "cat.count" + } } } }, "kind": "response", "name": { "name": "Response", - "namespace": "autoscaling.get_autoscaling_policy" + "namespace": "cat.count" }, - "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts#L22-L24" + "specLocation": "cat/count/CatCountResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "FielddataRecord", + "namespace": "cat.fielddata" + }, + "properties": [ + { + "description": "node id", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "h" + ], + "description": "host name", + "name": "host", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "ip address", + "name": "ip", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "n" + ], + "description": "node name", + "name": "node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "f" + ], + "description": "field name", + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "field data usage", + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/fielddata/types.ts#L20-L48" }, { "attachedBehaviors": [ + "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { - "codegenName": "policy", - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AutoscalingPolicy", - "namespace": "autoscaling._types" - } - } + "kind": "no_body" }, - "description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "CatRequestBase", + "namespace": "cat._types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "autoscaling.put_autoscaling_policy" + "namespace": "cat.fielddata" }, "path": [ { - "description": "the name of the autoscaling policy", - "name": "name", - "required": true, + "description": "Comma-separated list of fields used to limit returned information.\nTo retrieve all fields, omit this parameter.", + "name": "fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Fields", "namespace": "_types" } } } ], - "query": [], - "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L24-L35" + "query": [ + { + "description": "The unit used to display byte values.", + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Bytes", + "namespace": "_types" + } + } + }, + { + "description": "Comma-separated list of fields used to limit returned information.", + "name": "fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L47" }, { "body": { "kind": "value", "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FielddataRecord", + "namespace": "cat.fielddata" + } } } }, "kind": "response", "name": { "name": "Response", - "namespace": "autoscaling.put_autoscaling_policy" + "namespace": "cat.fielddata" }, - "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyResponse.ts#L22-L24" + "specLocation": "cat/fielddata/CatFielddataResponse.ts#L22-L24" }, { - "kind": "enum", - "members": [ - { - "aliases": [ - "ae" - ], - "description": "For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.", - "name": "assignment_explanation" - }, - { - "aliases": [ - "bc", - "bucketsCount" - ], - "description": "The number of bucket results produced by the job.", - "name": "buckets.count" - }, - { - "aliases": [ - "btea", - "bucketsTimeExpAvg" - ], - "description": "Exponential moving average of all bucket processing times, in milliseconds.", - "name": "buckets.time.exp_avg" - }, + "kind": "interface", + "name": { + "name": "HealthRecord", + "namespace": "cat.health" + }, + "properties": [ { "aliases": [ - "bteah", - "bucketsTimeExpAvgHour" + "time" ], - "description": "Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.", - "name": "buckets.time.exp_avg_hour" + "description": "seconds since 1970-01-01 00:00:00", + "name": "epoch", + "required": false, + "type": { + "generics": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitSeconds", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "Stringified", + "namespace": "_spec_utils" + } + } }, { "aliases": [ - "btmax", - "bucketsTimeMax" + "ts", + "hms", + "hhmmss" ], - "description": "Maximum among all bucket processing times, in milliseconds.", - "name": "buckets.time.max" + "description": "time in HH:MM:SS", + "name": "timestamp", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeOfDay", + "namespace": "_types" + } + } }, { "aliases": [ - "btmin", - "bucketsTimeMin" + "cl" ], - "description": "Minimum among all bucket processing times, in milliseconds.", - "name": "buckets.time.min" + "description": "cluster name", + "name": "cluster", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "btt", - "bucketsTimeTotal" + "st" ], - "description": "Sum of all bucket processing times, in milliseconds.", - "name": "buckets.time.total" + "description": "health status", + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "db", - "dataBuckets" + "nt", + "nodeTotal" ], - "description": "The number of buckets processed.", - "name": "data.buckets" + "description": "total number of nodes", + "name": "node.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "der", - "dataEarliestRecord" + "nd", + "nodeData" ], - "description": "The timestamp of the earliest chronologically input document.", - "name": "data.earliest_record" + "description": "number of nodes that can store data", + "name": "node.data", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "deb", - "dataEmptyBuckets" + "t", + "sh", + "shards.total", + "shardsTotal" ], - "description": "The number of buckets which did not contain any data.", - "name": "data.empty_buckets" + "description": "total number of shards", + "name": "shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dib", - "dataInputBytes" + "p", + "shards.primary", + "shardsPrimary" ], - "description": "The number of bytes of input data posted to the anomaly detection job.", - "name": "data.input_bytes" + "description": "number of primary shards", + "name": "pri", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dif", - "dataInputFields" + "r", + "shards.relocating", + "shardsRelocating" ], - "description": "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.", - "name": "data.input_fields" + "description": "number of relocating nodes", + "name": "relo", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dir", - "dataInputRecords" + "i", + "shards.initializing", + "shardsInitializing" ], - "description": "The number of input documents posted to the anomaly detection job.", - "name": "data.input_records" + "description": "number of initializing nodes", + "name": "init", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "did", - "dataInvalidDates" + "u", + "shards.unassigned", + "shardsUnassigned" ], - "description": "The number of input documents with either a missing date field or a date\nthat could not be parsed.", - "name": "data.invalid_dates" + "description": "number of unassigned shards", + "name": "unassign", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dl", - "dataLast" + "pt", + "pendingTasks" ], - "description": "The timestamp at which data was last analyzed, according to server time.", - "name": "data.last" + "description": "number of pending tasks", + "name": "pending_tasks", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dleb", - "dataLastEmptyBucket" + "mtwt", + "maxTaskWaitTime" ], - "description": "The timestamp of the last bucket that did not contain any data.", - "name": "data.last_empty_bucket" + "description": "wait time of longest task pending", + "name": "max_task_wait_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dlsb", - "dataLastSparseBucket" + "asp", + "activeShardsPercent" ], - "description": "The timestamp of the last bucket that was considered sparse.", - "name": "data.last_sparse_bucket" - }, + "description": "active number of shards in percent", + "name": "active_shards_percent", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/health/types.ts#L23-L94" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns the health status of a cluster, similar to the cluster health API.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.health" + }, + "path": [], + "query": [ { - "aliases": [ - "dlr", - "dataLatestRecord" - ], - "description": "The timestamp of the latest chronologically input document.", - "name": "data.latest_record" + "description": "The unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } }, { - "aliases": [ - "dmf", - "dataMissingFields" - ], - "description": "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.", - "name": "data.missing_fields" - }, + "description": "If true, returns `HH:MM:SS` and Unix epoch timestamps.", + "name": "ts", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/health/CatHealthRequest.ts#L23-L52" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "HealthRecord", + "namespace": "cat.health" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.health" + }, + "specLocation": "cat/health/CatHealthResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "HelpRecord", + "namespace": "cat.help" + }, + "properties": [ + { + "name": "endpoint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/help/types.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns help for the Cat APIs.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.help" + }, + "path": [], + "query": [], + "specLocation": "cat/help/CatHelpRequest.ts#L22-L28" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "HelpRecord", + "namespace": "cat.help" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.help" + }, + "specLocation": "cat/help/CatHelpResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "IndicesRecord", + "namespace": "cat.indices" + }, + "properties": [ { "aliases": [ - "doot", - "dataOutOfOrderTimestamps" + "h" ], - "description": "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.", - "name": "data.out_of_order_timestamps" + "description": "current health status", + "name": "health", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dpf", - "dataProcessedFields" + "s" ], - "description": "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.", - "name": "data.processed_fields" + "description": "open/close status", + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dpr", - "dataProcessedRecords" + "i", + "idx" ], - "description": "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.", - "name": "data.processed_records" + "description": "index name", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dsb", - "dataSparseBuckets" + "id" ], - "description": "The number of buckets that contained few data points compared to the\nexpected number of data points.", - "name": "data.sparse_buckets" + "description": "index uuid", + "name": "uuid", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "fmavg", - "forecastsMemoryAvg" + "p", + "shards.primary", + "shardsPrimary" ], - "description": "The average memory usage in bytes for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.memory.avg" + "description": "number of primary shards", + "name": "pri", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "fmmax", - "forecastsMemoryMax" + "r", + "shards.replica", + "shardsReplica" ], - "description": "The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.memory.max" + "description": "number of replica shards", + "name": "rep", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "fmmin", - "forecastsMemoryMin" + "dc", + "docsCount" ], - "description": "The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.memory.min" + "description": "available docs", + "name": "docs.count", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { "aliases": [ - "fmt", - "forecastsMemoryTotal" + "dd", + "docsDeleted" ], - "description": "The total memory usage in bytes for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.memory.total" + "description": "deleted docs", + "name": "docs.deleted", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { "aliases": [ - "fravg", - "forecastsRecordsAvg" + "cd" ], - "description": "The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.", - "name": "forecasts.records.avg" + "description": "index creation date (millisecond value)", + "name": "creation.date", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "frmax", - "forecastsRecordsMax" + "cds" ], - "description": "The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", - "name": "forecasts.records.max" + "description": "index creation date (as string)", + "name": "creation.date.string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "frmin", - "forecastsRecordsMin" + "ss", + "storeSize" ], - "description": "The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", - "name": "forecasts.records.min" + "description": "store size of primaries & replicas", + "name": "store.size", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { - "aliases": [ - "frt", - "forecastsRecordsTotal" - ], - "description": "The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", - "name": "forecasts.records.total" + "description": "store size of primaries", + "name": "pri.store.size", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { "aliases": [ - "ftavg", - "forecastsTimeAvg" + "cs", + "completionSize" ], - "description": "The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.time.avg" + "description": "size of completion", + "name": "completion.size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "ftmax", - "forecastsTimeMax" - ], - "description": "The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.time.max" + "description": "size of completion", + "name": "pri.completion.size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "ftmin", - "forecastsTimeMin" + "fm", + "fielddataMemory" ], - "description": "The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.time.min" + "description": "used fielddata cache", + "name": "fielddata.memory_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "ftt", - "forecastsTimeTotal" - ], - "description": "The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.time.total" + "description": "used fielddata cache", + "name": "pri.fielddata.memory_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "ft", - "forecastsTotal" + "fe", + "fielddataEvictions" ], - "description": "The number of individual forecasts currently available for the job.", - "name": "forecasts.total" - }, - { - "description": "Identifier for the anomaly detection job.", - "name": "id" + "description": "fielddata evictions", + "name": "fielddata.evictions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mbaf", - "modelBucketAllocationFailures" - ], - "description": "The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.", - "name": "model.bucket_allocation_failures" + "description": "fielddata evictions", + "name": "pri.fielddata.evictions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mbf", - "modelByFields" + "qcm", + "queryCacheMemory" ], - "description": "The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.", - "name": "model.by_fields" + "description": "used query cache", + "name": "query_cache.memory_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mb", - "modelBytes" - ], - "description": "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.", - "name": "model.bytes" + "description": "used query cache", + "name": "pri.query_cache.memory_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mbe", - "modelBytesExceeded" + "qce", + "queryCacheEvictions" ], - "description": "The number of bytes over the high limit for memory usage at the last\nallocation failure.", - "name": "model.bytes_exceeded" + "description": "query cache evictions", + "name": "query_cache.evictions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mcs", - "modelCategorizationStatus" - ], - "description": "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.", - "name": "model.categorization_status" + "description": "query cache evictions", + "name": "pri.query_cache.evictions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mcdc", - "modelCategorizedDocCount" + "rcm", + "requestCacheMemory" ], - "description": "The number of documents that have had a field categorized.", - "name": "model.categorized_doc_count" + "description": "used request cache", + "name": "request_cache.memory_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mdcc", - "modelDeadCategoryCount" - ], - "description": "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.", - "name": "model.dead_category_count" + "description": "used request cache", + "name": "pri.request_cache.memory_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mdcc", - "modelFailedCategoryCount" + "rce", + "requestCacheEvictions" ], - "description": "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.", - "name": "model.failed_category_count" + "description": "request cache evictions", + "name": "request_cache.evictions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mfcc", - "modelFrequentCategoryCount" - ], - "description": "The number of categories that match more than 1% of categorized documents.", - "name": "model.frequent_category_count" + "description": "request cache evictions", + "name": "pri.request_cache.evictions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mlt", - "modelLogTime" + "rchc", + "requestCacheHitCount" ], - "description": "The timestamp when the model stats were gathered, according to server time.", - "name": "model.log_time" + "description": "request cache hit count", + "name": "request_cache.hit_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mml", - "modelMemoryLimit" - ], - "description": "The timestamp when the model stats were gathered, according to server time.", - "name": "model.memory_limit" + "description": "request cache hit count", + "name": "pri.request_cache.hit_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mms", - "modelMemoryStatus" + "rcmc", + "requestCacheMissCount" ], - "description": "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.", - "name": "model.memory_status" + "description": "request cache miss count", + "name": "request_cache.miss_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mof", - "modelOverFields" - ], - "description": "The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", - "name": "model.over_fields" + "description": "request cache miss count", + "name": "pri.request_cache.miss_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mpf", - "modelPartitionFields" + "ft", + "flushTotal" ], - "description": "The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", - "name": "model.partition_fields" + "description": "number of flushes", + "name": "flush.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mrcc", - "modelRareCategoryCount" - ], - "description": "The number of categories that match just one categorized document.", - "name": "model.rare_category_count" + "description": "number of flushes", + "name": "pri.flush.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mt", - "modelTimestamp" + "ftt", + "flushTotalTime" ], - "description": "The timestamp of the last record when the model stats were gathered.", - "name": "model.timestamp" + "description": "time spent in flush", + "name": "flush.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mtcc", - "modelTotalCategoryCount" - ], - "description": "The number of categories created by categorization.", - "name": "model.total_category_count" + "description": "time spent in flush", + "name": "pri.flush.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "na", - "nodeAddress" + "gc", + "getCurrent" ], - "description": "The network address of the node that runs the job. This information is\navailable only for open jobs.", - "name": "node.address" + "description": "number of current get ops", + "name": "get.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "ne", - "nodeEphemeralId" - ], - "description": "The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.", - "name": "node.ephemeral_id" + "description": "number of current get ops", + "name": "pri.get.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "ni", - "nodeId" + "gti", + "getTime" ], - "description": "The unique identifier of the node that runs the job. This information is\navailable only for open jobs.", - "name": "node.id" + "description": "time spent in get", + "name": "get.time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "nn", - "nodeName" - ], - "description": "The name of the node that runs the job. This information is available only\nfor open jobs.", - "name": "node.name" + "description": "time spent in get", + "name": "pri.get.time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "ot" + "gto", + "getTotal" ], - "description": "For open jobs only, the elapsed time for which the job has been open.", - "name": "opened_time" + "description": "number of get ops", + "name": "get.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "s" - ], - "description": "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.", - "name": "state" - } - ], - "name": { - "name": "CatAnomalyDetectorColumn", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L32-L401" - }, - { - "kind": "type_alias", - "name": { - "name": "CatAnonalyDetectorColumns", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L402-L404", - "type": { - "items": [ - { + "description": "number of get ops", + "name": "pri.get.total", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CatAnomalyDetectorColumn", - "namespace": "cat._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatAnomalyDetectorColumn", - "namespace": "cat._types" - } + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "aliases": [ - "assignment_explanation" - ], - "description": "For started datafeeds only, contains messages relating to the selection of\na node.", - "name": "ae" }, { "aliases": [ - "buckets.count", - "bucketsCount" + "geti", + "getExistsTime" ], - "description": "The number of buckets processed.", - "name": "bc" + "description": "time spent in successful gets", + "name": "get.exists_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "description": "A numerical character string that uniquely identifies the datafeed.", - "name": "id" + "description": "time spent in successful gets", + "name": "pri.get.exists_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "node.address", - "nodeAddress" + "geto", + "getExistsTotal" ], - "description": "For started datafeeds only, the network address of the node where the\ndatafeed is started.", - "name": "na" + "description": "number of successful gets", + "name": "get.exists_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "node.ephemeral_id", - "nodeEphemeralId" - ], - "description": "For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.", - "name": "ne" + "description": "number of successful gets", + "name": "pri.get.exists_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "node.id", - "nodeId" + "gmti", + "getMissingTime" ], - "description": "For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.", - "name": "ni" + "description": "time spent in failed gets", + "name": "get.missing_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "node.name", - "nodeName" - ], - "description": "For started datafeeds only, the name of the node where the datafeed is\nstarted.", - "name": "nn" + "description": "time spent in failed gets", + "name": "pri.get.missing_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "search.bucket_avg", - "searchBucketAvg" + "gmto", + "getMissingTotal" ], - "description": "The average search time per bucket, in milliseconds.", - "name": "sba" + "description": "number of failed gets", + "name": "get.missing_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "search.count", - "searchCount" - ], - "description": "The number of searches run by the datafeed.", - "name": "sc" + "description": "number of failed gets", + "name": "pri.get.missing_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "search.exp_avg_hour", - "searchExpAvgHour" + "idc", + "indexingDeleteCurrent" ], - "description": "The exponential average search time per hour, in milliseconds.", - "name": "seah" + "description": "number of current deletions", + "name": "indexing.delete_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "search.time", - "searchTime" - ], - "description": "The total time the datafeed spent searching, in milliseconds.", - "name": "st" + "description": "number of current deletions", + "name": "pri.indexing.delete_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "state" - ], - "description": "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.", - "name": "s" - } - ], - "name": { - "name": "CatDatafeedColumn", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L405-L471" - }, - { - "kind": "type_alias", - "name": { - "name": "CatDatafeedColumns", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L559-L559", - "type": { - "items": [ - { + "aliases": [ + "idti", + "indexingDeleteTime" + ], + "description": "time spent in deletions", + "name": "indexing.delete_time", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CatDatafeedColumn", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatDatafeedColumn", - "namespace": "cat._types" - } + } + }, + { + "description": "time spent in deletions", + "name": "pri.indexing.delete_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ + }, { "aliases": [ - "ae" + "idto", + "indexingDeleteTotal" ], - "description": "Contains messages relating to the selection of a node.", - "name": "assignment_explanation" + "description": "number of delete ops", + "name": "indexing.delete_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "ct", - "createTime" - ], - "description": "The time when the data frame analytics job was created.", - "name": "create_time" + "description": "number of delete ops", + "name": "pri.indexing.delete_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "d" + "iic", + "indexingIndexCurrent" ], - "description": "A description of a job.", - "name": "description" + "description": "number of current indexing ops", + "name": "indexing.index_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "di", - "destIndex" - ], - "description": "Name of the destination index.", - "name": "dest_index" + "description": "number of current indexing ops", + "name": "pri.indexing.index_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "fr", - "failureReason" + "iiti", + "indexingIndexTime" ], - "description": "Contains messages about the reason why a data frame analytics job failed.", - "name": "failure_reason" + "description": "time spent in indexing", + "name": "indexing.index_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "description": "Identifier for the data frame analytics job.", - "name": "id" + "description": "time spent in indexing", + "name": "pri.indexing.index_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "mml", - "modelMemoryLimit" + "iito", + "indexingIndexTotal" ], - "description": "The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.", - "name": "model_memory_limit" + "description": "number of indexing ops", + "name": "indexing.index_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "na", - "nodeAddress" - ], - "description": "The network address of the node that the data frame analytics job is\nassigned to.", - "name": "node.address" + "description": "number of indexing ops", + "name": "pri.indexing.index_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "ne", - "nodeEphemeralId" + "iif", + "indexingIndexFailed" ], - "description": "The ephemeral ID of the node that the data frame analytics job is assigned\nto.", - "name": "node.ephemeral_id" + "description": "number of failed indexing ops", + "name": "indexing.index_failed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "ni", - "nodeId" - ], - "description": "The unique identifier of the node that the data frame analytics job is\nassigned to.", - "name": "node.id" + "description": "number of failed indexing ops", + "name": "pri.indexing.index_failed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "nn", - "nodeName" + "mc", + "mergesCurrent" ], - "description": "The name of the node that the data frame analytics job is assigned to.", - "name": "node.name" + "description": "number of current merges", + "name": "merges.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "p" - ], - "description": "The progress report of the data frame analytics job by phase.", - "name": "progress" + "description": "number of current merges", + "name": "pri.merges.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "si", - "sourceIndex" + "mcd", + "mergesCurrentDocs" ], - "description": "Name of the source index.", - "name": "source_index" + "description": "number of current merging docs", + "name": "merges.current_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "s" - ], - "description": "Current state of the data frame analytics job.", - "name": "state" + "description": "number of current merging docs", + "name": "pri.merges.current_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "t" + "mcs", + "mergesCurrentSize" ], - "description": "The type of analysis that the data frame analytics job performs.", - "name": "type" + "description": "size of current merges", + "name": "merges.current_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "size of current merges", + "name": "pri.merges.current_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "v" + "mt", + "mergesTotal" ], - "description": "The Elasticsearch version number in which the data frame analytics job was\ncreated.", - "name": "version" - } - ], - "name": { - "name": "CatDfaColumn", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L472-L557" - }, - { - "kind": "type_alias", - "name": { - "name": "CatDfaColumns", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L558-L558", - "type": { - "items": [ - { + "description": "number of completed merge ops", + "name": "merges.total", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CatDfaColumn", - "namespace": "cat._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatDfaColumn", - "namespace": "cat._types" - } + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "behaviors": [ + }, { + "description": "number of completed merge ops", + "name": "pri.merges.total", + "required": false, "type": { - "name": "CommonCatQueryParameters", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - ], - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "interface", - "name": { - "name": "CatRequestBase", - "namespace": "cat._types" - }, - "properties": [], - "specLocation": "cat/_types/CatBase.ts#L28-L30" - }, - { - "kind": "enum", - "members": [ + }, { "aliases": [ - "ct" + "mtd", + "mergesTotalDocs" ], - "description": "The time when the trained model was created.", - "name": "create_time" + "description": "docs merged", + "name": "merges.total_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "c", - "createdBy" - ], - "description": "Information on the creator of the trained model.", - "name": "created_by" + "description": "docs merged", + "name": "pri.merges.total_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "df", - "dataFrameAnalytics", - "dfid" + "mts", + "mergesTotalSize" ], - "description": "Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.", - "name": "data_frame_analytics_id" + "description": "size merged", + "name": "merges.total_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "d" - ], - "description": "The description of the trained model.", - "name": "description" + "description": "size merged", + "name": "pri.merges.total_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "hs", - "modelHeapSize" + "mtt", + "mergesTotalTime" ], - "description": "The estimated heap size to keep the trained model in memory.", - "name": "heap_size" + "description": "time spent in merges", + "name": "merges.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "description": "Identifier for the trained model.", - "name": "id" + "description": "time spent in merges", + "name": "pri.merges.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "ic", - "ingestCount" + "rto", + "refreshTotal" ], - "description": "The total number of documents that are processed by the model.", - "name": "ingest.count" + "description": "total refreshes", + "name": "refresh.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "icurr", - "ingestCurrent" - ], - "description": "The total number of document that are currently being handled by the\ntrained model.", - "name": "ingest.current" + "description": "total refreshes", + "name": "pri.refresh.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "if", - "ingestFailed" + "rti", + "refreshTime" ], - "description": "The total number of failed ingest attempts with the trained model.", - "name": "ingest.failed" + "description": "time spent in refreshes", + "name": "refresh.time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "time spent in refreshes", + "name": "pri.refresh.time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "ip", - "ingestPipelines" + "reto" ], - "description": "The total number of ingest pipelines that are referencing the trained\nmodel.", - "name": "ingest.pipelines" + "description": "total external refreshes", + "name": "refresh.external_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "it", - "ingestTime" - ], - "description": "The total time that is spent processing documents with the trained model.", - "name": "ingest.time" + "description": "total external refreshes", + "name": "pri.refresh.external_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "l" + "reti" ], - "description": "The license level of the trained model.", - "name": "license" + "description": "time spent in external refreshes", + "name": "refresh.external_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "o", - "modelOperations" - ], - "description": "The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.", - "name": "operations" + "description": "time spent in external refreshes", + "name": "pri.refresh.external_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "v" + "rli", + "refreshListeners" ], - "description": "The Elasticsearch version number in which the trained model was created.", - "name": "version" - } - ], - "name": { - "name": "CatTrainedModelsColumn", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L561-L635" - }, - { - "kind": "type_alias", - "name": { - "name": "CatTrainedModelsColumns", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L636-L638", - "type": { - "items": [ - { + "description": "number of pending refresh listeners", + "name": "refresh.listeners", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CatTrainedModelsColumn", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatTrainedModelsColumn", - "namespace": "cat._types" - } + } + }, + { + "description": "number of pending refresh listeners", + "name": "pri.refresh.listeners", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ + }, { "aliases": [ - "cldt" + "sfc", + "searchFetchCurrent" ], - "description": "The timestamp when changes were last detected in the source indices.", - "name": "changes_last_detection_time" + "description": "current fetch phase ops", + "name": "search.fetch_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "cp" - ], - "description": "The sequence number for the checkpoint.", - "name": "checkpoint" + "description": "current fetch phase ops", + "name": "pri.search.fetch_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "cdtea", - "checkpointTimeExpAvg" + "sfti", + "searchFetchTime" ], - "description": "Exponential moving average of the duration of the checkpoint, in\nmilliseconds.", - "name": "checkpoint_duration_time_exp_avg" + "description": "time spent in fetch phase", + "name": "search.fetch_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "c", - "checkpointProgress" - ], - "description": "The progress of the next checkpoint that is currently in progress.", - "name": "checkpoint_progress" + "description": "time spent in fetch phase", + "name": "pri.search.fetch_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "ct", - "createTime" + "sfto", + "searchFetchTotal" ], - "description": "The time the transform was created.", - "name": "create_time" + "description": "total fetch ops", + "name": "search.fetch_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "dtime" - ], - "description": "The amount of time spent deleting, in milliseconds.", - "name": "delete_time" + "description": "total fetch ops", + "name": "pri.search.fetch_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "d" + "so", + "searchOpenContexts" ], - "description": "The description of the transform.", - "name": "description" + "description": "open search contexts", + "name": "search.open_contexts", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "di", - "destIndex" - ], - "description": "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.", - "name": "dest_index" + "description": "open search contexts", + "name": "pri.search.open_contexts", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "docd" + "sqc", + "searchQueryCurrent" ], - "description": "The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.", - "name": "documents_deleted" + "description": "current query phase ops", + "name": "search.query_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "doci" - ], - "description": "The number of documents that have been indexed into the destination index\nfor the transform.", - "name": "documents_indexed" + "description": "current query phase ops", + "name": "pri.search.query_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "dps" + "sqti", + "searchQueryTime" ], - "description": "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.", - "name": "docs_per_second" + "description": "time spent in query phase", + "name": "search.query_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "docp" - ], - "description": "The number of documents that have been processed from the source index of\nthe transform.", - "name": "documents_processed" + "description": "time spent in query phase", + "name": "pri.search.query_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "f" + "sqto", + "searchQueryTotal" ], - "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`. The default\nvalue is `1m`.", - "name": "frequency" + "description": "total query phase ops", + "name": "search.query_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "description": "Identifier for the transform.", - "name": "id" + "description": "total query phase ops", + "name": "pri.search.query_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "if" + "scc", + "searchScrollCurrent" ], - "description": "The number of indexing failures.", - "name": "index_failure" + "description": "open scroll contexts", + "name": "search.scroll_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "itime" - ], - "description": "The amount of time spent indexing, in milliseconds.", - "name": "index_time" + "description": "open scroll contexts", + "name": "pri.search.scroll_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "it" + "scti", + "searchScrollTime" ], - "description": "The number of index operations.", - "name": "index_total" + "description": "time scroll contexts held open", + "name": "search.scroll_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "idea" - ], - "description": "Exponential moving average of the number of new documents that have been\nindexed.", - "name": "indexed_documents_exp_avg" + "description": "time scroll contexts held open", + "name": "pri.search.scroll_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "lst", - "lastSearchTime" + "scto", + "searchScrollTotal" ], - "description": "The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.", - "name": "last_search_time" + "description": "completed scroll contexts", + "name": "search.scroll_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mpsz" - ], - "description": "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`.", - "name": "max_page_search_size" + "description": "completed scroll contexts", + "name": "pri.search.scroll_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "pp" + "sc", + "segmentsCount" ], - "description": "The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.", - "name": "pages_processed" + "description": "number of segments", + "name": "segments.count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "p" - ], - "description": "The unique identifier for an ingest pipeline.", - "name": "pipeline" + "description": "number of segments", + "name": "pri.segments.count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "pdea" + "sm", + "segmentsMemory" ], - "description": "Exponential moving average of the number of documents that have been\nprocessed.", - "name": "processed_documents_exp_avg" + "description": "memory used by segments", + "name": "segments.memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "pt" - ], - "description": "The amount of time spent processing results, in milliseconds.", - "name": "processing_time" + "description": "memory used by segments", + "name": "pri.segments.memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "r" + "siwm", + "segmentsIndexWriterMemory" ], - "description": "If a transform has a `failed` state, this property provides details about\nthe reason for the failure.", - "name": "reason" + "description": "memory used by index writer", + "name": "segments.index_writer_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "memory used by index writer", + "name": "pri.segments.index_writer_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "sf" + "svmm", + "segmentsVersionMapMemory" ], - "description": "The number of search failures.", - "name": "search_failure" + "description": "memory used by version map", + "name": "segments.version_map_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "stime" - ], - "description": "The amount of time spent searching, in milliseconds.", - "name": "search_time" + "description": "memory used by version map", + "name": "pri.segments.version_map_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "st" + "sfbm", + "fixedBitsetMemory" ], - "description": "The number of search operations on the source index for the transform.", - "name": "search_total" + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "segments.fixed_bitset_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "si", - "sourceIndex" - ], - "description": "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.", - "name": "source_index" + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "pri.segments.fixed_bitset_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "s" + "wc", + "warmerCurrent" ], - "description": "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.", - "name": "state" + "description": "current warmer ops", + "name": "warmer.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "tt" - ], - "description": "Indicates the type of transform: `batch` or `continuous`.", - "name": "transform_type" + "description": "current warmer ops", + "name": "pri.warmer.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "aliases": [ - "tc" + "wto", + "warmerTotal" ], - "description": "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.", - "name": "trigger_count" + "description": "total warmer ops", + "name": "warmer.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "v" - ], - "description": "The version of Elasticsearch that existed on the node when the transform\nwas created.", - "name": "version" - } - ], - "name": { - "name": "CatTransformColumn", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L640-L844" - }, - { - "kind": "type_alias", - "name": { - "name": "CatTransformColumns", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L845-L845", - "type": { - "items": [ - { + "description": "total warmer ops", + "name": "pri.warmer.total", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CatTransformColumn", - "namespace": "cat._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatTransformColumn", - "namespace": "cat._types" - } + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "AliasesRecord", - "namespace": "cat.aliases" - }, - "properties": [ + }, { "aliases": [ - "a" + "wtt", + "warmerTotalTime" ], - "description": "alias name", - "name": "alias", + "description": "time spent in warmers", + "name": "warmer.total_time", "required": false, "type": { "kind": "instance_of", @@ -83951,28 +87815,24 @@ } }, { - "aliases": [ - "i", - "idx" - ], - "description": "index alias points to", - "name": "index", + "description": "time spent in warmers", + "name": "pri.warmer.total_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "f", - "fi" + "suc", + "suggestCurrent" ], - "description": "filter", - "name": "filter", + "description": "number of current suggest ops", + "name": "suggest.current", "required": false, "type": { "kind": "instance_of", @@ -83983,12 +87843,8 @@ } }, { - "aliases": [ - "ri", - "routingIndex" - ], - "description": "index routing", - "name": "routing.index", + "description": "number of current suggest ops", + "name": "pri.suggest.current", "required": false, "type": { "kind": "instance_of", @@ -84000,11 +87856,23 @@ }, { "aliases": [ - "rs", - "routingSearch" + "suti", + "suggestTime" ], - "description": "search routing", - "name": "routing.search", + "description": "time spend in suggest", + "name": "suggest.time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "time spend in suggest", + "name": "pri.suggest.time", "required": false, "type": { "kind": "instance_of", @@ -84016,11 +87884,11 @@ }, { "aliases": [ - "w", - "isWriteIndex" + "suto", + "suggestTotal" ], - "description": "write index", - "name": "is_write_index", + "description": "number of suggest ops", + "name": "suggest.total", "required": false, "type": { "kind": "instance_of", @@ -84029,94 +87897,53 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/aliases/types.ts#L22-L53" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.aliases" - }, - "path": [ + }, { - "description": "A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.", - "name": "name", + "description": "number of suggest ops", + "name": "pri.suggest.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "name": "expand_wildcards", + "aliases": [ + "tm", + "memoryTotal" + ], + "description": "total used memory", + "name": "memory.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "cat/aliases/CatAliasesRequest.ts#L23-L41" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "description": "total user memory", + "name": "pri.memory.total", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "AliasesRecord", - "namespace": "cat.aliases" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.aliases" - }, - "specLocation": "cat/aliases/CatAliasesResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "AllocationRecord", - "namespace": "cat.allocation" - }, - "properties": [ + }, { "aliases": [ - "s" + "sth" ], - "description": "Number of primary and replica shards assigned to the node.", - "name": "shards", + "description": "indicates if the index is search throttled", + "name": "search.throttled", "required": false, "type": { "kind": "instance_of", @@ -84128,201 +87955,135 @@ }, { "aliases": [ - "di", - "diskIndices" + "bto", + "bulkTotalOperation" ], - "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.", - "name": "disk.indices", + "description": "number of bulk shard ops", + "name": "bulk.total_operations", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "aliases": [ - "du", - "diskUsed" - ], - "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.", - "name": "disk.used", + "description": "number of bulk shard ops", + "name": "pri.bulk.total_operations", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { "aliases": [ - "da", - "diskAvail" + "btti", + "bulkTotalTime" ], - "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.", - "name": "disk.avail", + "description": "time spend in shard bulk", + "name": "bulk.total_time", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "aliases": [ - "dt", - "diskTotal" - ], - "description": "Total disk space for the node, including in-use and available space.", - "name": "disk.total", + "description": "time spend in shard bulk", + "name": "pri.bulk.total_time", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { "aliases": [ - "dp", - "diskPercent" + "btsi", + "bulkTotalSizeInBytes" ], - "description": "Total percentage of disk space in use. Calculated as `disk.used / disk.total`.", - "name": "disk.percent", + "description": "total size in bytes of shard bulk", + "name": "bulk.total_size_in_bytes", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Percentage", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "total size in bytes of shard bulk", + "name": "pri.bulk.total_size_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { "aliases": [ - "h" + "bati", + "bulkAvgTime" ], - "description": "Network host for the node. Set using the `network.host` setting.", - "name": "host", + "description": "average time spend in shard bulk", + "name": "bulk.avg_time", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Host", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "average time spend in shard bulk", + "name": "pri.bulk.avg_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "description": "IP address and port for the node.", - "name": "ip", + "aliases": [ + "basi", + "bulkAvgSizeInBytes" + ], + "description": "average size in bytes of shard bulk", + "name": "bulk.avg_size_in_bytes", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Ip", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "aliases": [ - "n" - ], - "description": "Name for the node. Set using the `node.name` setting.", - "name": "node", + "description": "average size in bytes of shard bulk", + "name": "pri.bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -84333,7 +88094,7 @@ } } ], - "specLocation": "cat/allocation/types.ts#L24-L75" + "specLocation": "cat/indices/types.ts#L20-L801" }, { "attachedBehaviors": [ @@ -84343,7 +88104,7 @@ "body": { "kind": "no_body" }, - "description": "Provides a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.", "inherits": { "type": { "name": "CatRequestBase", @@ -84353,17 +88114,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.allocation" + "namespace": "cat.indices" }, "path": [ { - "description": "Comma-separated list of node identifiers or names used to limit the returned information.", - "name": "node_id", + "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`.", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeIds", + "name": "Indices", "namespace": "_types" } } @@ -84381,74 +88142,104 @@ "namespace": "_types" } } - } - ], - "specLocation": "cat/allocation/CatAllocationRequest.ts#L23-L41" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "description": "The type of index that wildcard patterns can match.", + "name": "expand_wildcards", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "AllocationRecord", - "namespace": "cat.allocation" + "name": "ExpandWildcards", + "namespace": "_types" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.allocation" - }, - "specLocation": "cat/allocation/CatAllocationResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "ComponentTemplate", - "namespace": "cat.component_templates" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "description": "The health status used to limit returned indices. By default, the response includes indices of any health status.", + "name": "health", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "HealthStatus", + "namespace": "_types" } } }, { - "name": "version", - "required": true, + "description": "If true, the response includes information from segments that are not loaded into memory.", + "name": "include_unloaded_segments", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "alias_count", - "required": true, + "description": "If true, the response only includes information from primary shards.", + "name": "pri", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "mapping_count", - "required": true, + "description": "The unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L68" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndicesRecord", + "namespace": "cat.indices" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.indices" + }, + "specLocation": "cat/indices/CatIndicesResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "MasterRecord", + "namespace": "cat.master" + }, + "properties": [ + { + "description": "node id", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { @@ -84458,8 +88249,12 @@ } }, { - "name": "settings_count", - "required": true, + "aliases": [ + "h" + ], + "description": "host name", + "name": "host", + "required": false, "type": { "kind": "instance_of", "type": { @@ -84469,8 +88264,9 @@ } }, { - "name": "metadata_count", - "required": true, + "description": "ip address", + "name": "ip", + "required": false, "type": { "kind": "instance_of", "type": { @@ -84480,8 +88276,12 @@ } }, { - "name": "included_in", - "required": true, + "aliases": [ + "n" + ], + "description": "node name", + "name": "node", + "required": false, "type": { "kind": "instance_of", "type": { @@ -84491,7 +88291,7 @@ } } ], - "specLocation": "cat/component_templates/types.ts#L20-L28" + "specLocation": "cat/master/types.ts#L20-L39" }, { "attachedBehaviors": [ @@ -84501,7 +88301,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "description": "Returns information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "inherits": { "type": { "name": "CatRequestBase", @@ -84511,24 +88311,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.component_templates" + "namespace": "cat.master" }, - "path": [ - { - "description": "The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.", - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], + "path": [], "query": [], - "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L22-L37" + "specLocation": "cat/master/CatMasterRequest.ts#L22-L31" }, { "body": { @@ -84538,8 +88325,8 @@ "value": { "kind": "instance_of", "type": { - "name": "ComponentTemplate", - "namespace": "cat.component_templates" + "name": "MasterRecord", + "namespace": "cat.master" } } } @@ -84547,156 +88334,129 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.component_templates" + "namespace": "cat.master" }, - "specLocation": "cat/component_templates/CatComponentTemplatesResponse.ts#L22-L24" + "specLocation": "cat/master/CatMasterResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "CountRecord", - "namespace": "cat.count" + "name": "DataFrameAnalyticsRecord", + "namespace": "cat.ml_data_frame_analytics" }, "properties": [ + { + "description": "The identifier for the job.", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, { "aliases": [ - "t", - "time" + "t" ], - "description": "seconds since 1970-01-01 00:00:00", - "name": "epoch", + "description": "The type of analysis that the job performs.", + "name": "type", "required": false, "type": { - "generics": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitSeconds", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ts", - "hms", - "hhmmss" + "ct", + "createTime" ], - "description": "time in HH:MM:SS", - "name": "timestamp", + "description": "The time when the job was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeOfDay", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "v" + ], + "description": "The version of Elasticsearch when the job was created.", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", "namespace": "_types" } } }, { "aliases": [ - "dc", - "docs.count", - "docsCount" + "si", + "sourceIndex" ], - "description": "the document count", - "name": "count", + "description": "The name of the source index.", + "name": "source_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } - } - ], - "specLocation": "cat/count/types.ts#L23-L39" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.\nNOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.count" - }, - "path": [ + }, { - "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`.", - "name": "index", + "aliases": [ + "di", + "destIndex" + ], + "description": "The name of the destination index.", + "name": "dest_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "IndexName", "namespace": "_types" } } - } - ], - "query": [], - "specLocation": "cat/count/CatCountRequest.ts#L23-L42" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "aliases": [ + "d" + ], + "description": "A description of the job.", + "name": "description", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CountRecord", - "namespace": "cat.count" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.count" - }, - "specLocation": "cat/count/CatCountResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "FielddataRecord", - "namespace": "cat.fielddata" - }, - "properties": [ + }, { - "description": "node id", - "name": "id", + "aliases": [ + "mml", + "modelMemoryLimit" + ], + "description": "The approximate maximum amount of memory resources that are permitted for the job.", + "name": "model_memory_limit", "required": false, "type": { "kind": "instance_of", @@ -84708,10 +88468,10 @@ }, { "aliases": [ - "h" + "s" ], - "description": "host name", - "name": "host", + "description": "The current status of the job.", + "name": "state", "required": false, "type": { "kind": "instance_of", @@ -84722,8 +88482,12 @@ } }, { - "description": "ip address", - "name": "ip", + "aliases": [ + "fr", + "failureReason" + ], + "description": "Messages about the reason why the job failed.", + "name": "failure_reason", "required": false, "type": { "kind": "instance_of", @@ -84735,10 +88499,10 @@ }, { "aliases": [ - "n" + "p" ], - "description": "node name", - "name": "node", + "description": "The progress report for the job by phase.", + "name": "progress", "required": false, "type": { "kind": "instance_of", @@ -84750,10 +88514,11 @@ }, { "aliases": [ - "f" + "ae", + "assignmentExplanation" ], - "description": "field name", - "name": "field", + "description": "Messages related to the selection of a node.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -84764,8 +88529,60 @@ } }, { - "description": "field data usage", - "name": "size", + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the assigned node.", + "name": "node.id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "nn", + "nodeName" + ], + "description": "The name of the assigned node.", + "name": "node.name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral identifier of the assigned node.", + "name": "node.ephemeral_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "na", + "nodeAddress" + ], + "description": "The network address of the assigned node.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -84776,7 +88593,7 @@ } } ], - "specLocation": "cat/fielddata/types.ts#L20-L48" + "specLocation": "cat/ml_data_frame_analytics/types.ts#L22-L102" }, { "attachedBehaviors": [ @@ -84786,7 +88603,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", + "description": "Returns configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", "inherits": { "type": { "name": "CatRequestBase", @@ -84796,49 +88613,86 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.fielddata" + "namespace": "cat.ml_data_frame_analytics" }, "path": [ { - "description": "Comma-separated list of fields used to limit returned information.\nTo retrieve all fields, omit this parameter.", - "name": "fields", + "description": "The ID of the data frame analytics to fetch", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)", + "name": "allow_no_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The unit in which to display byte values", + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Bytes", + "namespace": "_types" + } + } + }, + { + "description": "Comma-separated list of column names to display.", + "name": "h", "required": false, + "serverDefault": "create_time,id,state,type", "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "CatDfaColumns", + "namespace": "cat._types" } } - } - ], - "query": [ + }, { - "description": "The unit used to display byte values.", - "name": "bytes", + "description": "Comma-separated list of column names or column aliases used to sort the\nresponse.", + "name": "s", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "CatDfaColumns", + "namespace": "cat._types" } } }, { - "description": "Comma-separated list of fields used to limit returned information.", - "name": "fields", + "description": "Unit used to display time values.", + "name": "time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Duration", "namespace": "_types" } } } ], - "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L47" + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L58" }, { "body": { @@ -84848,8 +88702,8 @@ "value": { "kind": "instance_of", "type": { - "name": "FielddataRecord", - "namespace": "cat.fielddata" + "name": "DataFrameAnalyticsRecord", + "namespace": "cat.ml_data_frame_analytics" } } } @@ -84857,73 +88711,20 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.fielddata" + "namespace": "cat.ml_data_frame_analytics" }, - "specLocation": "cat/fielddata/CatFielddataResponse.ts#L22-L24" + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "HealthRecord", - "namespace": "cat.health" + "name": "DatafeedsRecord", + "namespace": "cat.ml_datafeeds" }, "properties": [ { - "aliases": [ - "time" - ], - "description": "seconds since 1970-01-01 00:00:00", - "name": "epoch", - "required": false, - "type": { - "generics": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitSeconds", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } - } - }, - { - "aliases": [ - "ts", - "hms", - "hhmmss" - ], - "description": "time in HH:MM:SS", - "name": "timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeOfDay", - "namespace": "_types" - } - } - }, - { - "aliases": [ - "cl" - ], - "description": "cluster name", - "name": "cluster", + "description": "The datafeed identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", @@ -84935,26 +88736,25 @@ }, { "aliases": [ - "st" + "s" ], - "description": "health status", - "name": "status", + "description": "The status of the datafeed.", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DatafeedState", + "namespace": "ml._types" } } }, { "aliases": [ - "nt", - "nodeTotal" + "ae" ], - "description": "total number of nodes", - "name": "node.total", + "description": "For started datafeeds only, contains messages relating to the selection of a node.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -84966,11 +88766,11 @@ }, { "aliases": [ - "nd", - "nodeData" + "bc", + "bucketsCount" ], - "description": "number of nodes that can store data", - "name": "node.data", + "description": "The number of buckets processed.", + "name": "buckets.count", "required": false, "type": { "kind": "instance_of", @@ -84982,13 +88782,11 @@ }, { "aliases": [ - "t", - "sh", - "shards.total", - "shardsTotal" + "sc", + "searchCount" ], - "description": "total number of shards", - "name": "shards", + "description": "The number of searches run by the datafeed.", + "name": "search.count", "required": false, "type": { "kind": "instance_of", @@ -85000,12 +88798,11 @@ }, { "aliases": [ - "p", - "shards.primary", - "shardsPrimary" + "st", + "searchTime" ], - "description": "number of primary shards", - "name": "pri", + "description": "The total time the datafeed spent searching, in milliseconds.", + "name": "search.time", "required": false, "type": { "kind": "instance_of", @@ -85017,12 +88814,11 @@ }, { "aliases": [ - "r", - "shards.relocating", - "shardsRelocating" + "sba", + "searchBucketAvg" ], - "description": "number of relocating nodes", - "name": "relo", + "description": "The average search time per bucket, in milliseconds.", + "name": "search.bucket_avg", "required": false, "type": { "kind": "instance_of", @@ -85034,12 +88830,11 @@ }, { "aliases": [ - "i", - "shards.initializing", - "shardsInitializing" + "seah", + "searchExpAvgHour" ], - "description": "number of initializing nodes", - "name": "init", + "description": "The exponential average search time per hour, in milliseconds.", + "name": "search.exp_avg_hour", "required": false, "type": { "kind": "instance_of", @@ -85051,12 +88846,11 @@ }, { "aliases": [ - "u", - "shards.unassigned", - "shardsUnassigned" + "ni", + "nodeId" ], - "description": "number of unassigned shards", - "name": "unassign", + "description": "The unique identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.id", "required": false, "type": { "kind": "instance_of", @@ -85068,11 +88862,11 @@ }, { "aliases": [ - "pt", - "pendingTasks" + "nn", + "nodeName" ], - "description": "number of pending tasks", - "name": "pending_tasks", + "description": "The name of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.name", "required": false, "type": { "kind": "instance_of", @@ -85084,11 +88878,11 @@ }, { "aliases": [ - "mtwt", - "maxTaskWaitTime" + "ne", + "nodeEphemeralId" ], - "description": "wait time of longest task pending", - "name": "max_task_wait_time", + "description": "The ephemeral identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", @@ -85100,11 +88894,11 @@ }, { "aliases": [ - "asp", - "activeShardsPercent" + "na", + "nodeAddress" ], - "description": "active number of shards in percent", - "name": "active_shards_percent", + "description": "The network address of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -85115,7 +88909,7 @@ } } ], - "specLocation": "cat/health/types.ts#L23-L94" + "specLocation": "cat/ml_datafeeds/types.ts#L22-L87" }, { "attachedBehaviors": [ @@ -85125,7 +88919,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the health status of a cluster, similar to the cluster health API.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", + "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "inherits": { "type": { "name": "CatRequestBase", @@ -85135,25 +88929,26 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.health" + "namespace": "cat.ml_datafeeds" }, - "path": [], - "query": [ + "path": [ { - "description": "The unit used to display time values.", - "name": "time", + "description": "A numerical character string that uniquely identifies the datafeed.", + "name": "datafeed_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "If true, returns `HH:MM:SS` and Unix epoch timestamps.", - "name": "ts", + "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.", + "name": "allow_no_match", "required": false, "serverDefault": true, "type": { @@ -85163,75 +88958,46 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/health/CatHealthRequest.ts#L23-L52" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "description": "Comma-separated list of column names to display.", + "name": "h", + "required": false, + "serverDefault": "['bc', 'id', 'sc', 's']", + "type": { "kind": "instance_of", "type": { - "name": "HealthRecord", - "namespace": "cat.health" + "name": "CatDatafeedColumns", + "namespace": "cat._types" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.health" - }, - "specLocation": "cat/health/CatHealthResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "HelpRecord", - "namespace": "cat.help" - }, - "properties": [ + }, { - "name": "endpoint", - "required": true, + "description": "Comma-separated list of column names or column aliases used to sort the response.", + "name": "s", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatDatafeedColumns", + "namespace": "cat._types" + } + } + }, + { + "description": "The unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" } } } ], - "specLocation": "cat/help/types.ts#L20-L22" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns help for the Cat APIs.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.help" - }, - "path": [], - "query": [], - "specLocation": "cat/help/CatHelpRequest.ts#L22-L28" + "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L73" }, { "body": { @@ -85241,8 +89007,8 @@ "value": { "kind": "instance_of", "type": { - "name": "HelpRecord", - "namespace": "cat.help" + "name": "DatafeedsRecord", + "namespace": "cat.ml_datafeeds" } } } @@ -85250,29 +89016,26 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.help" + "namespace": "cat.ml_datafeeds" }, - "specLocation": "cat/help/CatHelpResponse.ts#L22-L24" + "specLocation": "cat/ml_datafeeds/CatDatafeedsResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "IndicesRecord", - "namespace": "cat.indices" + "name": "JobsRecord", + "namespace": "cat.ml_jobs" }, "properties": [ { - "aliases": [ - "h" - ], - "description": "current health status", - "name": "health", + "description": "The anomaly detection job identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, @@ -85280,73 +89043,23 @@ "aliases": [ "s" ], - "description": "open/close status", - "name": "status", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "i", - "idx" - ], - "description": "index name", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "id" - ], - "description": "index uuid", - "name": "uuid", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "p", - "shards.primary", - "shardsPrimary" - ], - "description": "number of primary shards", - "name": "pri", + "description": "The status of the anomaly detection job.", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "JobState", + "namespace": "ml._types" } } }, { "aliases": [ - "r", - "shards.replica", - "shardsReplica" + "ot" ], - "description": "number of replica shards", - "name": "rep", + "description": "For open jobs only, the amount of time the job has been opened.", + "name": "opened_time", "required": false, "type": { "kind": "instance_of", @@ -85358,66 +89071,10 @@ }, { "aliases": [ - "dc", - "docsCount" - ], - "description": "available docs", - "name": "docs.count", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "dd", - "docsDeleted" - ], - "description": "deleted docs", - "name": "docs.deleted", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "cd" + "ae" ], - "description": "index creation date (millisecond value)", - "name": "creation.date", + "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -85429,78 +89086,27 @@ }, { "aliases": [ - "cds" + "dpr", + "dataProcessedRecords" ], - "description": "index creation date (as string)", - "name": "creation.date.string", + "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.", + "name": "data.processed_records", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "ss", - "storeSize" - ], - "description": "store size of primaries & replicas", - "name": "store.size", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "store size of primaries", - "name": "pri.store.size", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + } } }, { "aliases": [ - "cs", - "completionSize" + "dpf", + "dataProcessedFields" ], - "description": "size of completion", - "name": "completion.size", + "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.", + "name": "data.processed_fields", "required": false, "type": { "kind": "instance_of", @@ -85511,24 +89117,28 @@ } }, { - "description": "size of completion", - "name": "pri.completion.size", + "aliases": [ + "dib", + "dataInputBytes" + ], + "description": "The number of bytes of input data posted to the anomaly detection job.", + "name": "data.input_bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "fm", - "fielddataMemory" + "dir", + "dataInputRecords" ], - "description": "used fielddata cache", - "name": "fielddata.memory_size", + "description": "The number of input documents posted to the anomaly detection job.", + "name": "data.input_records", "required": false, "type": { "kind": "instance_of", @@ -85539,8 +89149,12 @@ } }, { - "description": "used fielddata cache", - "name": "pri.fielddata.memory_size", + "aliases": [ + "dif", + "dataInputFields" + ], + "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.", + "name": "data.input_fields", "required": false, "type": { "kind": "instance_of", @@ -85552,11 +89166,11 @@ }, { "aliases": [ - "fe", - "fielddataEvictions" + "did", + "dataInvalidDates" ], - "description": "fielddata evictions", - "name": "fielddata.evictions", + "description": "The number of input documents with either a missing date field or a date that could not be parsed.", + "name": "data.invalid_dates", "required": false, "type": { "kind": "instance_of", @@ -85567,8 +89181,12 @@ } }, { - "description": "fielddata evictions", - "name": "pri.fielddata.evictions", + "aliases": [ + "dmf", + "dataMissingFields" + ], + "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.", + "name": "data.missing_fields", "required": false, "type": { "kind": "instance_of", @@ -85580,11 +89198,11 @@ }, { "aliases": [ - "qcm", - "queryCacheMemory" + "doot", + "dataOutOfOrderTimestamps" ], - "description": "used query cache", - "name": "query_cache.memory_size", + "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.", + "name": "data.out_of_order_timestamps", "required": false, "type": { "kind": "instance_of", @@ -85595,8 +89213,12 @@ } }, { - "description": "used query cache", - "name": "pri.query_cache.memory_size", + "aliases": [ + "deb", + "dataEmptyBuckets" + ], + "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`.", + "name": "data.empty_buckets", "required": false, "type": { "kind": "instance_of", @@ -85608,11 +89230,11 @@ }, { "aliases": [ - "qce", - "queryCacheEvictions" + "dsb", + "dataSparseBuckets" ], - "description": "query cache evictions", - "name": "query_cache.evictions", + "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`.", + "name": "data.sparse_buckets", "required": false, "type": { "kind": "instance_of", @@ -85623,8 +89245,12 @@ } }, { - "description": "query cache evictions", - "name": "pri.query_cache.evictions", + "aliases": [ + "db", + "dataBuckets" + ], + "description": "The total number of buckets processed.", + "name": "data.buckets", "required": false, "type": { "kind": "instance_of", @@ -85636,11 +89262,11 @@ }, { "aliases": [ - "rcm", - "requestCacheMemory" + "der", + "dataEarliestRecord" ], - "description": "used request cache", - "name": "request_cache.memory_size", + "description": "The timestamp of the earliest chronologically input document.", + "name": "data.earliest_record", "required": false, "type": { "kind": "instance_of", @@ -85651,8 +89277,12 @@ } }, { - "description": "used request cache", - "name": "pri.request_cache.memory_size", + "aliases": [ + "dlr", + "dataLatestRecord" + ], + "description": "The timestamp of the latest chronologically input document.", + "name": "data.latest_record", "required": false, "type": { "kind": "instance_of", @@ -85664,11 +89294,11 @@ }, { "aliases": [ - "rce", - "requestCacheEvictions" + "dl", + "dataLast" ], - "description": "request cache evictions", - "name": "request_cache.evictions", + "description": "The timestamp at which data was last analyzed, according to server time.", + "name": "data.last", "required": false, "type": { "kind": "instance_of", @@ -85679,8 +89309,12 @@ } }, { - "description": "request cache evictions", - "name": "pri.request_cache.evictions", + "aliases": [ + "dleb", + "dataLastEmptyBucket" + ], + "description": "The timestamp of the last bucket that did not contain any data.", + "name": "data.last_empty_bucket", "required": false, "type": { "kind": "instance_of", @@ -85692,11 +89326,11 @@ }, { "aliases": [ - "rchc", - "requestCacheHitCount" + "dlsb", + "dataLastSparseBucket" ], - "description": "request cache hit count", - "name": "request_cache.hit_count", + "description": "The timestamp of the last bucket that was considered sparse.", + "name": "data.last_sparse_bucket", "required": false, "type": { "kind": "instance_of", @@ -85707,52 +89341,60 @@ } }, { - "description": "request cache hit count", - "name": "pri.request_cache.hit_count", + "aliases": [ + "mb", + "modelBytes" + ], + "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.", + "name": "model.bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "rcmc", - "requestCacheMissCount" + "mms", + "modelMemoryStatus" ], - "description": "request cache miss count", - "name": "request_cache.miss_count", + "description": "The status of the mathematical models.", + "name": "model.memory_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "MemoryStatus", + "namespace": "ml._types" } } }, { - "description": "request cache miss count", - "name": "pri.request_cache.miss_count", + "aliases": [ + "mbe", + "modelBytesExceeded" + ], + "description": "The number of bytes over the high limit for memory usage at the last allocation failure.", + "name": "model.bytes_exceeded", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "ft", - "flushTotal" + "mml", + "modelMemoryLimit" ], - "description": "number of flushes", - "name": "flush.total", + "description": "The upper limit for model memory usage, checked on increasing values.", + "name": "model.memory_limit", "required": false, "type": { "kind": "instance_of", @@ -85763,8 +89405,12 @@ } }, { - "description": "number of flushes", - "name": "pri.flush.total", + "aliases": [ + "mbf", + "modelByFields" + ], + "description": "The number of `by` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.by_fields", "required": false, "type": { "kind": "instance_of", @@ -85776,11 +89422,11 @@ }, { "aliases": [ - "ftt", - "flushTotalTime" + "mof", + "modelOverFields" ], - "description": "time spent in flush", - "name": "flush.total_time", + "description": "The number of `over` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.over_fields", "required": false, "type": { "kind": "instance_of", @@ -85791,8 +89437,12 @@ } }, { - "description": "time spent in flush", - "name": "pri.flush.total_time", + "aliases": [ + "mpf", + "modelPartitionFields" + ], + "description": "The number of `partition` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.partition_fields", "required": false, "type": { "kind": "instance_of", @@ -85804,11 +89454,11 @@ }, { "aliases": [ - "gc", - "getCurrent" + "mbaf", + "modelBucketAllocationFailures" ], - "description": "number of current get ops", - "name": "get.current", + "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.", + "name": "model.bucket_allocation_failures", "required": false, "type": { "kind": "instance_of", @@ -85819,24 +89469,28 @@ } }, { - "description": "number of current get ops", - "name": "pri.get.current", + "aliases": [ + "mcs", + "modelCategorizationStatus" + ], + "description": "The status of categorization for the job.", + "name": "model.categorization_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CategorizationStatus", + "namespace": "ml._types" } } }, { "aliases": [ - "gti", - "getTime" + "mcdc", + "modelCategorizedDocCount" ], - "description": "time spent in get", - "name": "get.time", + "description": "The number of documents that have had a field categorized.", + "name": "model.categorized_doc_count", "required": false, "type": { "kind": "instance_of", @@ -85847,8 +89501,12 @@ } }, { - "description": "time spent in get", - "name": "pri.get.time", + "aliases": [ + "mtcc", + "modelTotalCategoryCount" + ], + "description": "The number of categories created by categorization.", + "name": "model.total_category_count", "required": false, "type": { "kind": "instance_of", @@ -85860,11 +89518,10 @@ }, { "aliases": [ - "gto", - "getTotal" + "modelFrequentCategoryCount" ], - "description": "number of get ops", - "name": "get.total", + "description": "The number of categories that match more than 1% of categorized documents.", + "name": "model.frequent_category_count", "required": false, "type": { "kind": "instance_of", @@ -85875,8 +89532,12 @@ } }, { - "description": "number of get ops", - "name": "pri.get.total", + "aliases": [ + "mrcc", + "modelRareCategoryCount" + ], + "description": "The number of categories that match just one categorized document.", + "name": "model.rare_category_count", "required": false, "type": { "kind": "instance_of", @@ -85888,11 +89549,11 @@ }, { "aliases": [ - "geti", - "getExistsTime" + "mdcc", + "modelDeadCategoryCount" ], - "description": "time spent in successful gets", - "name": "get.exists_time", + "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.", + "name": "model.dead_category_count", "required": false, "type": { "kind": "instance_of", @@ -85903,8 +89564,12 @@ } }, { - "description": "time spent in successful gets", - "name": "pri.get.exists_time", + "aliases": [ + "mfcc", + "modelFailedCategoryCount" + ], + "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.", + "name": "model.failed_category_count", "required": false, "type": { "kind": "instance_of", @@ -85916,11 +89581,11 @@ }, { "aliases": [ - "geto", - "getExistsTotal" + "mlt", + "modelLogTime" ], - "description": "number of successful gets", - "name": "get.exists_total", + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.log_time", "required": false, "type": { "kind": "instance_of", @@ -85931,8 +89596,12 @@ } }, { - "description": "number of successful gets", - "name": "pri.get.exists_total", + "aliases": [ + "mt", + "modelTimestamp" + ], + "description": "The timestamp of the last record when the model stats were gathered.", + "name": "model.timestamp", "required": false, "type": { "kind": "instance_of", @@ -85944,11 +89613,11 @@ }, { "aliases": [ - "gmti", - "getMissingTime" + "ft", + "forecastsTotal" ], - "description": "time spent in failed gets", - "name": "get.missing_time", + "description": "The number of individual forecasts currently available for the job.\nA value of one or more indicates that forecasts exist.", + "name": "forecasts.total", "required": false, "type": { "kind": "instance_of", @@ -85959,8 +89628,12 @@ } }, { - "description": "time spent in failed gets", - "name": "pri.get.missing_time", + "aliases": [ + "fmmin", + "forecastsMemoryMin" + ], + "description": "The minimum memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.min", "required": false, "type": { "kind": "instance_of", @@ -85972,11 +89645,11 @@ }, { "aliases": [ - "gmto", - "getMissingTotal" + "fmmax", + "forecastsMemoryMax" ], - "description": "number of failed gets", - "name": "get.missing_total", + "description": "The maximum memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.max", "required": false, "type": { "kind": "instance_of", @@ -85987,8 +89660,12 @@ } }, { - "description": "number of failed gets", - "name": "pri.get.missing_total", + "aliases": [ + "fmavg", + "forecastsMemoryAvg" + ], + "description": "The average memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.avg", "required": false, "type": { "kind": "instance_of", @@ -86000,11 +89677,11 @@ }, { "aliases": [ - "idc", - "indexingDeleteCurrent" + "fmt", + "forecastsMemoryTotal" ], - "description": "number of current deletions", - "name": "indexing.delete_current", + "description": "The total memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.total", "required": false, "type": { "kind": "instance_of", @@ -86015,8 +89692,12 @@ } }, { - "description": "number of current deletions", - "name": "pri.indexing.delete_current", + "aliases": [ + "frmin", + "forecastsRecordsMin" + ], + "description": "The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.min", "required": false, "type": { "kind": "instance_of", @@ -86028,11 +89709,11 @@ }, { "aliases": [ - "idti", - "indexingDeleteTime" + "frmax", + "forecastsRecordsMax" ], - "description": "time spent in deletions", - "name": "indexing.delete_time", + "description": "The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.max", "required": false, "type": { "kind": "instance_of", @@ -86043,8 +89724,12 @@ } }, { - "description": "time spent in deletions", - "name": "pri.indexing.delete_time", + "aliases": [ + "fravg", + "forecastsRecordsAvg" + ], + "description": "The average number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.avg", "required": false, "type": { "kind": "instance_of", @@ -86056,11 +89741,11 @@ }, { "aliases": [ - "idto", - "indexingDeleteTotal" + "frt", + "forecastsRecordsTotal" ], - "description": "number of delete ops", - "name": "indexing.delete_total", + "description": "The total number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.total", "required": false, "type": { "kind": "instance_of", @@ -86071,8 +89756,12 @@ } }, { - "description": "number of delete ops", - "name": "pri.indexing.delete_total", + "aliases": [ + "ftmin", + "forecastsTimeMin" + ], + "description": "The minimum runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.min", "required": false, "type": { "kind": "instance_of", @@ -86084,11 +89773,11 @@ }, { "aliases": [ - "iic", - "indexingIndexCurrent" + "ftmax", + "forecastsTimeMax" ], - "description": "number of current indexing ops", - "name": "indexing.index_current", + "description": "The maximum runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.max", "required": false, "type": { "kind": "instance_of", @@ -86099,8 +89788,12 @@ } }, { - "description": "number of current indexing ops", - "name": "pri.indexing.index_current", + "aliases": [ + "ftavg", + "forecastsTimeAvg" + ], + "description": "The average runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.avg", "required": false, "type": { "kind": "instance_of", @@ -86112,11 +89805,11 @@ }, { "aliases": [ - "iiti", - "indexingIndexTime" + "ftt", + "forecastsTimeTotal" ], - "description": "time spent in indexing", - "name": "indexing.index_time", + "description": "The total runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.total", "required": false, "type": { "kind": "instance_of", @@ -86127,24 +89820,28 @@ } }, { - "description": "time spent in indexing", - "name": "pri.indexing.index_time", + "aliases": [ + "ni", + "nodeId" + ], + "description": "The uniqe identifier of the assigned node.", + "name": "node.id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "iito", - "indexingIndexTotal" + "nn", + "nodeName" ], - "description": "number of indexing ops", - "name": "indexing.index_total", + "description": "The name of the assigned node.", + "name": "node.name", "required": false, "type": { "kind": "instance_of", @@ -86155,24 +89852,28 @@ } }, { - "description": "number of indexing ops", - "name": "pri.indexing.index_total", + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral identifier of the assigned node.", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "iif", - "indexingIndexFailed" + "na", + "nodeAddress" ], - "description": "number of failed indexing ops", - "name": "indexing.index_failed", + "description": "The network address of the assigned node.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -86183,8 +89884,12 @@ } }, { - "description": "number of failed indexing ops", - "name": "pri.indexing.index_failed", + "aliases": [ + "bc", + "bucketsCount" + ], + "description": "The number of bucket results produced by the job.", + "name": "buckets.count", "required": false, "type": { "kind": "instance_of", @@ -86196,11 +89901,11 @@ }, { "aliases": [ - "mc", - "mergesCurrent" + "btt", + "bucketsTimeTotal" ], - "description": "number of current merges", - "name": "merges.current", + "description": "The sum of all bucket processing times, in milliseconds.", + "name": "buckets.time.total", "required": false, "type": { "kind": "instance_of", @@ -86211,8 +89916,12 @@ } }, { - "description": "number of current merges", - "name": "pri.merges.current", + "aliases": [ + "btmin", + "bucketsTimeMin" + ], + "description": "The minimum of all bucket processing times, in milliseconds.", + "name": "buckets.time.min", "required": false, "type": { "kind": "instance_of", @@ -86224,11 +89933,11 @@ }, { "aliases": [ - "mcd", - "mergesCurrentDocs" + "btmax", + "bucketsTimeMax" ], - "description": "number of current merging docs", - "name": "merges.current_docs", + "description": "The maximum of all bucket processing times, in milliseconds.", + "name": "buckets.time.max", "required": false, "type": { "kind": "instance_of", @@ -86239,8 +89948,12 @@ } }, { - "description": "number of current merging docs", - "name": "pri.merges.current_docs", + "aliases": [ + "btea", + "bucketsTimeExpAvg" + ], + "description": "The exponential moving average of all bucket processing times, in milliseconds.", + "name": "buckets.time.exp_avg", "required": false, "type": { "kind": "instance_of", @@ -86252,11 +89965,11 @@ }, { "aliases": [ - "mcs", - "mergesCurrentSize" + "bteah", + "bucketsTimeExpAvgHour" ], - "description": "size of current merges", - "name": "merges.current_size", + "description": "The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.", + "name": "buckets.time.exp_avg_hour", "required": false, "type": { "kind": "instance_of", @@ -86265,205 +89978,289 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_jobs/types.ts#L24-L347" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.ml_jobs" + }, + "path": [ { - "description": "size of current merges", - "name": "pri.merges.current_size", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "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.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "mt", - "mergesTotal" - ], - "description": "number of completed merge ops", - "name": "merges.total", + "description": "The unit used to display byte values.", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Bytes", + "namespace": "_types" } } }, { - "description": "number of completed merge ops", - "name": "pri.merges.total", + "description": "Comma-separated list of column names to display.", + "name": "h", "required": false, + "serverDefault": "buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatAnonalyDetectorColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "mtd", - "mergesTotalDocs" - ], - "description": "docs merged", - "name": "merges.total_docs", + "description": "Comma-separated list of column names or column aliases used to sort the response.", + "name": "s", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatAnonalyDetectorColumns", + "namespace": "cat._types" } } }, { - "description": "docs merged", - "name": "pri.merges.total_docs", + "description": "The unit used to display time values.", + "name": "time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TimeUnit", + "namespace": "_types" } } - }, - { - "aliases": [ - "mts", - "mergesTotalSize" - ], - "description": "size merged", - "name": "merges.total_size", - "required": false, - "type": { + } + ], + "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L24-L77" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "JobsRecord", + "namespace": "cat.ml_jobs" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.ml_jobs" + }, + "specLocation": "cat/ml_jobs/CatJobsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns configuration and usage information about inference trained models.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.ml_trained_models" + }, + "path": [ { - "description": "size merged", - "name": "pri.merges.total_size", + "description": "A unique identifier for the trained model.", + "name": "model_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "mtt", - "mergesTotalTime" - ], - "description": "time spent in merges", - "name": "merges.total_time", + "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.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "time spent in merges", - "name": "pri.merges.total_time", + "description": "The unit used to display byte values.", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Bytes", + "namespace": "_types" } } }, { - "aliases": [ - "rto", - "refreshTotal" - ], - "description": "total refreshes", - "name": "refresh.total", + "description": "A comma-separated list of column names to display.", + "name": "h", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatTrainedModelsColumns", + "namespace": "cat._types" } } }, { - "description": "total refreshes", - "name": "pri.refresh.total", + "description": "A comma-separated list of column names or aliases used to sort the response.", + "name": "s", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatTrainedModelsColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "rti", - "refreshTime" - ], - "description": "time spent in refreshes", - "name": "refresh.time", + "description": "Skips the specified number of transforms.", + "name": "from", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "time spent in refreshes", - "name": "pri.refresh.time", + "description": "The maximum number of transforms to display.", + "name": "size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L63" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TrainedModelsRecord", + "namespace": "cat.ml_trained_models" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.ml_trained_models" + }, + "specLocation": "cat/ml_trained_models/CatTrainedModelsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TrainedModelsRecord", + "namespace": "cat.ml_trained_models" + }, + "properties": [ { - "aliases": [ - "reto" - ], - "description": "total external refreshes", - "name": "refresh.external_total", + "description": "The model identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "description": "total external refreshes", - "name": "pri.refresh.external_total", + "aliases": [ + "c", + "createdBy" + ], + "description": "Information about the creator of the model.", + "name": "created_by", "required": false, "type": { "kind": "instance_of", @@ -86475,22 +90272,27 @@ }, { "aliases": [ - "reti" + "hs", + "modelHeapSize" ], - "description": "time spent in external refreshes", - "name": "refresh.external_time", + "description": "The estimated heap size to keep the model in memory.", + "name": "heap_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "description": "time spent in external refreshes", - "name": "pri.refresh.external_time", + "aliases": [ + "o", + "modelOperations" + ], + "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.", + "name": "operations", "required": false, "type": { "kind": "instance_of", @@ -86502,11 +90304,10 @@ }, { "aliases": [ - "rli", - "refreshListeners" + "l" ], - "description": "number of pending refresh listeners", - "name": "refresh.listeners", + "description": "The license level of the model.", + "name": "license", "required": false, "type": { "kind": "instance_of", @@ -86517,36 +90318,41 @@ } }, { - "description": "number of pending refresh listeners", - "name": "pri.refresh.listeners", + "aliases": [ + "ct" + ], + "description": "The time the model was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { "aliases": [ - "sfc", - "searchFetchCurrent" + "v" ], - "description": "current fetch phase ops", - "name": "search.fetch_current", + "description": "The version of Elasticsearch when the model was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { - "description": "current fetch phase ops", - "name": "pri.search.fetch_current", + "aliases": [ + "d" + ], + "description": "A description of the model.", + "name": "description", "required": false, "type": { "kind": "instance_of", @@ -86558,11 +90364,11 @@ }, { "aliases": [ - "sfti", - "searchFetchTime" + "ip", + "ingestPipelines" ], - "description": "time spent in fetch phase", - "name": "search.fetch_time", + "description": "The number of pipelines that are referencing the model.", + "name": "ingest.pipelines", "required": false, "type": { "kind": "instance_of", @@ -86573,8 +90379,12 @@ } }, { - "description": "time spent in fetch phase", - "name": "pri.search.fetch_time", + "aliases": [ + "ic", + "ingestCount" + ], + "description": "The total number of documents that are processed by the model.", + "name": "ingest.count", "required": false, "type": { "kind": "instance_of", @@ -86586,11 +90396,11 @@ }, { "aliases": [ - "sfto", - "searchFetchTotal" + "it", + "ingestTime" ], - "description": "total fetch ops", - "name": "search.fetch_total", + "description": "The total time spent processing documents with thie model.", + "name": "ingest.time", "required": false, "type": { "kind": "instance_of", @@ -86601,8 +90411,12 @@ } }, { - "description": "total fetch ops", - "name": "pri.search.fetch_total", + "aliases": [ + "icurr", + "ingestCurrent" + ], + "description": "The total number of documents that are currently being handled by the model.", + "name": "ingest.current", "required": false, "type": { "kind": "instance_of", @@ -86614,11 +90428,11 @@ }, { "aliases": [ - "so", - "searchOpenContexts" + "if", + "ingestFailed" ], - "description": "open search contexts", - "name": "search.open_contexts", + "description": "The total number of failed ingest attempts with the model.", + "name": "ingest.failed", "required": false, "type": { "kind": "instance_of", @@ -86629,8 +90443,12 @@ } }, { - "description": "open search contexts", - "name": "pri.search.open_contexts", + "aliases": [ + "dfid", + "dataFrameAnalytics" + ], + "description": "The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available.", + "name": "data_frame.id", "required": false, "type": { "kind": "instance_of", @@ -86642,11 +90460,11 @@ }, { "aliases": [ - "sqc", - "searchQueryCurrent" + "dft", + "dataFrameAnalyticsTime" ], - "description": "current query phase ops", - "name": "search.query_current", + "description": "The time the data frame analytics job was created.", + "name": "data_frame.create_time", "required": false, "type": { "kind": "instance_of", @@ -86657,8 +90475,12 @@ } }, { - "description": "current query phase ops", - "name": "pri.search.query_current", + "aliases": [ + "dfsi", + "dataFrameAnalyticsSrcIndex" + ], + "description": "The source index used to train in the data frame analysis.", + "name": "data_frame.source_index", "required": false, "type": { "kind": "instance_of", @@ -86670,11 +90492,11 @@ }, { "aliases": [ - "sqti", - "searchQueryTime" + "dfa", + "dataFrameAnalyticsAnalysis" ], - "description": "time spent in query phase", - "name": "search.query_time", + "description": "The analysis used by the data frame to build the model.", + "name": "data_frame.analysis", "required": false, "type": { "kind": "instance_of", @@ -86685,9 +90507,15 @@ } }, { - "description": "time spent in query phase", - "name": "pri.search.query_time", + "availability": { + "serverless": {}, + "stack": { + "since": "8.0.0" + } + }, + "name": "type", "required": false, + "since": "8.0.0", "type": { "kind": "instance_of", "type": { @@ -86695,14 +90523,20 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_trained_models/types.ts#L23-L115" + }, + { + "kind": "interface", + "name": { + "name": "NodeAttributesRecord", + "namespace": "cat.nodeattrs" + }, + "properties": [ { - "aliases": [ - "sqto", - "searchQueryTotal" - ], - "description": "total query phase ops", - "name": "search.query_total", + "description": "The node name.", + "name": "node", "required": false, "type": { "kind": "instance_of", @@ -86713,8 +90547,8 @@ } }, { - "description": "total query phase ops", - "name": "pri.search.query_total", + "description": "The unique node identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", @@ -86725,12 +90559,8 @@ } }, { - "aliases": [ - "scc", - "searchScrollCurrent" - ], - "description": "open scroll contexts", - "name": "search.scroll_current", + "description": "The process identifier.", + "name": "pid", "required": false, "type": { "kind": "instance_of", @@ -86741,8 +90571,11 @@ } }, { - "description": "open scroll contexts", - "name": "pri.search.scroll_current", + "aliases": [ + "h" + ], + "description": "The host name.", + "name": "host", "required": false, "type": { "kind": "instance_of", @@ -86754,11 +90587,10 @@ }, { "aliases": [ - "scti", - "searchScrollTime" + "i" ], - "description": "time scroll contexts held open", - "name": "search.scroll_time", + "description": "The IP address.", + "name": "ip", "required": false, "type": { "kind": "instance_of", @@ -86769,8 +90601,8 @@ } }, { - "description": "time scroll contexts held open", - "name": "pri.search.scroll_time", + "description": "The bound transport port.", + "name": "port", "required": false, "type": { "kind": "instance_of", @@ -86781,12 +90613,8 @@ } }, { - "aliases": [ - "scto", - "searchScrollTotal" - ], - "description": "completed scroll contexts", - "name": "search.scroll_total", + "description": "The attribute name.", + "name": "attr", "required": false, "type": { "kind": "instance_of", @@ -86797,8 +90625,8 @@ } }, { - "description": "completed scroll contexts", - "name": "pri.search.scroll_total", + "description": "The attribute value.", + "name": "value", "required": false, "type": { "kind": "instance_of", @@ -86807,26 +90635,83 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/nodeattrs/types.ts#L20-L55" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.nodeattrs" + }, + "path": [], + "query": [], + "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L22-L31" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "NodeAttributesRecord", + "namespace": "cat.nodeattrs" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.nodeattrs" + }, + "specLocation": "cat/nodeattrs/CatNodeAttributesResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "NodesRecord", + "namespace": "cat.nodes" + }, + "properties": [ { "aliases": [ - "sc", - "segmentsCount" + "nodeId" ], - "description": "number of segments", - "name": "segments.count", + "description": "The unique node identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "description": "number of segments", - "name": "pri.segments.count", + "aliases": [ + "p" + ], + "description": "The process identifier.", + "name": "pid", "required": false, "type": { "kind": "instance_of", @@ -86838,11 +90723,10 @@ }, { "aliases": [ - "sm", - "segmentsMemory" + "i" ], - "description": "memory used by segments", - "name": "segments.memory", + "description": "The IP address.", + "name": "ip", "required": false, "type": { "kind": "instance_of", @@ -86853,8 +90737,11 @@ } }, { - "description": "memory used by segments", - "name": "pri.segments.memory", + "aliases": [ + "po" + ], + "description": "The bound transport port.", + "name": "port", "required": false, "type": { "kind": "instance_of", @@ -86866,11 +90753,10 @@ }, { "aliases": [ - "siwm", - "segmentsIndexWriterMemory" + "http" ], - "description": "memory used by index writer", - "name": "segments.index_writer_memory", + "description": "The bound HTTP address.", + "name": "http_address", "required": false, "type": { "kind": "instance_of", @@ -86881,24 +90767,26 @@ } }, { - "description": "memory used by index writer", - "name": "pri.segments.index_writer_memory", + "aliases": [ + "v" + ], + "description": "The Elasticsearch version.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { "aliases": [ - "svmm", - "segmentsVersionMapMemory" + "f" ], - "description": "memory used by version map", - "name": "segments.version_map_memory", + "description": "The Elasticsearch distribution flavor.", + "name": "flavor", "required": false, "type": { "kind": "instance_of", @@ -86909,8 +90797,11 @@ } }, { - "description": "memory used by version map", - "name": "pri.segments.version_map_memory", + "aliases": [ + "t" + ], + "description": "The Elasticsearch distribution type.", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -86922,11 +90813,10 @@ }, { "aliases": [ - "sfbm", - "fixedBitsetMemory" + "b" ], - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "segments.fixed_bitset_memory", + "description": "The Elasticsearch build hash.", + "name": "build", "required": false, "type": { "kind": "instance_of", @@ -86937,8 +90827,11 @@ } }, { - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "pri.segments.fixed_bitset_memory", + "aliases": [ + "j" + ], + "description": "The Java version.", + "name": "jdk", "required": false, "type": { "kind": "instance_of", @@ -86950,67 +90843,77 @@ }, { "aliases": [ - "wc", - "warmerCurrent" + "dt", + "diskTotal" ], - "description": "current warmer ops", - "name": "warmer.current", + "description": "The total disk space.", + "name": "disk.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "description": "current warmer ops", - "name": "pri.warmer.current", + "aliases": [ + "du", + "diskUsed" + ], + "description": "The used disk space.", + "name": "disk.used", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "wto", - "warmerTotal" + "d", + "da", + "disk", + "diskAvail" ], - "description": "total warmer ops", - "name": "warmer.total", + "description": "The available disk space.", + "name": "disk.avail", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "description": "total warmer ops", - "name": "pri.warmer.total", + "aliases": [ + "dup", + "diskUsedPercent" + ], + "description": "The used disk space percentage.", + "name": "disk.used_percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Percentage", + "namespace": "_types" } } }, { "aliases": [ - "wtt", - "warmerTotalTime" + "hc", + "heapCurrent" ], - "description": "time spent in warmers", - "name": "warmer.total_time", + "description": "The used heap.", + "name": "heap.current", "required": false, "type": { "kind": "instance_of", @@ -87021,24 +90924,28 @@ } }, { - "description": "time spent in warmers", - "name": "pri.warmer.total_time", + "aliases": [ + "hp", + "heapPercent" + ], + "description": "The used heap ratio.", + "name": "heap.percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Percentage", + "namespace": "_types" } } }, { "aliases": [ - "suc", - "suggestCurrent" + "hm", + "heapMax" ], - "description": "number of current suggest ops", - "name": "suggest.current", + "description": "The maximum configured heap.", + "name": "heap.max", "required": false, "type": { "kind": "instance_of", @@ -87049,8 +90956,12 @@ } }, { - "description": "number of current suggest ops", - "name": "pri.suggest.current", + "aliases": [ + "rc", + "ramCurrent" + ], + "description": "The used machine memory.", + "name": "ram.current", "required": false, "type": { "kind": "instance_of", @@ -87062,23 +90973,27 @@ }, { "aliases": [ - "suti", - "suggestTime" + "rp", + "ramPercent" ], - "description": "time spend in suggest", - "name": "suggest.time", + "description": "The used machine memory ratio.", + "name": "ram.percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Percentage", + "namespace": "_types" } } }, { - "description": "time spend in suggest", - "name": "pri.suggest.time", + "aliases": [ + "rn", + "ramMax" + ], + "description": "The total machine memory.", + "name": "ram.max", "required": false, "type": { "kind": "instance_of", @@ -87090,11 +91005,11 @@ }, { "aliases": [ - "suto", - "suggestTotal" + "fdc", + "fileDescriptorCurrent" ], - "description": "number of suggest ops", - "name": "suggest.total", + "description": "The used file descriptors.", + "name": "file_desc.current", "required": false, "type": { "kind": "instance_of", @@ -87105,24 +91020,28 @@ } }, { - "description": "number of suggest ops", - "name": "pri.suggest.total", + "aliases": [ + "fdp", + "fileDescriptorPercent" + ], + "description": "The used file descriptor ratio.", + "name": "file_desc.percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Percentage", + "namespace": "_types" } } }, { "aliases": [ - "tm", - "memoryTotal" + "fdm", + "fileDescriptorMax" ], - "description": "total used memory", - "name": "memory.total", + "description": "The maximum number of file descriptors.", + "name": "file_desc.max", "required": false, "type": { "kind": "instance_of", @@ -87133,8 +91052,8 @@ } }, { - "description": "total user memory", - "name": "pri.memory.total", + "description": "The recent system CPU usage as a percentage.", + "name": "cpu", "required": false, "type": { "kind": "instance_of", @@ -87145,11 +91064,8 @@ } }, { - "aliases": [ - "sth" - ], - "description": "indicates if the index is search throttled", - "name": "search.throttled", + "description": "The load average for the most recent minute.", + "name": "load_1m", "required": false, "type": { "kind": "instance_of", @@ -87160,12 +91076,8 @@ } }, { - "aliases": [ - "bto", - "bulkTotalOperation" - ], - "description": "number of bulk shard ops", - "name": "bulk.total_operations", + "description": "The load average for the last five minutes.", + "name": "load_5m", "required": false, "type": { "kind": "instance_of", @@ -87176,8 +91088,11 @@ } }, { - "description": "number of bulk shard ops", - "name": "pri.bulk.total_operations", + "aliases": [ + "l" + ], + "description": "The load average for the last fifteen minutes.", + "name": "load_15m", "required": false, "type": { "kind": "instance_of", @@ -87189,11 +91104,10 @@ }, { "aliases": [ - "btti", - "bulkTotalTime" + "u" ], - "description": "time spend in shard bulk", - "name": "bulk.total_time", + "description": "The node uptime.", + "name": "uptime", "required": false, "type": { "kind": "instance_of", @@ -87204,8 +91118,13 @@ } }, { - "description": "time spend in shard bulk", - "name": "pri.bulk.total_time", + "aliases": [ + "r", + "role", + "nodeRole" + ], + "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).", + "name": "node.role", "required": false, "type": { "kind": "instance_of", @@ -87217,11 +91136,10 @@ }, { "aliases": [ - "btsi", - "bulkTotalSizeInBytes" + "m" ], - "description": "total size in bytes of shard bulk", - "name": "bulk.total_size_in_bytes", + "description": "Indicates whether the node is the elected master node.\nReturned values include `*`(elected master) and `-`(not elected master).", + "name": "master", "required": false, "type": { "kind": "instance_of", @@ -87232,24 +91150,27 @@ } }, { - "description": "total size in bytes of shard bulk", - "name": "pri.bulk.total_size_in_bytes", + "aliases": [ + "n" + ], + "description": "The node name.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { "aliases": [ - "bati", - "bulkAvgTime" + "cs", + "completionSize" ], - "description": "average time spend in shard bulk", - "name": "bulk.avg_time", + "description": "The size of completion.", + "name": "completion.size", "required": false, "type": { "kind": "instance_of", @@ -87260,8 +91181,12 @@ } }, { - "description": "average time spend in shard bulk", - "name": "pri.bulk.avg_time", + "aliases": [ + "fm", + "fielddataMemory" + ], + "description": "The used fielddata cache.", + "name": "fielddata.memory_size", "required": false, "type": { "kind": "instance_of", @@ -87273,11 +91198,11 @@ }, { "aliases": [ - "basi", - "bulkAvgSizeInBytes" + "fe", + "fielddataEvictions" ], - "description": "average size in bytes of shard bulk", - "name": "bulk.avg_size_in_bytes", + "description": "The fielddata evictions.", + "name": "fielddata.evictions", "required": false, "type": { "kind": "instance_of", @@ -87288,8 +91213,12 @@ } }, { - "description": "average size in bytes of shard bulk", - "name": "pri.bulk.avg_size_in_bytes", + "aliases": [ + "qcm", + "queryCacheMemory" + ], + "description": "The used query cache.", + "name": "query_cache.memory_size", "required": false, "type": { "kind": "instance_of", @@ -87298,153 +91227,126 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/indices/types.ts#L20-L801" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.indices" - }, - "path": [ + }, { - "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`.", - "name": "index", + "aliases": [ + "qce", + "queryCacheEvictions" + ], + "description": "The query cache evictions.", + "name": "query_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "description": "The unit used to display byte values.", - "name": "bytes", + "aliases": [ + "qchc", + "queryCacheHitCount" + ], + "description": "The query cache hit counts.", + "name": "query_cache.hit_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The type of index that wildcard patterns can match.", - "name": "expand_wildcards", + "aliases": [ + "qcmc", + "queryCacheMissCount" + ], + "description": "The query cache miss counts.", + "name": "query_cache.miss_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The health status used to limit returned indices. By default, the response includes indices of any health status.", - "name": "health", + "aliases": [ + "rcm", + "requestCacheMemory" + ], + "description": "The used request cache.", + "name": "request_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HealthStatus", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If true, the response includes information from segments that are not loaded into memory.", - "name": "include_unloaded_segments", + "aliases": [ + "rce", + "requestCacheEvictions" + ], + "description": "The request cache evictions.", + "name": "request_cache.evictions", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "If true, the response only includes information from primary shards.", - "name": "pri", + "aliases": [ + "rchc", + "requestCacheHitCount" + ], + "description": "The request cache hit counts.", + "name": "request_cache.hit_count", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The unit used to display time values.", - "name": "time", + "aliases": [ + "rcmc", + "requestCacheMissCount" + ], + "description": "The request cache miss counts.", + "name": "request_cache.miss_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } - } - ], - "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L68" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesRecord", - "namespace": "cat.indices" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.indices" - }, - "specLocation": "cat/indices/CatIndicesResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "MasterRecord", - "namespace": "cat.master" - }, - "properties": [ + }, { - "description": "node id", - "name": "id", + "aliases": [ + "ft", + "flushTotal" + ], + "description": "The number of flushes.", + "name": "flush.total", "required": false, "type": { "kind": "instance_of", @@ -87456,10 +91358,11 @@ }, { "aliases": [ - "h" + "ftt", + "flushTotalTime" ], - "description": "host name", - "name": "host", + "description": "The time spent in flush.", + "name": "flush.total_time", "required": false, "type": { "kind": "instance_of", @@ -87470,8 +91373,12 @@ } }, { - "description": "ip address", - "name": "ip", + "aliases": [ + "gc", + "getCurrent" + ], + "description": "The number of current get ops.", + "name": "get.current", "required": false, "type": { "kind": "instance_of", @@ -87483,10 +91390,11 @@ }, { "aliases": [ - "n" + "gti", + "getTime" ], - "description": "node name", - "name": "node", + "description": "The time spent in get.", + "name": "get.time", "required": false, "type": { "kind": "instance_of", @@ -87495,80 +91403,30 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/master/types.ts#L20-L39" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.master" - }, - "path": [], - "query": [], - "specLocation": "cat/master/CatMasterRequest.ts#L22-L31" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "MasterRecord", - "namespace": "cat.master" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.master" - }, - "specLocation": "cat/master/CatMasterResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "DataFrameAnalyticsRecord", - "namespace": "cat.ml_data_frame_analytics" - }, - "properties": [ + }, { - "description": "The identifier for the job.", - "name": "id", + "aliases": [ + "gto", + "getTotal" + ], + "description": "The number of get ops.", + "name": "get.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "t" + "geti", + "getExistsTime" ], - "description": "The type of analysis that the job performs.", - "name": "type", + "description": "The time spent in successful gets.", + "name": "get.exists_time", "required": false, "type": { "kind": "instance_of", @@ -87580,11 +91438,11 @@ }, { "aliases": [ - "ct", - "createTime" + "geto", + "getExistsTotal" ], - "description": "The time when the job was created.", - "name": "create_time", + "description": "The number of successful get operations.", + "name": "get.exists_total", "required": false, "type": { "kind": "instance_of", @@ -87596,57 +91454,59 @@ }, { "aliases": [ - "v" + "gmti", + "getMissingTime" ], - "description": "The version of Elasticsearch when the job was created.", - "name": "version", + "description": "The time spent in failed gets.", + "name": "get.missing_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "si", - "sourceIndex" + "gmto", + "getMissingTotal" ], - "description": "The name of the source index.", - "name": "source_index", + "description": "The number of failed gets.", + "name": "get.missing_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "di", - "destIndex" + "idc", + "indexingDeleteCurrent" ], - "description": "The name of the destination index.", - "name": "dest_index", + "description": "The number of current deletions.", + "name": "indexing.delete_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "d" + "idti", + "indexingDeleteTime" ], - "description": "A description of the job.", - "name": "description", + "description": "The time spent in deletions.", + "name": "indexing.delete_time", "required": false, "type": { "kind": "instance_of", @@ -87658,11 +91518,11 @@ }, { "aliases": [ - "mml", - "modelMemoryLimit" + "idto", + "indexingDeleteTotal" ], - "description": "The approximate maximum amount of memory resources that are permitted for the job.", - "name": "model_memory_limit", + "description": "The number of delete operations.", + "name": "indexing.delete_total", "required": false, "type": { "kind": "instance_of", @@ -87674,10 +91534,11 @@ }, { "aliases": [ - "s" + "iic", + "indexingIndexCurrent" ], - "description": "The current status of the job.", - "name": "state", + "description": "The number of current indexing operations.", + "name": "indexing.index_current", "required": false, "type": { "kind": "instance_of", @@ -87689,11 +91550,11 @@ }, { "aliases": [ - "fr", - "failureReason" + "iiti", + "indexingIndexTime" ], - "description": "Messages about the reason why the job failed.", - "name": "failure_reason", + "description": "The time spent in indexing.", + "name": "indexing.index_time", "required": false, "type": { "kind": "instance_of", @@ -87705,10 +91566,11 @@ }, { "aliases": [ - "p" + "iito", + "indexingIndexTotal" ], - "description": "The progress report for the job by phase.", - "name": "progress", + "description": "The number of indexing operations.", + "name": "indexing.index_total", "required": false, "type": { "kind": "instance_of", @@ -87720,11 +91582,11 @@ }, { "aliases": [ - "ae", - "assignmentExplanation" + "iif", + "indexingIndexFailed" ], - "description": "Messages related to the selection of a node.", - "name": "assignment_explanation", + "description": "The number of failed indexing operations.", + "name": "indexing.index_failed", "required": false, "type": { "kind": "instance_of", @@ -87736,59 +91598,59 @@ }, { "aliases": [ - "ni", - "nodeId" + "mc", + "mergesCurrent" ], - "description": "The unique identifier of the assigned node.", - "name": "node.id", + "description": "The number of current merges.", + "name": "merges.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "nn", - "nodeName" + "mcd", + "mergesCurrentDocs" ], - "description": "The name of the assigned node.", - "name": "node.name", + "description": "The number of current merging docs.", + "name": "merges.current_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ne", - "nodeEphemeralId" + "mcs", + "mergesCurrentSize" ], - "description": "The ephemeral identifier of the assigned node.", - "name": "node.ephemeral_id", + "description": "The size of current merges.", + "name": "merges.current_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "na", - "nodeAddress" + "mt", + "mergesTotal" ], - "description": "The network address of the assigned node.", - "name": "node.address", + "description": "The number of completed merge operations.", + "name": "merges.total", "required": false, "type": { "kind": "instance_of", @@ -87797,140 +91659,118 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_data_frame_analytics/types.ts#L22-L102" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.ml_data_frame_analytics" - }, - "path": [ + }, { - "description": "The ID of the data frame analytics to fetch", - "name": "id", + "aliases": [ + "mtd", + "mergesTotalDocs" + ], + "description": "The docs merged.", + "name": "merges.total_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)", - "name": "allow_no_match", + "aliases": [ + "mts", + "mergesTotalSize" + ], + "description": "The size merged.", + "name": "merges.total_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The unit in which to display byte values", - "name": "bytes", + "aliases": [ + "mtt", + "mergesTotalTime" + ], + "description": "The time spent in merges.", + "name": "merges.total_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Comma-separated list of column names to display.", - "name": "h", + "description": "The total refreshes.", + "name": "refresh.total", "required": false, - "serverDefault": "create_time,id,state,type", "type": { "kind": "instance_of", "type": { - "name": "CatDfaColumns", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Comma-separated list of column names or column aliases used to sort the\nresponse.", - "name": "s", + "description": "The time spent in refreshes.", + "name": "refresh.time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CatDfaColumns", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Unit used to display time values.", - "name": "time", + "aliases": [ + "rto", + "refreshTotal" + ], + "description": "The total external refreshes.", + "name": "refresh.external_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L58" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "aliases": [ + "rti", + "refreshTime" + ], + "description": "The time spent in external refreshes.", + "name": "refresh.external_time", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DataFrameAnalyticsRecord", - "namespace": "cat.ml_data_frame_analytics" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.ml_data_frame_analytics" - }, - "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "DatafeedsRecord", - "namespace": "cat.ml_datafeeds" - }, - "properties": [ + }, { - "description": "The datafeed identifier.", - "name": "id", + "aliases": [ + "rli", + "refreshListeners" + ], + "description": "The number of pending refresh listeners.", + "name": "refresh.listeners", "required": false, "type": { "kind": "instance_of", @@ -87942,25 +91782,27 @@ }, { "aliases": [ - "s" + "scrcc", + "scriptCompilations" ], - "description": "The status of the datafeed.", - "name": "state", + "description": "The total script compilations.", + "name": "script.compilations", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedState", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ae" + "scrce", + "scriptCacheEvictions" ], - "description": "For started datafeeds only, contains messages relating to the selection of a node.", - "name": "assignment_explanation", + "description": "The total compiled scripts evicted from the cache.", + "name": "script.cache_evictions", "required": false, "type": { "kind": "instance_of", @@ -87972,11 +91814,11 @@ }, { "aliases": [ - "bc", - "bucketsCount" + "scrclt", + "scriptCacheCompilationLimitTriggered" ], - "description": "The number of buckets processed.", - "name": "buckets.count", + "description": "The script cache compilation limit triggered.", + "name": "script.compilation_limit_triggered", "required": false, "type": { "kind": "instance_of", @@ -87988,11 +91830,11 @@ }, { "aliases": [ - "sc", - "searchCount" + "sfc", + "searchFetchCurrent" ], - "description": "The number of searches run by the datafeed.", - "name": "search.count", + "description": "The current fetch phase operations.", + "name": "search.fetch_current", "required": false, "type": { "kind": "instance_of", @@ -88004,11 +91846,11 @@ }, { "aliases": [ - "st", - "searchTime" + "sfti", + "searchFetchTime" ], - "description": "The total time the datafeed spent searching, in milliseconds.", - "name": "search.time", + "description": "The time spent in fetch phase.", + "name": "search.fetch_time", "required": false, "type": { "kind": "instance_of", @@ -88020,11 +91862,11 @@ }, { "aliases": [ - "sba", - "searchBucketAvg" + "sfto", + "searchFetchTotal" ], - "description": "The average search time per bucket, in milliseconds.", - "name": "search.bucket_avg", + "description": "The total fetch operations.", + "name": "search.fetch_total", "required": false, "type": { "kind": "instance_of", @@ -88036,11 +91878,11 @@ }, { "aliases": [ - "seah", - "searchExpAvgHour" + "so", + "searchOpenContexts" ], - "description": "The exponential average search time per hour, in milliseconds.", - "name": "search.exp_avg_hour", + "description": "The open search contexts.", + "name": "search.open_contexts", "required": false, "type": { "kind": "instance_of", @@ -88052,11 +91894,11 @@ }, { "aliases": [ - "ni", - "nodeId" + "sqc", + "searchQueryCurrent" ], - "description": "The unique identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.id", + "description": "The current query phase operations.", + "name": "search.query_current", "required": false, "type": { "kind": "instance_of", @@ -88068,11 +91910,11 @@ }, { "aliases": [ - "nn", - "nodeName" + "sqti", + "searchQueryTime" ], - "description": "The name of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.name", + "description": "The time spent in query phase.", + "name": "search.query_time", "required": false, "type": { "kind": "instance_of", @@ -88084,11 +91926,11 @@ }, { "aliases": [ - "ne", - "nodeEphemeralId" + "sqto", + "searchQueryTotal" ], - "description": "The ephemeral identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.ephemeral_id", + "description": "The total query phase operations.", + "name": "search.query_total", "required": false, "type": { "kind": "instance_of", @@ -88100,11 +91942,11 @@ }, { "aliases": [ - "na", - "nodeAddress" + "scc", + "searchScrollCurrent" ], - "description": "The network address of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.address", + "description": "The open scroll contexts.", + "name": "search.scroll_current", "required": false, "type": { "kind": "instance_of", @@ -88113,159 +91955,142 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_datafeeds/types.ts#L22-L87" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.ml_datafeeds" - }, - "path": [ + }, { - "description": "A numerical character string that uniquely identifies the datafeed.", - "name": "datafeed_id", + "aliases": [ + "scti", + "searchScrollTime" + ], + "description": "The time scroll contexts held open.", + "name": "search.scroll_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "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.", - "name": "allow_no_match", + "aliases": [ + "scto", + "searchScrollTotal" + ], + "description": "The completed scroll contexts.", + "name": "search.scroll_total", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Comma-separated list of column names to display.", - "name": "h", + "aliases": [ + "sc", + "segmentsCount" + ], + "description": "The number of segments.", + "name": "segments.count", "required": false, - "serverDefault": "['bc', 'id', 'sc', 's']", "type": { "kind": "instance_of", "type": { - "name": "CatDatafeedColumns", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Comma-separated list of column names or column aliases used to sort the response.", - "name": "s", + "aliases": [ + "sm", + "segmentsMemory" + ], + "description": "The memory used by segments.", + "name": "segments.memory", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CatDatafeedColumns", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The unit used to display time values.", - "name": "time", + "aliases": [ + "siwm", + "segmentsIndexWriterMemory" + ], + "description": "The memory used by the index writer.", + "name": "segments.index_writer_memory", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L73" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "aliases": [ + "svmm", + "segmentsVersionMapMemory" + ], + "description": "The memory used by the version map.", + "name": "segments.version_map_memory", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DatafeedsRecord", - "namespace": "cat.ml_datafeeds" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.ml_datafeeds" - }, - "specLocation": "cat/ml_datafeeds/CatDatafeedsResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "JobsRecord", - "namespace": "cat.ml_jobs" - }, - "properties": [ + }, { - "description": "The anomaly detection job identifier.", - "name": "id", + "aliases": [ + "sfbm", + "fixedBitsetMemory" + ], + "description": "The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields.", + "name": "segments.fixed_bitset_memory", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "s" + "suc", + "suggestCurrent" ], - "description": "The status of the anomaly detection job.", - "name": "state", + "description": "The number of current suggest operations.", + "name": "suggest.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JobState", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ot" + "suti", + "suggestTime" ], - "description": "For open jobs only, the amount of time the job has been opened.", - "name": "opened_time", + "description": "The time spend in suggest.", + "name": "suggest.time", "required": false, "type": { "kind": "instance_of", @@ -88277,10 +92102,11 @@ }, { "aliases": [ - "ae" + "suto", + "suggestTotal" ], - "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.", - "name": "assignment_explanation", + "description": "The number of suggest operations.", + "name": "suggest.total", "required": false, "type": { "kind": "instance_of", @@ -88292,11 +92118,11 @@ }, { "aliases": [ - "dpr", - "dataProcessedRecords" + "bto", + "bulkTotalOperations" ], - "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.", - "name": "data.processed_records", + "description": "The number of bulk shard operations.", + "name": "bulk.total_operations", "required": false, "type": { "kind": "instance_of", @@ -88308,11 +92134,11 @@ }, { "aliases": [ - "dpf", - "dataProcessedFields" + "btti", + "bulkTotalTime" ], - "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.", - "name": "data.processed_fields", + "description": "The time spend in shard bulk.", + "name": "bulk.total_time", "required": false, "type": { "kind": "instance_of", @@ -88324,27 +92150,27 @@ }, { "aliases": [ - "dib", - "dataInputBytes" + "btsi", + "bulkTotalSizeInBytes" ], - "description": "The number of bytes of input data posted to the anomaly detection job.", - "name": "data.input_bytes", + "description": "The total size in bytes of shard bulk.", + "name": "bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "dir", - "dataInputRecords" + "bati", + "bulkAvgTime" ], - "description": "The number of input documents posted to the anomaly detection job.", - "name": "data.input_records", + "description": "The average time spend in shard bulk.", + "name": "bulk.avg_time", "required": false, "type": { "kind": "instance_of", @@ -88356,11 +92182,11 @@ }, { "aliases": [ - "dif", - "dataInputFields" + "basi", + "bulkAvgSizeInBytes" ], - "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.", - "name": "data.input_fields", + "description": "The average size in bytes of shard bulk.", + "name": "bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -88369,14 +92195,119 @@ "namespace": "_builtins" } } + } + ], + "specLocation": "cat/nodes/types.ts#L23-L542" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.nodes" + }, + "path": [], + "query": [ + { + "description": "The unit used to display byte values.", + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Bytes", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, return the full node ID. If `false`, return the shortened node ID.", + "name": "full_id", + "required": false, + "serverDefault": "false", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, + { + "description": "If true, the response includes information from segments that are not loaded into memory.", + "name": "include_unloaded_segments", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/nodes/CatNodesRequest.ts#L23-L49" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "NodesRecord", + "namespace": "cat.nodes" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.nodes" + }, + "specLocation": "cat/nodes/CatNodesResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "PendingTasksRecord", + "namespace": "cat.pending_tasks" + }, + "properties": [ { "aliases": [ - "did", - "dataInvalidDates" + "o" ], - "description": "The number of input documents with either a missing date field or a date that could not be parsed.", - "name": "data.invalid_dates", + "description": "The task insertion order.", + "name": "insertOrder", "required": false, "type": { "kind": "instance_of", @@ -88388,11 +92319,10 @@ }, { "aliases": [ - "dmf", - "dataMissingFields" + "t" ], - "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.", - "name": "data.missing_fields", + "description": "Indicates how long the task has been in queue.", + "name": "timeInQueue", "required": false, "type": { "kind": "instance_of", @@ -88404,11 +92334,10 @@ }, { "aliases": [ - "doot", - "dataOutOfOrderTimestamps" + "p" ], - "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.", - "name": "data.out_of_order_timestamps", + "description": "The task priority.", + "name": "priority", "required": false, "type": { "kind": "instance_of", @@ -88420,11 +92349,10 @@ }, { "aliases": [ - "deb", - "dataEmptyBuckets" + "s" ], - "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`.", - "name": "data.empty_buckets", + "description": "The task source.", + "name": "source", "required": false, "type": { "kind": "instance_of", @@ -88433,30 +92361,95 @@ "namespace": "_builtins" } } + } + ], + "specLocation": "cat/pending_tasks/types.ts#L20-L41" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns cluster-level changes that have not yet been executed.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.pending_tasks" + }, + "path": [], + "query": [], + "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L22-L31" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PendingTasksRecord", + "namespace": "cat.pending_tasks" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.pending_tasks" + }, + "specLocation": "cat/pending_tasks/CatPendingTasksResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "PluginsRecord", + "namespace": "cat.plugins" + }, + "properties": [ + { + "description": "The unique node identifier.", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } }, { "aliases": [ - "dsb", - "dataSparseBuckets" + "n" ], - "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`.", - "name": "data.sparse_buckets", + "description": "The node name.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { "aliases": [ - "db", - "dataBuckets" + "c" ], - "description": "The total number of buckets processed.", - "name": "data.buckets", + "description": "The component name.", + "name": "component", "required": false, "type": { "kind": "instance_of", @@ -88468,27 +92461,25 @@ }, { "aliases": [ - "der", - "dataEarliestRecord" + "v" ], - "description": "The timestamp of the earliest chronologically input document.", - "name": "data.earliest_record", + "description": "The component version.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { "aliases": [ - "dlr", - "dataLatestRecord" + "d" ], - "description": "The timestamp of the latest chronologically input document.", - "name": "data.latest_record", + "description": "The plugin details.", + "name": "description", "required": false, "type": { "kind": "instance_of", @@ -88500,11 +92491,10 @@ }, { "aliases": [ - "dl", - "dataLast" + "t" ], - "description": "The timestamp at which data was last analyzed, according to server time.", - "name": "data.last", + "description": "The plugin type.", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -88513,30 +92503,85 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/plugins/types.ts#L22-L52" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.plugins" + }, + "path": [], + "query": [], + "specLocation": "cat/plugins/CatPluginsRequest.ts#L22-L31" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PluginsRecord", + "namespace": "cat.plugins" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.plugins" + }, + "specLocation": "cat/plugins/CatPluginsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "RecoveryRecord", + "namespace": "cat.recovery" + }, + "properties": [ { "aliases": [ - "dleb", - "dataLastEmptyBucket" + "i", + "idx" ], - "description": "The timestamp of the last bucket that did not contain any data.", - "name": "data.last_empty_bucket", + "description": "The index name.", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { "aliases": [ - "dlsb", - "dataLastSparseBucket" + "s", + "sh" ], - "description": "The timestamp of the last bucket that was considered sparse.", - "name": "data.last_sparse_bucket", + "description": "The shard name.", + "name": "shard", "required": false, "type": { "kind": "instance_of", @@ -88548,91 +92593,104 @@ }, { "aliases": [ - "mb", - "modelBytes" + "start" ], - "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.", - "name": "model.bytes", + "description": "The recovery start time.", + "name": "start_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "DateTime", "namespace": "_types" } } }, { "aliases": [ - "mms", - "modelMemoryStatus" + "start_millis" ], - "description": "The status of the mathematical models.", - "name": "model.memory_status", + "description": "The recovery start time in epoch milliseconds.", + "name": "start_time_millis", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "MemoryStatus", - "namespace": "ml._types" + "name": "EpochTime", + "namespace": "_types" } } }, { "aliases": [ - "mbe", - "modelBytesExceeded" + "stop" ], - "description": "The number of bytes over the high limit for memory usage at the last allocation failure.", - "name": "model.bytes_exceeded", + "description": "The recovery stop time.", + "name": "stop_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "DateTime", "namespace": "_types" } } }, { "aliases": [ - "mml", - "modelMemoryLimit" + "stop_millis" ], - "description": "The upper limit for model memory usage, checked on increasing values.", - "name": "model.memory_limit", + "description": "The recovery stop time in epoch milliseconds.", + "name": "stop_time_millis", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "EpochTime", + "namespace": "_types" } } }, { "aliases": [ - "mbf", - "modelByFields" + "t", + "ti" ], - "description": "The number of `by` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.by_fields", + "description": "The recovery time.", + "name": "time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { "aliases": [ - "mof", - "modelOverFields" + "ty" ], - "description": "The number of `over` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.over_fields", + "description": "The recovery type.", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -88644,11 +92702,10 @@ }, { "aliases": [ - "mpf", - "modelPartitionFields" + "st" ], - "description": "The number of `partition` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.partition_fields", + "description": "The recovery stage.", + "name": "stage", "required": false, "type": { "kind": "instance_of", @@ -88660,11 +92717,10 @@ }, { "aliases": [ - "mbaf", - "modelBucketAllocationFailures" + "shost" ], - "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.", - "name": "model.bucket_allocation_failures", + "description": "The source host.", + "name": "source_host", "required": false, "type": { "kind": "instance_of", @@ -88676,27 +92732,25 @@ }, { "aliases": [ - "mcs", - "modelCategorizationStatus" + "snode" ], - "description": "The status of categorization for the job.", - "name": "model.categorization_status", + "description": "The source node name.", + "name": "source_node", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CategorizationStatus", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "mcdc", - "modelCategorizedDocCount" + "thost" ], - "description": "The number of documents that have had a field categorized.", - "name": "model.categorized_doc_count", + "description": "The target host.", + "name": "target_host", "required": false, "type": { "kind": "instance_of", @@ -88708,11 +92762,10 @@ }, { "aliases": [ - "mtcc", - "modelTotalCategoryCount" + "tnode" ], - "description": "The number of categories created by categorization.", - "name": "model.total_category_count", + "description": "The target node name.", + "name": "target_node", "required": false, "type": { "kind": "instance_of", @@ -88724,10 +92777,10 @@ }, { "aliases": [ - "modelFrequentCategoryCount" + "rep" ], - "description": "The number of categories that match more than 1% of categorized documents.", - "name": "model.frequent_category_count", + "description": "The repository name.", + "name": "repository", "required": false, "type": { "kind": "instance_of", @@ -88739,11 +92792,10 @@ }, { "aliases": [ - "mrcc", - "modelRareCategoryCount" + "snap" ], - "description": "The number of categories that match just one categorized document.", - "name": "model.rare_category_count", + "description": "The snapshot name.", + "name": "snapshot", "required": false, "type": { "kind": "instance_of", @@ -88755,11 +92807,10 @@ }, { "aliases": [ - "mdcc", - "modelDeadCategoryCount" + "f" ], - "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.", - "name": "model.dead_category_count", + "description": "The number of files to recover.", + "name": "files", "required": false, "type": { "kind": "instance_of", @@ -88771,11 +92822,10 @@ }, { "aliases": [ - "mfcc", - "modelFailedCategoryCount" + "fr" ], - "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.", - "name": "model.failed_category_count", + "description": "The files recovered.", + "name": "files_recovered", "required": false, "type": { "kind": "instance_of", @@ -88787,27 +92837,25 @@ }, { "aliases": [ - "mlt", - "modelLogTime" + "fp" ], - "description": "The timestamp when the model stats were gathered, according to server time.", - "name": "model.log_time", + "description": "The ratio of files recovered.", + "name": "files_percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Percentage", + "namespace": "_types" } } }, { "aliases": [ - "mt", - "modelTimestamp" + "tf" ], - "description": "The timestamp of the last record when the model stats were gathered.", - "name": "model.timestamp", + "description": "The total number of files.", + "name": "files_total", "required": false, "type": { "kind": "instance_of", @@ -88819,11 +92867,10 @@ }, { "aliases": [ - "ft", - "forecastsTotal" + "b" ], - "description": "The number of individual forecasts currently available for the job.\nA value of one or more indicates that forecasts exist.", - "name": "forecasts.total", + "description": "The number of bytes to recover.", + "name": "bytes", "required": false, "type": { "kind": "instance_of", @@ -88835,11 +92882,10 @@ }, { "aliases": [ - "fmmin", - "forecastsMemoryMin" + "br" ], - "description": "The minimum memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.min", + "description": "The bytes recovered.", + "name": "bytes_recovered", "required": false, "type": { "kind": "instance_of", @@ -88851,27 +92897,25 @@ }, { "aliases": [ - "fmmax", - "forecastsMemoryMax" + "bp" ], - "description": "The maximum memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.max", + "description": "The ratio of bytes recovered.", + "name": "bytes_percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Percentage", + "namespace": "_types" } } }, { "aliases": [ - "fmavg", - "forecastsMemoryAvg" + "tb" ], - "description": "The average memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.avg", + "description": "The total number of bytes.", + "name": "bytes_total", "required": false, "type": { "kind": "instance_of", @@ -88883,11 +92927,10 @@ }, { "aliases": [ - "fmt", - "forecastsMemoryTotal" + "to" ], - "description": "The total memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.total", + "description": "The number of translog operations to recover.", + "name": "translog_ops", "required": false, "type": { "kind": "instance_of", @@ -88899,11 +92942,10 @@ }, { "aliases": [ - "frmin", - "forecastsRecordsMin" + "tor" ], - "description": "The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.min", + "description": "The translog operations recovered.", + "name": "translog_ops_recovered", "required": false, "type": { "kind": "instance_of", @@ -88915,91 +92957,132 @@ }, { "aliases": [ - "frmax", - "forecastsRecordsMax" + "top" ], - "description": "The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.max", + "description": "The ratio of translog operations recovered.", + "name": "translog_ops_percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Percentage", + "namespace": "_types" } } - }, + } + ], + "specLocation": "cat/recovery/types.ts#L24-L155" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.recovery" + }, + "path": [ { - "aliases": [ - "fravg", - "forecastsRecordsAvg" - ], - "description": "The average number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.avg", + "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`.", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Indices", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "frt", - "forecastsRecordsTotal" - ], - "description": "The total number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.total", + "description": "If `true`, the response only includes ongoing shard recoveries.", + "name": "active_only", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "ftmin", - "forecastsTimeMin" - ], - "description": "The minimum runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.min", + "description": "The unit used to display byte values.", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Bytes", + "namespace": "_types" } } }, { - "aliases": [ - "ftmax", - "forecastsTimeMax" - ], - "description": "The maximum runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.max", + "description": "If `true`, the response includes detailed information about shard recoveries.", + "name": "detailed", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/recovery/CatRecoveryRequest.ts#L23-L59" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RecoveryRecord", + "namespace": "cat.recovery" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.recovery" + }, + "specLocation": "cat/recovery/CatRecoveryResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "RepositoriesRecord", + "namespace": "cat.repositories" + }, + "properties": [ { "aliases": [ - "ftavg", - "forecastsTimeAvg" + "repoId" ], - "description": "The average runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.avg", + "description": "The unique repository identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", @@ -89011,11 +93094,10 @@ }, { "aliases": [ - "ftt", - "forecastsTimeTotal" + "t" ], - "description": "The total runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.total", + "description": "The repository type.", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -89024,62 +93106,156 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/repositories/types.ts#L20-L31" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns the snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.repositories" + }, + "path": [], + "query": [], + "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L22-L31" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RepositoriesRecord", + "namespace": "cat.repositories" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.repositories" + }, + "specLocation": "cat/repositories/CatRepositoriesResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.segments" + }, + "path": [ { - "aliases": [ - "ni", - "nodeId" - ], - "description": "The uniqe identifier of the assigned node.", - "name": "node.id", + "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`.", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", + "name": "Indices", "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "nn", - "nodeName" - ], - "description": "The name of the assigned node.", - "name": "node.name", + "description": "The unit used to display byte values.", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Bytes", + "namespace": "_types" } } - }, + } + ], + "specLocation": "cat/segments/CatSegmentsRequest.ts#L23-L49" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentsRecord", + "namespace": "cat.segments" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.segments" + }, + "specLocation": "cat/segments/CatSegmentsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "SegmentsRecord", + "namespace": "cat.segments" + }, + "properties": [ { "aliases": [ - "ne", - "nodeEphemeralId" + "i", + "idx" ], - "description": "The ephemeral identifier of the assigned node.", - "name": "node.ephemeral_id", + "description": "The index name.", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", + "name": "IndexName", "namespace": "_types" } } }, { "aliases": [ - "na", - "nodeAddress" + "s", + "sh" ], - "description": "The network address of the assigned node.", - "name": "node.address", + "description": "The shard name.", + "name": "shard", "required": false, "type": { "kind": "instance_of", @@ -89091,11 +93267,12 @@ }, { "aliases": [ - "bc", - "bucketsCount" + "p", + "pr", + "primaryOrReplica" ], - "description": "The number of bucket results produced by the job.", - "name": "buckets.count", + "description": "The shard type: `primary` or `replica`.", + "name": "prirep", "required": false, "type": { "kind": "instance_of", @@ -89106,12 +93283,8 @@ } }, { - "aliases": [ - "btt", - "bucketsTimeTotal" - ], - "description": "The sum of all bucket processing times, in milliseconds.", - "name": "buckets.time.total", + "description": "The IP address of the node where it lives.", + "name": "ip", "required": false, "type": { "kind": "instance_of", @@ -89122,28 +93295,23 @@ } }, { - "aliases": [ - "btmin", - "bucketsTimeMin" - ], - "description": "The minimum of all bucket processing times, in milliseconds.", - "name": "buckets.time.min", + "description": "The unique identifier of the node where it lives.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "btmax", - "bucketsTimeMax" + "seg" ], - "description": "The maximum of all bucket processing times, in milliseconds.", - "name": "buckets.time.max", + "description": "The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard.", + "name": "segment", "required": false, "type": { "kind": "instance_of", @@ -89155,11 +93323,11 @@ }, { "aliases": [ - "btea", - "bucketsTimeExpAvg" + "g", + "gen" ], - "description": "The exponential moving average of all bucket processing times, in milliseconds.", - "name": "buckets.time.exp_avg", + "description": "The segment generation number.\nElasticsearch increments this generation number for each segment written then uses this number to derive the segment name.", + "name": "generation", "required": false, "type": { "kind": "instance_of", @@ -89171,11 +93339,11 @@ }, { "aliases": [ - "bteah", - "bucketsTimeExpAvgHour" + "dc", + "docsCount" ], - "description": "The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.", - "name": "buckets.time.exp_avg_hour", + "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.", + "name": "docs.count", "required": false, "type": { "kind": "instance_of", @@ -89184,130 +93352,119 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_jobs/types.ts#L24-L347" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.ml_jobs" - }, - "path": [ + }, { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", + "aliases": [ + "dd", + "docsDeleted" + ], + "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.", + "name": "docs.deleted", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "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.", - "name": "allow_no_match", + "aliases": [ + "si" + ], + "description": "The segment size in bytes.", + "name": "size", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "description": "The unit used to display byte values.", - "name": "bytes", + "aliases": [ + "sm", + "sizeMemory" + ], + "description": "The segment memory in bytes.\nA value of `-1` indicates Elasticsearch was unable to compute this number.", + "name": "size.memory", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", + "name": "ByteSize", "namespace": "_types" } } }, { - "description": "Comma-separated list of column names to display.", - "name": "h", + "aliases": [ + "ic", + "isCommitted" + ], + "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.", + "name": "committed", "required": false, - "serverDefault": "buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state", "type": { "kind": "instance_of", "type": { - "name": "CatAnonalyDetectorColumns", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Comma-separated list of column names or column aliases used to sort the response.", - "name": "s", + "aliases": [ + "is", + "isSearchable" + ], + "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.", + "name": "searchable", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CatAnonalyDetectorColumns", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The unit used to display time values.", - "name": "time", + "aliases": [ + "v" + ], + "description": "The version of Lucene used to write the segment.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "VersionString", "namespace": "_types" } } - } - ], - "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L24-L77" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "aliases": [ + "ico", + "isCompound" + ], + "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.", + "name": "compound", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "JobsRecord", - "namespace": "cat.ml_jobs" + "name": "string", + "namespace": "_builtins" } } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.ml_jobs" - }, - "specLocation": "cat/ml_jobs/CatJobsResponse.ts#L22-L24" + ], + "specLocation": "cat/segments/types.ts#L22-L107" }, { "attachedBehaviors": [ @@ -89317,7 +93474,7 @@ "body": { "kind": "no_body" }, - "description": "Returns configuration and usage information about inference trained models.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "description": "Returns information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "inherits": { "type": { "name": "CatRequestBase", @@ -89327,36 +93484,23 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.ml_trained_models" + "namespace": "cat.shards" }, "path": [ { - "description": "A unique identifier for the trained model.", - "name": "model_id", + "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`.", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Indices", "namespace": "_types" } } } ], "query": [ - { - "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.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "description": "The unit used to display byte values.", "name": "bytes", @@ -89368,57 +93512,9 @@ "namespace": "_types" } } - }, - { - "description": "A comma-separated list of column names to display.", - "name": "h", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CatTrainedModelsColumns", - "namespace": "cat._types" - } - } - }, - { - "description": "A comma-separated list of column names or aliases used to sort the response.", - "name": "s", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CatTrainedModelsColumns", - "namespace": "cat._types" - } - } - }, - { - "description": "Skips the specified number of transforms.", - "name": "from", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The maximum number of transforms to display.", - "name": "size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } } ], - "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L63" + "specLocation": "cat/shards/CatShardsRequest.ts#L23-L49" }, { "body": { @@ -89428,8 +93524,8 @@ "value": { "kind": "instance_of", "type": { - "name": "TrainedModelsRecord", - "namespace": "cat.ml_trained_models" + "name": "ShardsRecord", + "namespace": "cat.shards" } } } @@ -89437,36 +93533,24 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.ml_trained_models" + "namespace": "cat.shards" }, - "specLocation": "cat/ml_trained_models/CatTrainedModelsResponse.ts#L22-L24" + "specLocation": "cat/shards/CatShardsResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "TrainedModelsRecord", - "namespace": "cat.ml_trained_models" + "name": "ShardsRecord", + "namespace": "cat.shards" }, "properties": [ - { - "description": "The model identifier.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, { "aliases": [ - "c", - "createdBy" + "i", + "idx" ], - "description": "Information about the creator of the model.", - "name": "created_by", + "description": "The index name.", + "name": "index", "required": false, "type": { "kind": "instance_of", @@ -89478,27 +93562,28 @@ }, { "aliases": [ - "hs", - "modelHeapSize" + "s", + "sh" ], - "description": "The estimated heap size to keep the model in memory.", - "name": "heap_size", + "description": "The shard name.", + "name": "shard", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "o", - "modelOperations" + "p", + "pr", + "primaryOrReplica" ], - "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.", - "name": "operations", + "description": "The shard type: `primary` or `replica`.", + "name": "prirep", "required": false, "type": { "kind": "instance_of", @@ -89510,10 +93595,10 @@ }, { "aliases": [ - "l" + "st" ], - "description": "The license level of the model.", - "name": "license", + "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.", + "name": "state", "required": false, "type": { "kind": "instance_of", @@ -89525,56 +93610,86 @@ }, { "aliases": [ - "ct" + "d", + "dc" ], - "description": "The time the model was created.", - "name": "create_time", + "description": "The number of documents in the shard.", + "name": "docs", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "v" + "sto" ], - "description": "The version of Elasticsearch when the model was created.", - "name": "version", + "description": "The disk space used by the shard.", + "name": "store", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "aliases": [ - "d" - ], - "description": "A description of the model.", - "name": "description", + "description": "The IP address of the node.", + "name": "ip", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "aliases": [ - "ip", - "ingestPipelines" - ], - "description": "The number of pipelines that are referencing the model.", - "name": "ingest.pipelines", + "description": "The unique identifier for the node.", + "name": "id", "required": false, "type": { "kind": "instance_of", @@ -89586,27 +93701,34 @@ }, { "aliases": [ - "ic", - "ingestCount" + "n" ], - "description": "The total number of documents that are processed by the model.", - "name": "ingest.count", + "description": "The name of node.", + "name": "node", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "aliases": [ - "it", - "ingestTime" - ], - "description": "The total time spent processing documents with thie model.", - "name": "ingest.time", + "description": "The sync identifier.", + "name": "sync_id", "required": false, "type": { "kind": "instance_of", @@ -89618,11 +93740,10 @@ }, { "aliases": [ - "icurr", - "ingestCurrent" + "ur" ], - "description": "The total number of documents that are currently being handled by the model.", - "name": "ingest.current", + "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.", + "name": "unassigned.reason", "required": false, "type": { "kind": "instance_of", @@ -89634,11 +93755,10 @@ }, { "aliases": [ - "if", - "ingestFailed" + "ua" ], - "description": "The total number of failed ingest attempts with the model.", - "name": "ingest.failed", + "description": "The time at which the shard became unassigned in Coordinated Universal Time (UTC).", + "name": "unassigned.at", "required": false, "type": { "kind": "instance_of", @@ -89650,11 +93770,10 @@ }, { "aliases": [ - "dfid", - "dataFrameAnalytics" + "uf" ], - "description": "The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available.", - "name": "data_frame.id", + "description": "The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).", + "name": "unassigned.for", "required": false, "type": { "kind": "instance_of", @@ -89666,11 +93785,10 @@ }, { "aliases": [ - "dft", - "dataFrameAnalyticsTime" + "ud" ], - "description": "The time the data frame analytics job was created.", - "name": "data_frame.create_time", + "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.", + "name": "unassigned.details", "required": false, "type": { "kind": "instance_of", @@ -89682,11 +93800,10 @@ }, { "aliases": [ - "dfsi", - "dataFrameAnalyticsSrcIndex" + "rs" ], - "description": "The source index used to train in the data frame analysis.", - "name": "data_frame.source_index", + "description": "The type of recovery source.", + "name": "recoverysource.type", "required": false, "type": { "kind": "instance_of", @@ -89698,51 +93815,11 @@ }, { "aliases": [ - "dfa", - "dataFrameAnalyticsAnalysis" + "cs", + "completionSize" ], - "description": "The analysis used by the data frame to build the model.", - "name": "data_frame.analysis", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "8.0.0" - } - }, - "name": "type", - "required": false, - "since": "8.0.0", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "cat/ml_trained_models/types.ts#L23-L115" - }, - { - "kind": "interface", - "name": { - "name": "NodeAttributesRecord", - "namespace": "cat.nodeattrs" - }, - "properties": [ - { - "description": "The node name.", - "name": "node", + "description": "The size of completion.", + "name": "completion.size", "required": false, "type": { "kind": "instance_of", @@ -89753,8 +93830,12 @@ } }, { - "description": "The unique node identifier.", - "name": "id", + "aliases": [ + "fm", + "fielddataMemory" + ], + "description": "The used fielddata cache memory.", + "name": "fielddata.memory_size", "required": false, "type": { "kind": "instance_of", @@ -89765,8 +93846,12 @@ } }, { - "description": "The process identifier.", - "name": "pid", + "aliases": [ + "fe", + "fielddataEvictions" + ], + "description": "The fielddata cache evictions.", + "name": "fielddata.evictions", "required": false, "type": { "kind": "instance_of", @@ -89778,10 +93863,11 @@ }, { "aliases": [ - "h" + "qcm", + "queryCacheMemory" ], - "description": "The host name.", - "name": "host", + "description": "The used query cache memory.", + "name": "query_cache.memory_size", "required": false, "type": { "kind": "instance_of", @@ -89793,10 +93879,11 @@ }, { "aliases": [ - "i" + "qce", + "queryCacheEvictions" ], - "description": "The IP address.", - "name": "ip", + "description": "The query cache evictions.", + "name": "query_cache.evictions", "required": false, "type": { "kind": "instance_of", @@ -89807,8 +93894,12 @@ } }, { - "description": "The bound transport port.", - "name": "port", + "aliases": [ + "ft", + "flushTotal" + ], + "description": "The number of flushes.", + "name": "flush.total", "required": false, "type": { "kind": "instance_of", @@ -89819,8 +93910,12 @@ } }, { - "description": "The attribute name.", - "name": "attr", + "aliases": [ + "ftt", + "flushTotalTime" + ], + "description": "The time spent in flush.", + "name": "flush.total_time", "required": false, "type": { "kind": "instance_of", @@ -89830,94 +93925,29 @@ } } }, - { - "description": "The attribute value.", - "name": "value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "cat/nodeattrs/types.ts#L20-L55" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.nodeattrs" - }, - "path": [], - "query": [], - "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L22-L31" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "NodeAttributesRecord", - "namespace": "cat.nodeattrs" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.nodeattrs" - }, - "specLocation": "cat/nodeattrs/CatNodeAttributesResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "NodesRecord", - "namespace": "cat.nodes" - }, - "properties": [ { "aliases": [ - "nodeId" + "gc", + "getCurrent" ], - "description": "The unique node identifier.", - "name": "id", + "description": "The number of current get operations.", + "name": "get.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "p" + "gti", + "getTime" ], - "description": "The process identifier.", - "name": "pid", + "description": "The time spent in get operations.", + "name": "get.time", "required": false, "type": { "kind": "instance_of", @@ -89929,10 +93959,11 @@ }, { "aliases": [ - "i" + "gto", + "getTotal" ], - "description": "The IP address.", - "name": "ip", + "description": "The number of get operations.", + "name": "get.total", "required": false, "type": { "kind": "instance_of", @@ -89944,10 +93975,11 @@ }, { "aliases": [ - "po" + "geti", + "getExistsTime" ], - "description": "The bound transport port.", - "name": "port", + "description": "The time spent in successful get operations.", + "name": "get.exists_time", "required": false, "type": { "kind": "instance_of", @@ -89959,10 +93991,11 @@ }, { "aliases": [ - "http" + "geto", + "getExistsTotal" ], - "description": "The bound HTTP address.", - "name": "http_address", + "description": "The number of successful get operations.", + "name": "get.exists_total", "required": false, "type": { "kind": "instance_of", @@ -89974,25 +94007,27 @@ }, { "aliases": [ - "v" + "gmti", + "getMissingTime" ], - "description": "The Elasticsearch version.", - "name": "version", + "description": "The time spent in failed get operations.", + "name": "get.missing_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "f" + "gmto", + "getMissingTotal" ], - "description": "The Elasticsearch distribution flavor.", - "name": "flavor", + "description": "The number of failed get operations.", + "name": "get.missing_total", "required": false, "type": { "kind": "instance_of", @@ -90004,10 +94039,11 @@ }, { "aliases": [ - "t" + "idc", + "indexingDeleteCurrent" ], - "description": "The Elasticsearch distribution type.", - "name": "type", + "description": "The number of current deletion operations.", + "name": "indexing.delete_current", "required": false, "type": { "kind": "instance_of", @@ -90019,10 +94055,11 @@ }, { "aliases": [ - "b" + "idti", + "indexingDeleteTime" ], - "description": "The Elasticsearch build hash.", - "name": "build", + "description": "The time spent in deletion operations.", + "name": "indexing.delete_time", "required": false, "type": { "kind": "instance_of", @@ -90034,10 +94071,11 @@ }, { "aliases": [ - "j" + "idto", + "indexingDeleteTotal" ], - "description": "The Java version.", - "name": "jdk", + "description": "The number of delete operations.", + "name": "indexing.delete_total", "required": false, "type": { "kind": "instance_of", @@ -90049,77 +94087,75 @@ }, { "aliases": [ - "dt", - "diskTotal" + "iic", + "indexingIndexCurrent" ], - "description": "The total disk space.", - "name": "disk.total", + "description": "The number of current indexing operations.", + "name": "indexing.index_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "du", - "diskUsed" + "iiti", + "indexingIndexTime" ], - "description": "The used disk space.", - "name": "disk.used", + "description": "The time spent in indexing operations.", + "name": "indexing.index_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "d", - "da", - "disk", - "diskAvail" + "iito", + "indexingIndexTotal" ], - "description": "The available disk space.", - "name": "disk.avail", + "description": "The number of indexing operations.", + "name": "indexing.index_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "dup", - "diskUsedPercent" + "iif", + "indexingIndexFailed" ], - "description": "The used disk space percentage.", - "name": "disk.used_percent", + "description": "The number of failed indexing operations.", + "name": "indexing.index_failed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "hc", - "heapCurrent" + "mc", + "mergesCurrent" ], - "description": "The used heap.", - "name": "heap.current", + "description": "The number of current merge operations.", + "name": "merges.current", "required": false, "type": { "kind": "instance_of", @@ -90131,27 +94167,27 @@ }, { "aliases": [ - "hp", - "heapPercent" + "mcd", + "mergesCurrentDocs" ], - "description": "The used heap ratio.", - "name": "heap.percent", + "description": "The number of current merging documents.", + "name": "merges.current_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "hm", - "heapMax" + "mcs", + "mergesCurrentSize" ], - "description": "The maximum configured heap.", - "name": "heap.max", + "description": "The size of current merge operations.", + "name": "merges.current_size", "required": false, "type": { "kind": "instance_of", @@ -90163,11 +94199,11 @@ }, { "aliases": [ - "rc", - "ramCurrent" + "mt", + "mergesTotal" ], - "description": "The used machine memory.", - "name": "ram.current", + "description": "The number of completed merge operations.", + "name": "merges.total", "required": false, "type": { "kind": "instance_of", @@ -90179,27 +94215,27 @@ }, { "aliases": [ - "rp", - "ramPercent" + "mtd", + "mergesTotalDocs" ], - "description": "The used machine memory ratio.", - "name": "ram.percent", + "description": "The nuber of merged documents.", + "name": "merges.total_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "rn", - "ramMax" + "mts", + "mergesTotalSize" ], - "description": "The total machine memory.", - "name": "ram.max", + "description": "The size of current merges.", + "name": "merges.total_size", "required": false, "type": { "kind": "instance_of", @@ -90211,11 +94247,11 @@ }, { "aliases": [ - "fdc", - "fileDescriptorCurrent" + "mtt", + "mergesTotalTime" ], - "description": "The used file descriptors.", - "name": "file_desc.current", + "description": "The time spent merging documents.", + "name": "merges.total_time", "required": false, "type": { "kind": "instance_of", @@ -90226,28 +94262,20 @@ } }, { - "aliases": [ - "fdp", - "fileDescriptorPercent" - ], - "description": "The used file descriptor ratio.", - "name": "file_desc.percent", + "description": "The total number of refreshes.", + "name": "refresh.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "fdm", - "fileDescriptorMax" - ], - "description": "The maximum number of file descriptors.", - "name": "file_desc.max", + "description": "The time spent in refreshes.", + "name": "refresh.time", "required": false, "type": { "kind": "instance_of", @@ -90258,8 +94286,12 @@ } }, { - "description": "The recent system CPU usage as a percentage.", - "name": "cpu", + "aliases": [ + "rto", + "refreshTotal" + ], + "description": "The total nunber of external refreshes.", + "name": "refresh.external_total", "required": false, "type": { "kind": "instance_of", @@ -90270,8 +94302,12 @@ } }, { - "description": "The load average for the most recent minute.", - "name": "load_1m", + "aliases": [ + "rti", + "refreshTime" + ], + "description": "The time spent in external refreshes.", + "name": "refresh.external_time", "required": false, "type": { "kind": "instance_of", @@ -90282,8 +94318,12 @@ } }, { - "description": "The load average for the last five minutes.", - "name": "load_5m", + "aliases": [ + "rli", + "refreshListeners" + ], + "description": "The number of pending refresh listeners.", + "name": "refresh.listeners", "required": false, "type": { "kind": "instance_of", @@ -90295,10 +94335,11 @@ }, { "aliases": [ - "l" + "sfc", + "searchFetchCurrent" ], - "description": "The load average for the last fifteen minutes.", - "name": "load_15m", + "description": "The current fetch phase operations.", + "name": "search.fetch_current", "required": false, "type": { "kind": "instance_of", @@ -90310,10 +94351,11 @@ }, { "aliases": [ - "u" + "sfti", + "searchFetchTime" ], - "description": "The node uptime.", - "name": "uptime", + "description": "The time spent in fetch phase.", + "name": "search.fetch_time", "required": false, "type": { "kind": "instance_of", @@ -90325,12 +94367,11 @@ }, { "aliases": [ - "r", - "role", - "nodeRole" + "sfto", + "searchFetchTotal" ], - "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).", - "name": "node.role", + "description": "The total number of fetch operations.", + "name": "search.fetch_total", "required": false, "type": { "kind": "instance_of", @@ -90342,10 +94383,11 @@ }, { "aliases": [ - "m" + "so", + "searchOpenContexts" ], - "description": "Indicates whether the node is the elected master node.\nReturned values include `*`(elected master) and `-`(not elected master).", - "name": "master", + "description": "The number of open search contexts.", + "name": "search.open_contexts", "required": false, "type": { "kind": "instance_of", @@ -90357,26 +94399,27 @@ }, { "aliases": [ - "n" + "sqc", + "searchQueryCurrent" ], - "description": "The node name.", - "name": "name", + "description": "The current query phase operations.", + "name": "search.query_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "cs", - "completionSize" + "sqti", + "searchQueryTime" ], - "description": "The size of completion.", - "name": "completion.size", + "description": "The time spent in query phase.", + "name": "search.query_time", "required": false, "type": { "kind": "instance_of", @@ -90388,11 +94431,11 @@ }, { "aliases": [ - "fm", - "fielddataMemory" + "sqto", + "searchQueryTotal" ], - "description": "The used fielddata cache.", - "name": "fielddata.memory_size", + "description": "The total number of query phase operations.", + "name": "search.query_total", "required": false, "type": { "kind": "instance_of", @@ -90404,11 +94447,11 @@ }, { "aliases": [ - "fe", - "fielddataEvictions" + "scc", + "searchScrollCurrent" ], - "description": "The fielddata evictions.", - "name": "fielddata.evictions", + "description": "The open scroll contexts.", + "name": "search.scroll_current", "required": false, "type": { "kind": "instance_of", @@ -90420,11 +94463,11 @@ }, { "aliases": [ - "qcm", - "queryCacheMemory" + "scti", + "searchScrollTime" ], - "description": "The used query cache.", - "name": "query_cache.memory_size", + "description": "The time scroll contexts were held open.", + "name": "search.scroll_time", "required": false, "type": { "kind": "instance_of", @@ -90436,11 +94479,11 @@ }, { "aliases": [ - "qce", - "queryCacheEvictions" + "scto", + "searchScrollTotal" ], - "description": "The query cache evictions.", - "name": "query_cache.evictions", + "description": "The number of completed scroll contexts.", + "name": "search.scroll_total", "required": false, "type": { "kind": "instance_of", @@ -90452,11 +94495,11 @@ }, { "aliases": [ - "qchc", - "queryCacheHitCount" + "sc", + "segmentsCount" ], - "description": "The query cache hit counts.", - "name": "query_cache.hit_count", + "description": "The number of segments.", + "name": "segments.count", "required": false, "type": { "kind": "instance_of", @@ -90468,11 +94511,11 @@ }, { "aliases": [ - "qcmc", - "queryCacheMissCount" + "sm", + "segmentsMemory" ], - "description": "The query cache miss counts.", - "name": "query_cache.miss_count", + "description": "The memory used by segments.", + "name": "segments.memory", "required": false, "type": { "kind": "instance_of", @@ -90484,11 +94527,11 @@ }, { "aliases": [ - "rcm", - "requestCacheMemory" + "siwm", + "segmentsIndexWriterMemory" ], - "description": "The used request cache.", - "name": "request_cache.memory_size", + "description": "The memory used by the index writer.", + "name": "segments.index_writer_memory", "required": false, "type": { "kind": "instance_of", @@ -90500,11 +94543,11 @@ }, { "aliases": [ - "rce", - "requestCacheEvictions" + "svmm", + "segmentsVersionMapMemory" ], - "description": "The request cache evictions.", - "name": "request_cache.evictions", + "description": "The memory used by the version map.", + "name": "segments.version_map_memory", "required": false, "type": { "kind": "instance_of", @@ -90516,11 +94559,11 @@ }, { "aliases": [ - "rchc", - "requestCacheHitCount" + "sfbm", + "fixedBitsetMemory" ], - "description": "The request cache hit counts.", - "name": "request_cache.hit_count", + "description": "The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields.", + "name": "segments.fixed_bitset_memory", "required": false, "type": { "kind": "instance_of", @@ -90532,11 +94575,11 @@ }, { "aliases": [ - "rcmc", - "requestCacheMissCount" + "sqm", + "maxSeqNo" ], - "description": "The request cache miss counts.", - "name": "request_cache.miss_count", + "description": "The maximum sequence number.", + "name": "seq_no.max", "required": false, "type": { "kind": "instance_of", @@ -90548,11 +94591,11 @@ }, { "aliases": [ - "ft", - "flushTotal" + "sql", + "localCheckpoint" ], - "description": "The number of flushes.", - "name": "flush.total", + "description": "The local checkpoint.", + "name": "seq_no.local_checkpoint", "required": false, "type": { "kind": "instance_of", @@ -90564,11 +94607,11 @@ }, { "aliases": [ - "ftt", - "flushTotalTime" + "sqg", + "globalCheckpoint" ], - "description": "The time spent in flush.", - "name": "flush.total_time", + "description": "The global checkpoint.", + "name": "seq_no.global_checkpoint", "required": false, "type": { "kind": "instance_of", @@ -90580,11 +94623,11 @@ }, { "aliases": [ - "gc", - "getCurrent" + "wc", + "warmerCurrent" ], - "description": "The number of current get ops.", - "name": "get.current", + "description": "The number of current warmer operations.", + "name": "warmer.current", "required": false, "type": { "kind": "instance_of", @@ -90596,11 +94639,11 @@ }, { "aliases": [ - "gti", - "getTime" + "wto", + "warmerTotal" ], - "description": "The time spent in get.", - "name": "get.time", + "description": "The total number of warmer operations.", + "name": "warmer.total", "required": false, "type": { "kind": "instance_of", @@ -90612,11 +94655,11 @@ }, { "aliases": [ - "gto", - "getTotal" + "wtt", + "warmerTotalTime" ], - "description": "The number of get ops.", - "name": "get.total", + "description": "The time spent in warmer operations.", + "name": "warmer.total_time", "required": false, "type": { "kind": "instance_of", @@ -90628,11 +94671,11 @@ }, { "aliases": [ - "geti", - "getExistsTime" + "pd", + "dataPath" ], - "description": "The time spent in successful gets.", - "name": "get.exists_time", + "description": "The shard data path.", + "name": "path.data", "required": false, "type": { "kind": "instance_of", @@ -90644,11 +94687,11 @@ }, { "aliases": [ - "geto", - "getExistsTotal" + "ps", + "statsPath" ], - "description": "The number of successful get operations.", - "name": "get.exists_total", + "description": "The shard state path.", + "name": "path.state", "required": false, "type": { "kind": "instance_of", @@ -90660,11 +94703,11 @@ }, { "aliases": [ - "gmti", - "getMissingTime" + "bto", + "bulkTotalOperations" ], - "description": "The time spent in failed gets.", - "name": "get.missing_time", + "description": "The number of bulk shard operations.", + "name": "bulk.total_operations", "required": false, "type": { "kind": "instance_of", @@ -90676,11 +94719,11 @@ }, { "aliases": [ - "gmto", - "getMissingTotal" + "btti", + "bulkTotalTime" ], - "description": "The number of failed gets.", - "name": "get.missing_total", + "description": "The time spent in shard bulk operations.", + "name": "bulk.total_time", "required": false, "type": { "kind": "instance_of", @@ -90692,11 +94735,11 @@ }, { "aliases": [ - "idc", - "indexingDeleteCurrent" + "btsi", + "bulkTotalSizeInBytes" ], - "description": "The number of current deletions.", - "name": "indexing.delete_current", + "description": "The total size in bytes of shard bulk operations.", + "name": "bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -90708,11 +94751,11 @@ }, { "aliases": [ - "idti", - "indexingDeleteTime" + "bati", + "bulkAvgTime" ], - "description": "The time spent in deletions.", - "name": "indexing.delete_time", + "description": "The average time spent in shard bulk operations.", + "name": "bulk.avg_time", "required": false, "type": { "kind": "instance_of", @@ -90724,11 +94767,11 @@ }, { "aliases": [ - "idto", - "indexingDeleteTotal" + "basi", + "bulkAvgSizeInBytes" ], - "description": "The number of delete operations.", - "name": "indexing.delete_total", + "description": "The average size in bytes of shard bulk operations.", + "name": "bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -90737,30 +94780,95 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/shards/types.ts#L20-L421" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.snapshots" + }, + "path": [ { - "aliases": [ - "iic", - "indexingIndexCurrent" - ], - "description": "The number of current indexing operations.", - "name": "indexing.index_current", + "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.", + "name": "repository", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "If `true`, the response does not include information from unavailable snapshots.", + "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L23-L50" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SnapshotsRecord", + "namespace": "cat.snapshots" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.snapshots" + }, + "specLocation": "cat/snapshots/CatSnapshotsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "SnapshotsRecord", + "namespace": "cat.snapshots" + }, + "properties": [ { "aliases": [ - "iiti", - "indexingIndexTime" + "snapshot" ], - "description": "The time spent in indexing.", - "name": "indexing.index_time", + "description": "The unique identifier for the snapshot.", + "name": "id", "required": false, "type": { "kind": "instance_of", @@ -90772,11 +94880,11 @@ }, { "aliases": [ - "iito", - "indexingIndexTotal" + "re", + "repo" ], - "description": "The number of indexing operations.", - "name": "indexing.index_total", + "description": "The repository name.", + "name": "repository", "required": false, "type": { "kind": "instance_of", @@ -90788,11 +94896,10 @@ }, { "aliases": [ - "iif", - "indexingIndexFailed" + "s" ], - "description": "The number of failed indexing operations.", - "name": "indexing.index_failed", + "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.", + "name": "status", "required": false, "type": { "kind": "instance_of", @@ -90804,91 +94911,125 @@ }, { "aliases": [ - "mc", - "mergesCurrent" + "ste", + "startEpoch" ], - "description": "The number of current merges.", - "name": "merges.current", + "description": "The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.", + "name": "start_epoch", "required": false, "type": { + "generics": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitSeconds", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { "aliases": [ - "mcd", - "mergesCurrentDocs" + "sti", + "startTime" ], - "description": "The number of current merging docs.", - "name": "merges.current_docs", + "description": "The time (HH:MM:SS) at which the snapshot process started.", + "name": "start_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ScheduleTimeOfDay", + "namespace": "watcher._types" } } }, { "aliases": [ - "mcs", - "mergesCurrentSize" + "ete", + "endEpoch" ], - "description": "The size of current merges.", - "name": "merges.current_size", + "description": "The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.", + "name": "end_epoch", "required": false, "type": { + "generics": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitSeconds", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { "aliases": [ - "mt", - "mergesTotal" + "eti", + "endTime" ], - "description": "The number of completed merge operations.", - "name": "merges.total", + "description": "The time (HH:MM:SS) at which the snapshot process ended.", + "name": "end_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TimeOfDay", + "namespace": "_types" } } }, { "aliases": [ - "mtd", - "mergesTotalDocs" + "dur" ], - "description": "The docs merged.", - "name": "merges.total_docs", + "description": "The time it took the snapshot process to complete, in time units.", + "name": "duration", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { "aliases": [ - "mts", - "mergesTotalSize" + "i" ], - "description": "The size merged.", - "name": "merges.total_size", + "description": "The number of indices in the snapshot.", + "name": "indices", "required": false, "type": { "kind": "instance_of", @@ -90900,11 +95041,10 @@ }, { "aliases": [ - "mtt", - "mergesTotalTime" + "ss" ], - "description": "The time spent in merges.", - "name": "merges.total_time", + "description": "The number of successful shards in the snapshot.", + "name": "successful_shards", "required": false, "type": { "kind": "instance_of", @@ -90915,8 +95055,11 @@ } }, { - "description": "The total refreshes.", - "name": "refresh.total", + "aliases": [ + "fs" + ], + "description": "The number of failed shards in the snapshot.", + "name": "failed_shards", "required": false, "type": { "kind": "instance_of", @@ -90927,8 +95070,11 @@ } }, { - "description": "The time spent in refreshes.", - "name": "refresh.time", + "aliases": [ + "ts" + ], + "description": "The total number of shards in the snapshot.", + "name": "total_shards", "required": false, "type": { "kind": "instance_of", @@ -90940,11 +95086,10 @@ }, { "aliases": [ - "rto", - "refreshTotal" + "r" ], - "description": "The total external refreshes.", - "name": "refresh.external_total", + "description": "The reason for any snapshot failures.", + "name": "reason", "required": false, "type": { "kind": "instance_of", @@ -90953,62 +95098,78 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/snapshots/types.ts#L24-L96" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about tasks currently executing in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.tasks" + }, + "path": [], + "query": [ { - "aliases": [ - "rti", - "refreshTime" - ], - "description": "The time spent in external refreshes.", - "name": "refresh.external_time", + "description": "The task action names, which are used to limit the response.", + "name": "actions", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "aliases": [ - "rli", - "refreshListeners" - ], - "description": "The number of pending refresh listeners.", - "name": "refresh.listeners", + "description": "If `true`, the response includes detailed information about shard recoveries.", + "name": "detailed", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "scrcc", - "scriptCompilations" - ], - "description": "The total script compilations.", - "name": "script.compilations", + "description": "Unique node identifiers, which are used to limit the response.", + "name": "node_id", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "aliases": [ - "scrce", - "scriptCacheEvictions" - ], - "description": "The total compiled scripts evicted from the cache.", - "name": "script.cache_evictions", + "description": "The parent task identifier, which is used to limit the response.", + "name": "parent_task_id", "required": false, "type": { "kind": "instance_of", @@ -91017,46 +95178,56 @@ "namespace": "_builtins" } } - }, - { - "aliases": [ - "scrclt", - "scriptCacheCompilationLimitTriggered" - ], - "description": "The script cache compilation limit triggered.", - "name": "script.compilation_limit_triggered", - "required": false, - "type": { + } + ], + "specLocation": "cat/tasks/CatTasksRequest.ts#L23-L48" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TasksRecord", + "namespace": "cat.tasks" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.tasks" + }, + "specLocation": "cat/tasks/CatTasksResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TasksRecord", + "namespace": "cat.tasks" + }, + "properties": [ { - "aliases": [ - "sfc", - "searchFetchCurrent" - ], - "description": "The current fetch phase operations.", - "name": "search.fetch_current", + "description": "The identifier of the task with the node.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "sfti", - "searchFetchTime" + "ac" ], - "description": "The time spent in fetch phase.", - "name": "search.fetch_time", + "description": "The task action.", + "name": "action", "required": false, "type": { "kind": "instance_of", @@ -91068,27 +95239,25 @@ }, { "aliases": [ - "sfto", - "searchFetchTotal" + "ti" ], - "description": "The total fetch operations.", - "name": "search.fetch_total", + "description": "The unique task identifier.", + "name": "task_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "so", - "searchOpenContexts" + "pti" ], - "description": "The open search contexts.", - "name": "search.open_contexts", + "description": "The parent task identifier.", + "name": "parent_task_id", "required": false, "type": { "kind": "instance_of", @@ -91100,11 +95269,10 @@ }, { "aliases": [ - "sqc", - "searchQueryCurrent" + "ty" ], - "description": "The current query phase operations.", - "name": "search.query_current", + "description": "The task type.", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -91116,11 +95284,10 @@ }, { "aliases": [ - "sqti", - "searchQueryTime" + "start" ], - "description": "The time spent in query phase.", - "name": "search.query_time", + "description": "The start time in milliseconds.", + "name": "start_time", "required": false, "type": { "kind": "instance_of", @@ -91132,11 +95299,12 @@ }, { "aliases": [ - "sqto", - "searchQueryTotal" + "ts", + "hms", + "hhmmss" ], - "description": "The total query phase operations.", - "name": "search.query_total", + "description": "The start time in `HH:MM:SS` format.", + "name": "timestamp", "required": false, "type": { "kind": "instance_of", @@ -91147,12 +95315,8 @@ } }, { - "aliases": [ - "scc", - "searchScrollCurrent" - ], - "description": "The open scroll contexts.", - "name": "search.scroll_current", + "description": "The running time in nanoseconds.", + "name": "running_time_ns", "required": false, "type": { "kind": "instance_of", @@ -91164,11 +95328,10 @@ }, { "aliases": [ - "scti", - "searchScrollTime" + "time" ], - "description": "The time scroll contexts held open.", - "name": "search.scroll_time", + "description": "The running time.", + "name": "running_time", "required": false, "type": { "kind": "instance_of", @@ -91180,27 +95343,25 @@ }, { "aliases": [ - "scto", - "searchScrollTotal" + "ni" ], - "description": "The completed scroll contexts.", - "name": "search.scroll_total", + "description": "The unique node identifier.", + "name": "node_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "sc", - "segmentsCount" + "i" ], - "description": "The number of segments.", - "name": "segments.count", + "description": "The IP address for the node.", + "name": "ip", "required": false, "type": { "kind": "instance_of", @@ -91212,11 +95373,10 @@ }, { "aliases": [ - "sm", - "segmentsMemory" + "po" ], - "description": "The memory used by segments.", - "name": "segments.memory", + "description": "The bound transport port for the node.", + "name": "port", "required": false, "type": { "kind": "instance_of", @@ -91228,11 +95388,10 @@ }, { "aliases": [ - "siwm", - "segmentsIndexWriterMemory" + "n" ], - "description": "The memory used by the index writer.", - "name": "segments.index_writer_memory", + "description": "The node name.", + "name": "node", "required": false, "type": { "kind": "instance_of", @@ -91244,27 +95403,25 @@ }, { "aliases": [ - "svmm", - "segmentsVersionMapMemory" + "v" ], - "description": "The memory used by the version map.", - "name": "segments.version_map_memory", + "description": "The Elasticsearch version.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { "aliases": [ - "sfbm", - "fixedBitsetMemory" + "x" ], - "description": "The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields.", - "name": "segments.fixed_bitset_memory", + "description": "The X-Opaque-ID header.", + "name": "x_opaque_id", "required": false, "type": { "kind": "instance_of", @@ -91276,11 +95433,10 @@ }, { "aliases": [ - "suc", - "suggestCurrent" + "desc" ], - "description": "The number of current suggest operations.", - "name": "suggest.current", + "description": "The task action description.", + "name": "description", "required": false, "type": { "kind": "instance_of", @@ -91289,62 +95445,96 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/tasks/types.ts#L22-L101" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.templates" + }, + "path": [ { - "aliases": [ - "suti", - "suggestTime" - ], - "description": "The time spend in suggest.", - "name": "suggest.time", + "description": "The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } - }, - { - "aliases": [ - "suto", - "suggestTotal" - ], - "description": "The number of suggest operations.", - "name": "suggest.total", - "required": false, - "type": { + } + ], + "query": [], + "specLocation": "cat/templates/CatTemplatesRequest.ts#L23-L41" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TemplatesRecord", + "namespace": "cat.templates" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.templates" + }, + "specLocation": "cat/templates/CatTemplatesResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TemplatesRecord", + "namespace": "cat.templates" + }, + "properties": [ { "aliases": [ - "bto", - "bulkTotalOperations" + "n" ], - "description": "The number of bulk shard operations.", - "name": "bulk.total_operations", + "description": "The template name.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { "aliases": [ - "btti", - "bulkTotalTime" + "t" ], - "description": "The time spend in shard bulk.", - "name": "bulk.total_time", + "description": "The template index patterns.", + "name": "index_patterns", "required": false, "type": { "kind": "instance_of", @@ -91356,11 +95546,11 @@ }, { "aliases": [ - "btsi", - "bulkTotalSizeInBytes" + "o", + "p" ], - "description": "The total size in bytes of shard bulk.", - "name": "bulk.total_size_in_bytes", + "description": "The template application order or priority number.", + "name": "order", "required": false, "type": { "kind": "instance_of", @@ -91372,27 +95562,37 @@ }, { "aliases": [ - "bati", - "bulkAvgTime" + "v" ], - "description": "The average time spend in shard bulk.", - "name": "bulk.avg_time", + "description": "The template version.", + "name": "version", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "basi", - "bulkAvgSizeInBytes" + "c" ], - "description": "The average size in bytes of shard bulk.", - "name": "bulk.avg_size_in_bytes", + "description": "The component templates that comprise the index template.", + "name": "composed_of", "required": false, "type": { "kind": "instance_of", @@ -91403,7 +95603,7 @@ } } ], - "specLocation": "cat/nodes/types.ts#L23-L542" + "specLocation": "cat/templates/types.ts#L22-L48" }, { "attachedBehaviors": [ @@ -91413,7 +95613,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Returns thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "inherits": { "type": { "name": "CatRequestBase", @@ -91423,62 +95623,37 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.nodes" + "namespace": "cat.thread_pool" }, - "path": [], - "query": [ + "path": [ { - "description": "The unit used to display byte values.", - "name": "bytes", + "description": "A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.", + "name": "thread_pool_patterns", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", + "name": "Names", "namespace": "_types" } } - }, - { - "description": "If `true`, return the full node ID. If `false`, return the shortened node ID.", - "name": "full_id", - "required": false, - "serverDefault": "false", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, + } + ], + "query": [ { - "description": "If true, the response includes information from segments that are not loaded into memory.", - "name": "include_unloaded_segments", + "description": "The unit used to display time values.", + "name": "time", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "TimeUnit", + "namespace": "_types" } } } ], - "specLocation": "cat/nodes/CatNodesRequest.ts#L23-L49" + "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L48" }, { "body": { @@ -91488,8 +95663,8 @@ "value": { "kind": "instance_of", "type": { - "name": "NodesRecord", - "namespace": "cat.nodes" + "name": "ThreadPoolRecord", + "namespace": "cat.thread_pool" } } } @@ -91497,23 +95672,23 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.nodes" + "namespace": "cat.thread_pool" }, - "specLocation": "cat/nodes/CatNodesResponse.ts#L22-L24" + "specLocation": "cat/thread_pool/CatThreadPoolResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "PendingTasksRecord", - "namespace": "cat.pending_tasks" + "name": "ThreadPoolRecord", + "namespace": "cat.thread_pool" }, "properties": [ { "aliases": [ - "o" + "nn" ], - "description": "The task insertion order.", - "name": "insertOrder", + "description": "The node name.", + "name": "node_name", "required": false, "type": { "kind": "instance_of", @@ -91525,10 +95700,25 @@ }, { "aliases": [ - "t" + "id" ], - "description": "Indicates how long the task has been in queue.", - "name": "timeInQueue", + "description": "The persistent node identifier.", + "name": "node_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "eid" + ], + "description": "The ephemeral node identifier.", + "name": "ephemeral_node_id", "required": false, "type": { "kind": "instance_of", @@ -91542,8 +95732,8 @@ "aliases": [ "p" ], - "description": "The task priority.", - "name": "priority", + "description": "The process identifier.", + "name": "pid", "required": false, "type": { "kind": "instance_of", @@ -91555,10 +95745,10 @@ }, { "aliases": [ - "s" + "h" ], - "description": "The task source.", - "name": "source", + "description": "The host name for the current node.", + "name": "host", "required": false, "type": { "kind": "instance_of", @@ -91567,71 +95757,34 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/pending_tasks/types.ts#L20-L41" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns cluster-level changes that have not yet been executed.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.pending_tasks" - }, - "path": [], - "query": [], - "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L22-L31" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "aliases": [ + "i" + ], + "description": "The IP address for the current node.", + "name": "ip", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PendingTasksRecord", - "namespace": "cat.pending_tasks" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.pending_tasks" - }, - "specLocation": "cat/pending_tasks/CatPendingTasksResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "PluginsRecord", - "namespace": "cat.plugins" - }, - "properties": [ + }, { - "description": "The unique node identifier.", - "name": "id", + "aliases": [ + "po" + ], + "description": "The bound transport port for the current node.", + "name": "port", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, @@ -91639,23 +95792,23 @@ "aliases": [ "n" ], - "description": "The node name.", + "description": "The thread pool name.", "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "c" + "t" ], - "description": "The component name.", - "name": "component", + "description": "The thread pool type.\nReturned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`.", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -91667,25 +95820,25 @@ }, { "aliases": [ - "v" + "a" ], - "description": "The component version.", - "name": "version", + "description": "The number of active threads in the current thread pool.", + "name": "active", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "d" + "psz" ], - "description": "The plugin details.", - "name": "description", + "description": "The number of threads in the current thread pool.", + "name": "pool_size", "required": false, "type": { "kind": "instance_of", @@ -91697,10 +95850,10 @@ }, { "aliases": [ - "t" + "q" ], - "description": "The plugin type.", - "name": "type", + "description": "The number of tasks currently in queue.", + "name": "queue", "required": false, "type": { "kind": "instance_of", @@ -91709,85 +95862,43 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/plugins/types.ts#L22-L52" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.plugins" - }, - "path": [], - "query": [], - "specLocation": "cat/plugins/CatPluginsRequest.ts#L22-L31" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "aliases": [ + "qs" + ], + "description": "The maximum number of tasks permitted in the queue.", + "name": "queue_size", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PluginsRecord", - "namespace": "cat.plugins" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.plugins" - }, - "specLocation": "cat/plugins/CatPluginsResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "RecoveryRecord", - "namespace": "cat.recovery" - }, - "properties": [ + }, { "aliases": [ - "i", - "idx" + "r" ], - "description": "The index name.", - "name": "index", + "description": "The number of rejected tasks.", + "name": "rejected", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "s", - "sh" + "l" ], - "description": "The shard name.", - "name": "shard", + "description": "The highest number of active threads in the current thread pool.", + "name": "largest", "required": false, "type": { "kind": "instance_of", @@ -91799,209 +95910,290 @@ }, { "aliases": [ - "start" + "c" ], - "description": "The recovery start time.", - "name": "start_time", + "description": "The number of completed tasks.", + "name": "completed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "start_millis" + "cr" ], - "description": "The recovery start time in epoch milliseconds.", - "name": "start_time_millis", + "description": "The core number of active threads allowed in a scaling thread pool.", + "name": "core", "required": false, "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "UnitMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } } ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } + "kind": "union_of" } }, { "aliases": [ - "stop" + "mx" ], - "description": "The recovery stop time.", - "name": "stop_time", + "description": "The maximum number of active threads allowed in a scaling thread pool.", + "name": "max", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "stop_millis" + "sz" ], - "description": "The recovery stop time in epoch milliseconds.", - "name": "stop_time_millis", + "description": "The number of active threads allowed in a fixed thread pool.", + "name": "size", "required": false, "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "UnitMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "ka" + ], + "description": "The thread keep alive time.", + "name": "keep_alive", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } } ], + "kind": "union_of" + } + } + ], + "specLocation": "cat/thread_pool/types.ts#L22-L124" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns configuration and usage information about transforms.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.transforms" + }, + "path": [ + { + "description": "A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.", + "name": "transform_id", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "EpochTime", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "t", - "ti" - ], - "description": "The recovery time.", - "name": "time", + "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.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "ty" - ], - "description": "The recovery type.", - "name": "type", + "description": "Skips the specified number of transforms.", + "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "st" - ], - "description": "The recovery stage.", - "name": "stage", + "description": "Comma-separated list of column names to display.", + "name": "h", "required": false, + "serverDefault": "changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatTransformColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "shost" - ], - "description": "The source host.", - "name": "source_host", + "description": "Comma-separated list of column names or column aliases used to sort the response.", + "name": "s", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatTransformColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "snode" - ], - "description": "The source node name.", - "name": "source_node", + "description": "The unit used to display time values.", + "name": "time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TimeUnit", + "namespace": "_types" } } }, { - "aliases": [ - "thost" - ], - "description": "The target host.", - "name": "target_host", + "description": "The maximum number of transforms to obtain.", + "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, - { - "aliases": [ - "tnode" - ], - "description": "The target node name.", - "name": "target_node", - "required": false, - "type": { + } + ], + "specLocation": "cat/transforms/CatTransformsRequest.ts#L25-L77" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TransformsRecord", + "namespace": "cat.transforms" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.transforms" + }, + "specLocation": "cat/transforms/CatTransformsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TransformsRecord", + "namespace": "cat.transforms" + }, + "properties": [ { - "aliases": [ - "rep" - ], - "description": "The repository name.", - "name": "repository", + "description": "The transform identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "snap" + "s" ], - "description": "The snapshot name.", - "name": "snapshot", + "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.", + "name": "state", "required": false, "type": { "kind": "instance_of", @@ -92013,10 +96205,10 @@ }, { "aliases": [ - "f" + "c" ], - "description": "The number of files to recover.", - "name": "files", + "description": "The sequence number for the checkpoint.", + "name": "checkpoint", "required": false, "type": { "kind": "instance_of", @@ -92028,10 +96220,11 @@ }, { "aliases": [ - "fr" + "docp", + "documentsProcessed" ], - "description": "The files recovered.", - "name": "files_recovered", + "description": "The number of documents that have been processed from the source index of the transform.", + "name": "documents_processed", "required": false, "type": { "kind": "instance_of", @@ -92043,55 +96236,94 @@ }, { "aliases": [ - "fp" + "cp", + "checkpointProgress" ], - "description": "The ratio of files recovered.", - "name": "files_percent", + "description": "The progress of the next checkpoint that is currently in progress.", + "name": "checkpoint_progress", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Percentage", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "tf" + "lst", + "lastSearchTime" ], - "description": "The total number of files.", - "name": "files_total", + "description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.", + "name": "last_search_time", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "b" + "cldt" ], - "description": "The number of bytes to recover.", - "name": "bytes", + "description": "The timestamp when changes were last detected in the source indices.", + "name": "changes_last_detection_time", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "br" + "ct", + "createTime" ], - "description": "The bytes recovered.", - "name": "bytes_recovered", + "description": "The time the transform was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", @@ -92103,25 +96335,26 @@ }, { "aliases": [ - "bp" + "v" ], - "description": "The ratio of bytes recovered.", - "name": "bytes_percent", + "description": "The version of Elasticsearch that existed on the node when the transform was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", + "name": "VersionString", "namespace": "_types" } } }, { "aliases": [ - "tb" + "si", + "sourceIndex" ], - "description": "The total number of bytes.", - "name": "bytes_total", + "description": "The source indices for the transform.", + "name": "source_index", "required": false, "type": { "kind": "instance_of", @@ -92133,10 +96366,11 @@ }, { "aliases": [ - "to" + "di", + "destIndex" ], - "description": "The number of translog operations to recover.", - "name": "translog_ops", + "description": "The destination index for the transform.", + "name": "dest_index", "required": false, "type": { "kind": "instance_of", @@ -92148,10 +96382,10 @@ }, { "aliases": [ - "tor" + "p" ], - "description": "The translog operations recovered.", - "name": "translog_ops_recovered", + "description": "The unique identifier for the ingest pipeline.", + "name": "pipeline", "required": false, "type": { "kind": "instance_of", @@ -92163,132 +96397,55 @@ }, { "aliases": [ - "top" + "d" ], - "description": "The ratio of translog operations recovered.", - "name": "translog_ops_percent", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Percentage", - "namespace": "_types" - } - } - } - ], - "specLocation": "cat/recovery/types.ts#L24-L155" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.recovery" - }, - "path": [ - { - "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`.", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "If `true`, the response only includes ongoing shard recoveries.", - "name": "active_only", + "description": "The description of the transform.", + "name": "description", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The unit used to display byte values.", - "name": "bytes", + "aliases": [ + "tt" + ], + "description": "The type of transform: `batch` or `continuous`.", + "name": "transform_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If `true`, the response includes detailed information about shard recoveries.", - "name": "detailed", + "aliases": [ + "f" + ], + "description": "The interval between checks for changes in the source indices when the transform is running continuously.", + "name": "frequency", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "cat/recovery/CatRecoveryRequest.ts#L23-L59" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RecoveryRecord", - "namespace": "cat.recovery" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.recovery" - }, - "specLocation": "cat/recovery/CatRecoveryResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "RepositoriesRecord", - "namespace": "cat.repositories" - }, - "properties": [ + }, { "aliases": [ - "repoId" + "mpsz" ], - "description": "The unique repository identifier.", - "name": "id", + "description": "The initial page size that is used for the composite aggregation for each checkpoint.", + "name": "max_page_search_size", "required": false, "type": { "kind": "instance_of", @@ -92300,10 +96457,10 @@ }, { "aliases": [ - "t" + "dps" ], - "description": "The repository type.", - "name": "type", + "description": "The number of input documents per second.", + "name": "docs_per_second", "required": false, "type": { "kind": "instance_of", @@ -92312,156 +96469,43 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/repositories/types.ts#L20-L31" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns the snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.repositories" - }, - "path": [], - "query": [], - "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L22-L31" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RepositoriesRecord", - "namespace": "cat.repositories" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.repositories" - }, - "specLocation": "cat/repositories/CatRepositoriesResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.segments" - }, - "path": [ - { - "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`.", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - } - ], - "query": [ + }, { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - } - ], - "specLocation": "cat/segments/CatSegmentsRequest.ts#L23-L49" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SegmentsRecord", - "namespace": "cat.segments" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.segments" - }, - "specLocation": "cat/segments/CatSegmentsResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "SegmentsRecord", - "namespace": "cat.segments" - }, - "properties": [ + "aliases": [ + "r" + ], + "description": "If a transform has a `failed` state, these details describe the reason for failure.", + "name": "reason", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "aliases": [ - "i", - "idx" + "st" ], - "description": "The index name.", - "name": "index", + "description": "The total number of search operations on the source index for the transform.", + "name": "search_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "s", - "sh" + "sf" ], - "description": "The shard name.", - "name": "shard", + "description": "The total number of search failures.", + "name": "search_failure", "required": false, "type": { "kind": "instance_of", @@ -92473,12 +96517,10 @@ }, { "aliases": [ - "p", - "pr", - "primaryOrReplica" + "stime" ], - "description": "The shard type: `primary` or `replica`.", - "name": "prirep", + "description": "The total amount of search time, in milliseconds.", + "name": "search_time", "required": false, "type": { "kind": "instance_of", @@ -92489,8 +96531,11 @@ } }, { - "description": "The IP address of the node where it lives.", - "name": "ip", + "aliases": [ + "it" + ], + "description": "The total number of index operations done by the transform.", + "name": "index_total", "required": false, "type": { "kind": "instance_of", @@ -92501,23 +96546,26 @@ } }, { - "description": "The unique identifier of the node where it lives.", - "name": "id", + "aliases": [ + "if" + ], + "description": "The total number of indexing failures.", + "name": "index_failure", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "seg" + "itime" ], - "description": "The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard.", - "name": "segment", + "description": "The total time spent indexing documents, in milliseconds.", + "name": "index_time", "required": false, "type": { "kind": "instance_of", @@ -92529,11 +96577,10 @@ }, { "aliases": [ - "g", - "gen" + "doci" ], - "description": "The segment generation number.\nElasticsearch increments this generation number for each segment written then uses this number to derive the segment name.", - "name": "generation", + "description": "The number of documents that have been indexed into the destination index for the transform.", + "name": "documents_indexed", "required": false, "type": { "kind": "instance_of", @@ -92545,11 +96592,10 @@ }, { "aliases": [ - "dc", - "docsCount" + "dtime" ], - "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.", - "name": "docs.count", + "description": "The total time spent deleting documents, in milliseconds.", + "name": "delete_time", "required": false, "type": { "kind": "instance_of", @@ -92561,11 +96607,10 @@ }, { "aliases": [ - "dd", - "docsDeleted" + "docd" ], - "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.", - "name": "docs.deleted", + "description": "The number of documents deleted from the destination index due to the retention policy for the transform.", + "name": "documents_deleted", "required": false, "type": { "kind": "instance_of", @@ -92577,42 +96622,40 @@ }, { "aliases": [ - "si" + "tc" ], - "description": "The segment size in bytes.", - "name": "size", + "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.", + "name": "trigger_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "sm", - "sizeMemory" + "pp" ], - "description": "The segment memory in bytes.\nA value of `-1` indicates Elasticsearch was unable to compute this number.", - "name": "size.memory", + "description": "The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually.", + "name": "pages_processed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ic", - "isCommitted" + "pt" ], - "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.", - "name": "committed", + "description": "The total time spent processing results, in milliseconds.", + "name": "processing_time", "required": false, "type": { "kind": "instance_of", @@ -92624,11 +96667,11 @@ }, { "aliases": [ - "is", - "isSearchable" + "cdtea", + "checkpointTimeExpAvg" ], - "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.", - "name": "searchable", + "description": "The exponential moving average of the duration of the checkpoint, in milliseconds.", + "name": "checkpoint_duration_time_exp_avg", "required": false, "type": { "kind": "instance_of", @@ -92640,26 +96683,25 @@ }, { "aliases": [ - "v" + "idea" ], - "description": "The version of Lucene used to write the segment.", - "name": "version", + "description": "The exponential moving average of the number of new documents that have been indexed.", + "name": "indexed_documents_exp_avg", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ico", - "isCompound" + "pdea" ], - "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.", - "name": "compound", + "description": "The exponential moving average of the number of documents that have been processed.", + "name": "processed_documents_exp_avg", "required": false, "type": { "kind": "instance_of", @@ -92670,332 +96712,162 @@ } } ], - "specLocation": "cat/segments/types.ts#L22-L107" + "specLocation": "cat/transforms/types.ts#L22-L197" }, { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cat.shards" + "name": "FollowIndexStats", + "namespace": "ccr._types" }, - "path": [ + "properties": [ { - "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`.", "name": "index", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "IndexName", "namespace": "_types" } } - } - ], - "query": [ + }, { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, + "name": "shards", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardStats", + "namespace": "ccr._types" + } } } } ], - "specLocation": "cat/shards/CatShardsRequest.ts#L23-L49" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardsRecord", - "namespace": "cat.shards" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.shards" - }, - "specLocation": "cat/shards/CatShardsResponse.ts#L22-L24" + "specLocation": "ccr/_types/FollowIndexStats.ts#L30-L33" }, { "kind": "interface", "name": { - "name": "ShardsRecord", - "namespace": "cat.shards" + "name": "ReadException", + "namespace": "ccr._types" }, "properties": [ { - "aliases": [ - "i", - "idx" - ], - "description": "The index name.", - "name": "index", - "required": false, + "name": "exception", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ErrorCause", + "namespace": "_types" } } }, { - "aliases": [ - "s", - "sh" - ], - "description": "The shard name.", - "name": "shard", - "required": false, + "name": "from_seq_no", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SequenceNumber", + "namespace": "_types" } } }, { - "aliases": [ - "p", - "pr", - "primaryOrReplica" - ], - "description": "The shard type: `primary` or `replica`.", - "name": "prirep", - "required": false, + "name": "retries", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ccr/_types/FollowIndexStats.ts#L71-L75" + }, + { + "kind": "interface", + "name": { + "name": "ShardStats", + "namespace": "ccr._types" + }, + "properties": [ { - "aliases": [ - "st" - ], - "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.", - "name": "state", - "required": false, + "name": "bytes_read", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "d", - "dc" - ], - "description": "The number of documents in the shard.", - "name": "docs", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "sto" - ], - "description": "The disk space used by the shard.", - "name": "store", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "The IP address of the node.", - "name": "ip", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "The unique identifier for the node.", - "name": "id", - "required": false, + "name": "failed_read_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "n" - ], - "description": "The name of node.", - "name": "node", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "The sync identifier.", - "name": "sync_id", - "required": false, + "name": "failed_write_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "ur" - ], - "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.", - "name": "unassigned.reason", + "name": "fatal_exception", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ErrorCause", + "namespace": "_types" } } }, { - "aliases": [ - "ua" - ], - "description": "The time at which the shard became unassigned in Coordinated Universal Time (UTC).", - "name": "unassigned.at", - "required": false, + "name": "follower_aliases_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "uf" - ], - "description": "The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).", - "name": "unassigned.for", - "required": false, + "name": "follower_global_checkpoint", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "ud" - ], - "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.", - "name": "unassigned.details", - "required": false, + "name": "follower_index", + "required": true, "type": { "kind": "instance_of", "type": { @@ -93005,92 +96877,63 @@ } }, { - "aliases": [ - "rs" - ], - "description": "The type of recovery source.", - "name": "recoverysource.type", - "required": false, + "name": "follower_mapping_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "cs", - "completionSize" - ], - "description": "The size of completion.", - "name": "completion.size", - "required": false, + "name": "follower_max_seq_no", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SequenceNumber", + "namespace": "_types" } } }, { - "aliases": [ - "fm", - "fielddataMemory" - ], - "description": "The used fielddata cache memory.", - "name": "fielddata.memory_size", - "required": false, + "name": "follower_settings_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "fe", - "fielddataEvictions" - ], - "description": "The fielddata cache evictions.", - "name": "fielddata.evictions", - "required": false, + "name": "last_requested_seq_no", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SequenceNumber", + "namespace": "_types" } } }, { - "aliases": [ - "qcm", - "queryCacheMemory" - ], - "description": "The used query cache memory.", - "name": "query_cache.memory_size", - "required": false, + "name": "leader_global_checkpoint", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - }, - { - "aliases": [ - "qce", - "queryCacheEvictions" - ], - "description": "The query cache evictions.", - "name": "query_cache.evictions", - "required": false, + }, + { + "name": "leader_index", + "required": true, "type": { "kind": "instance_of", "type": { @@ -93100,109 +96943,77 @@ } }, { - "aliases": [ - "ft", - "flushTotal" - ], - "description": "The number of flushes.", - "name": "flush.total", - "required": false, + "name": "leader_max_seq_no", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SequenceNumber", + "namespace": "_types" } } }, { - "aliases": [ - "ftt", - "flushTotalTime" - ], - "description": "The time spent in flush.", - "name": "flush.total_time", - "required": false, + "name": "operations_read", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "gc", - "getCurrent" - ], - "description": "The number of current get operations.", - "name": "get.current", - "required": false, + "name": "operations_written", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "gti", - "getTime" - ], - "description": "The time spent in get operations.", - "name": "get.time", - "required": false, + "name": "outstanding_read_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "gto", - "getTotal" - ], - "description": "The number of get operations.", - "name": "get.total", - "required": false, + "name": "outstanding_write_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "geti", - "getExistsTime" - ], - "description": "The time spent in successful get operations.", - "name": "get.exists_time", - "required": false, + "name": "read_exceptions", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ReadException", + "namespace": "ccr._types" + } } } }, { - "aliases": [ - "geto", - "getExistsTotal" - ], - "description": "The number of successful get operations.", - "name": "get.exists_total", - "required": false, + "name": "remote_cluster", + "required": true, "type": { "kind": "instance_of", "type": { @@ -93212,421 +97023,578 @@ } }, { - "aliases": [ - "gmti", - "getMissingTime" - ], - "description": "The time spent in failed get operations.", - "name": "get.missing_time", - "required": false, + "name": "shard_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "gmto", - "getMissingTotal" - ], - "description": "The number of failed get operations.", - "name": "get.missing_total", - "required": false, + "name": "successful_read_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "idc", - "indexingDeleteCurrent" - ], - "description": "The number of current deletion operations.", - "name": "indexing.delete_current", - "required": false, + "name": "successful_write_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "idti", - "indexingDeleteTime" - ], - "description": "The time spent in deletion operations.", - "name": "indexing.delete_time", + "name": "time_since_last_read", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "idto", - "indexingDeleteTotal" - ], - "description": "The number of delete operations.", - "name": "indexing.delete_total", - "required": false, + "name": "time_since_last_read_millis", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DurationValue", + "namespace": "_types" } } }, { - "aliases": [ - "iic", - "indexingIndexCurrent" - ], - "description": "The number of current indexing operations.", - "name": "indexing.index_current", + "name": "total_read_remote_exec_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "iiti", - "indexingIndexTime" - ], - "description": "The time spent in indexing operations.", - "name": "indexing.index_time", - "required": false, + "name": "total_read_remote_exec_time_millis", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DurationValue", + "namespace": "_types" } } }, { - "aliases": [ - "iito", - "indexingIndexTotal" - ], - "description": "The number of indexing operations.", - "name": "indexing.index_total", + "name": "total_read_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "iif", - "indexingIndexFailed" - ], - "description": "The number of failed indexing operations.", - "name": "indexing.index_failed", - "required": false, + "name": "total_read_time_millis", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DurationValue", + "namespace": "_types" } } }, { - "aliases": [ - "mc", - "mergesCurrent" - ], - "description": "The number of current merge operations.", - "name": "merges.current", + "name": "total_write_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "mcd", - "mergesCurrentDocs" - ], - "description": "The number of current merging documents.", - "name": "merges.current_docs", - "required": false, + "name": "total_write_time_millis", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DurationValue", + "namespace": "_types" } } }, { - "aliases": [ - "mcs", - "mergesCurrentSize" - ], - "description": "The size of current merge operations.", - "name": "merges.current_size", - "required": false, + "name": "write_buffer_operation_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "mt", - "mergesTotal" - ], - "description": "The number of completed merge operations.", - "name": "merges.total", - "required": false, + "name": "write_buffer_size_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ccr/_types/FollowIndexStats.ts#L35-L69" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes auto-follow patterns.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.delete_auto_follow_pattern" + }, + "path": [ { - "aliases": [ - "mtd", - "mergesTotalDocs" - ], - "description": "The nuber of merged documents.", - "name": "merges.total_docs", - "required": false, + "description": "The name of the auto follow pattern.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } - }, + } + ], + "query": [], + "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.delete_auto_follow_pattern" + }, + "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "leader_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "max_outstanding_read_requests", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_outstanding_write_requests", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_read_request_operation_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_read_request_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_retry_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_write_request_operation_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_write_request_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "read_poll_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "remote_cluster", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Creates a new follower index configured to follow the referenced leader index.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.follow" + }, + "path": [ { - "aliases": [ - "mts", - "mergesTotalSize" - ], - "description": "The size of current merges.", - "name": "merges.total_size", - "required": false, + "description": "The name of the follower index", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "mtt", - "mergesTotalTime" - ], - "description": "The time spent merging documents.", - "name": "merges.total_time", + "description": "Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", + "name": "wait_for_active_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "WaitForActiveShards", + "namespace": "_types" } } - }, - { - "description": "The total number of refreshes.", - "name": "refresh.total", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L25-L51" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "follow_index_created", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "description": "The time spent in refreshes.", - "name": "refresh.time", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "follow_index_shards_acked", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "index_following_started", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.follow" + }, + "specLocation": "ccr/follow/CreateFollowIndexResponse.ts#L20-L26" + }, + { + "kind": "interface", + "name": { + "name": "FollowerIndex", + "namespace": "ccr.follow_info" + }, + "properties": [ { - "aliases": [ - "rto", - "refreshTotal" - ], - "description": "The total nunber of external refreshes.", - "name": "refresh.external_total", - "required": false, + "name": "follower_index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { - "aliases": [ - "rti", - "refreshTime" - ], - "description": "The time spent in external refreshes.", - "name": "refresh.external_time", - "required": false, + "name": "leader_index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { - "aliases": [ - "rli", - "refreshListeners" - ], - "description": "The number of pending refresh listeners.", - "name": "refresh.listeners", + "name": "parameters", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FollowerIndexParameters", + "namespace": "ccr.follow_info" } } }, { - "aliases": [ - "sfc", - "searchFetchCurrent" - ], - "description": "The current fetch phase operations.", - "name": "search.fetch_current", - "required": false, + "name": "remote_cluster", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "aliases": [ - "sfti", - "searchFetchTime" - ], - "description": "The time spent in fetch phase.", - "name": "search.fetch_time", - "required": false, + "name": "status", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FollowerIndexStatus", + "namespace": "ccr.follow_info" } } - }, + } + ], + "specLocation": "ccr/follow_info/types.ts#L22-L28" + }, + { + "kind": "interface", + "name": { + "name": "FollowerIndexParameters", + "namespace": "ccr.follow_info" + }, + "properties": [ { - "aliases": [ - "sfto", - "searchFetchTotal" - ], - "description": "The total number of fetch operations.", - "name": "search.fetch_total", - "required": false, + "name": "max_outstanding_read_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "so", - "searchOpenContexts" - ], - "description": "The number of open search contexts.", - "name": "search.open_contexts", - "required": false, + "name": "max_outstanding_write_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "sqc", - "searchQueryCurrent" - ], - "description": "The current query phase operations.", - "name": "search.query_current", - "required": false, + "name": "max_read_request_operation_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "sqti", - "searchQueryTime" - ], - "description": "The time spent in query phase.", - "name": "search.query_time", - "required": false, + "name": "max_read_request_size", + "required": true, "type": { "kind": "instance_of", "type": { @@ -93636,45 +97604,30 @@ } }, { - "aliases": [ - "sqto", - "searchQueryTotal" - ], - "description": "The total number of query phase operations.", - "name": "search.query_total", - "required": false, + "name": "max_retry_delay", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "scc", - "searchScrollCurrent" - ], - "description": "The open scroll contexts.", - "name": "search.scroll_current", - "required": false, + "name": "max_write_buffer_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "scti", - "searchScrollTime" - ], - "description": "The time scroll contexts were held open.", - "name": "search.scroll_time", - "required": false, + "name": "max_write_buffer_size", + "required": true, "type": { "kind": "instance_of", "type": { @@ -93684,29 +97637,19 @@ } }, { - "aliases": [ - "scto", - "searchScrollTotal" - ], - "description": "The number of completed scroll contexts.", - "name": "search.scroll_total", - "required": false, + "name": "max_write_request_operation_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "sc", - "segmentsCount" - ], - "description": "The number of segments.", - "name": "segments.count", - "required": false, + "name": "max_write_request_size", + "required": true, "type": { "kind": "instance_of", "type": { @@ -93716,205 +97659,321 @@ } }, { - "aliases": [ - "sm", - "segmentsMemory" - ], - "description": "The memory used by segments.", - "name": "segments.memory", - "required": false, + "name": "read_poll_timeout", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } + } + ], + "specLocation": "ccr/follow_info/types.ts#L38-L49" + }, + { + "kind": "enum", + "members": [ + { + "name": "active" }, { - "aliases": [ - "siwm", - "segmentsIndexWriterMemory" - ], - "description": "The memory used by the index writer.", - "name": "segments.index_writer_memory", - "required": false, + "name": "paused" + } + ], + "name": { + "name": "FollowerIndexStatus", + "namespace": "ccr.follow_info" + }, + "specLocation": "ccr/follow_info/types.ts#L30-L33" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves information about all follower indices, including parameters and status for each follower index", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.follow_info" + }, + "path": [ + { + "description": "A comma-separated list of index patterns; use `_all` to perform the operation on all indices", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Indices", + "namespace": "_types" } } - }, - { - "aliases": [ - "svmm", - "segmentsVersionMapMemory" - ], - "description": "The memory used by the version map.", - "name": "segments.version_map_memory", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "ccr/follow_info/FollowInfoRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "follower_indices", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FollowerIndex", + "namespace": "ccr.follow_info" + } + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.follow_info" + }, + "specLocation": "ccr/follow_info/FollowInfoResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.follow_stats" + }, + "path": [ { - "aliases": [ - "sfbm", - "fixedBitsetMemory" - ], - "description": "The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields.", - "name": "segments.fixed_bitset_memory", - "required": false, + "description": "A comma-separated list of index patterns; use `_all` to perform the operation on all indices", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Indices", + "namespace": "_types" } } - }, - { - "aliases": [ - "sqm", - "maxSeqNo" - ], - "description": "The maximum sequence number.", - "name": "seq_no.max", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "ccr/follow_stats/FollowIndexStatsRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "indices", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FollowIndexStats", + "namespace": "ccr._types" + } + } } } - }, - { - "aliases": [ - "sql", - "localCheckpoint" - ], - "description": "The local checkpoint.", - "name": "seq_no.local_checkpoint", - "required": false, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.follow_stats" + }, + "specLocation": "ccr/follow_stats/FollowIndexStatsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "follower_cluster", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "follower_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "follower_index_uuid", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Uuid", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "sqg", - "globalCheckpoint" - ], - "description": "The global checkpoint.", - "name": "seq_no.global_checkpoint", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "leader_remote_cluster", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, + ] + }, + "description": "Removes the follower retention leases from the leader.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.forget_follower" + }, + "path": [ { - "aliases": [ - "wc", - "warmerCurrent" - ], - "description": "The number of current warmer operations.", - "name": "warmer.current", - "required": false, + "description": "the name of the leader index for which specified follower retention leases should be removed", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } - }, - { - "aliases": [ - "wto", - "warmerTotal" - ], - "description": "The total number of warmer operations.", - "name": "warmer.total", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L38" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "_shards", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "ShardStatistics", + "namespace": "_types" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.forget_follower" + }, + "specLocation": "ccr/forget_follower/ForgetFollowerIndexResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "AutoFollowPattern", + "namespace": "ccr.get_auto_follow_pattern" + }, + "properties": [ { - "aliases": [ - "wtt", - "warmerTotalTime" - ], - "description": "The time spent in warmer operations.", - "name": "warmer.total_time", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "aliases": [ - "pd", - "dataPath" - ], - "description": "The shard data path.", - "name": "path.data", - "required": false, + "name": "pattern", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AutoFollowPatternSummary", + "namespace": "ccr.get_auto_follow_pattern" } } - }, + } + ], + "specLocation": "ccr/get_auto_follow_pattern/types.ts#L23-L26" + }, + { + "kind": "interface", + "name": { + "name": "AutoFollowPatternSummary", + "namespace": "ccr.get_auto_follow_pattern" + }, + "properties": [ { - "aliases": [ - "ps", - "statsPath" - ], - "description": "The shard state path.", - "name": "path.state", - "required": false, + "name": "active", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "bto", - "bulkTotalOperations" - ], - "description": "The number of bulk shard operations.", - "name": "bulk.total_operations", - "required": false, + "description": "The remote cluster containing the leader indices to match against.", + "name": "remote_cluster", + "required": true, "type": { "kind": "instance_of", "type": { @@ -93924,1173 +97983,1166 @@ } }, { - "aliases": [ - "btti", - "bulkTotalTime" - ], - "description": "The time spent in shard bulk operations.", - "name": "bulk.total_time", + "description": "The name of follower index.", + "name": "follow_index_pattern", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexPattern", + "namespace": "_types" } } }, { - "aliases": [ - "btsi", - "bulkTotalSizeInBytes" - ], - "description": "The total size in bytes of shard bulk operations.", - "name": "bulk.total_size_in_bytes", - "required": false, + "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", + "name": "leader_index_patterns", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexPatterns", + "namespace": "_types" } } }, { - "aliases": [ - "bati", - "bulkAvgTime" - ], - "description": "The average time spent in shard bulk operations.", - "name": "bulk.avg_time", - "required": false, + "availability": { + "serverless": {}, + "stack": { + "since": "7.14.0" + } + }, + "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed.", + "name": "leader_index_exclusion_patterns", + "required": true, + "since": "7.14.0", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexPatterns", + "namespace": "_types" } } }, { - "aliases": [ - "basi", - "bulkAvgSizeInBytes" - ], - "description": "The average size in bytes of shard bulk operations.", - "name": "bulk.avg_size_in_bytes", - "required": false, + "description": "The maximum number of outstanding reads requests from the remote cluster.", + "name": "max_outstanding_read_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "cat/shards/types.ts#L20-L421" + "specLocation": "ccr/get_auto_follow_pattern/types.ts#L28-L52" }, { "attachedBehaviors": [ - "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, - "description": "Returns information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", + "description": "Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.", "inherits": { "type": { - "name": "CatRequestBase", - "namespace": "cat._types" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "cat.snapshots" + "namespace": "ccr.get_auto_follow_pattern" }, "path": [ { - "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.", - "name": "repository", + "description": "Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "Name", "namespace": "_types" } } } ], - "query": [ + "query": [], + "specLocation": "ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts#L23-L33" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "patterns", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoFollowPattern", + "namespace": "ccr.get_auto_follow_pattern" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.get_auto_follow_pattern" + }, + "specLocation": "ccr/get_auto_follow_pattern/GetAutoFollowPatternResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Pauses an auto-follow pattern", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.pause_auto_follow_pattern" + }, + "path": [ { - "description": "If `true`, the response does not include information from unavailable snapshots.", - "name": "ignore_unavailable", - "required": false, - "serverDefault": false, + "description": "The name of the auto follow pattern that should pause discovering new indices to follow.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } } ], - "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L23-L50" + "query": [], + "specLocation": "ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts#L23-L32" }, { "body": { "kind": "value", "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SnapshotsRecord", - "namespace": "cat.snapshots" - } + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } } }, "kind": "response", "name": { "name": "Response", - "namespace": "cat.snapshots" + "namespace": "ccr.pause_auto_follow_pattern" }, - "specLocation": "cat/snapshots/CatSnapshotsResponse.ts#L22-L24" + "specLocation": "ccr/pause_auto_follow_pattern/PauseAutoFollowPatternResponse.ts#L22-L24" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Pauses a follower index. The follower index will not fetch any additional operations from the leader index.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "SnapshotsRecord", - "namespace": "cat.snapshots" + "name": "Request", + "namespace": "ccr.pause_follow" }, - "properties": [ + "path": [ { - "aliases": [ - "snapshot" - ], - "description": "The unique identifier for the snapshot.", - "name": "id", - "required": false, + "description": "The name of the follower index that should pause following its leader index.", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } - }, - { - "aliases": [ - "re", - "repo" - ], - "description": "The repository name.", - "name": "repository", - "required": false, + } + ], + "query": [], + "specLocation": "ccr/pause_follow/PauseFollowIndexRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.pause_follow" + }, + "specLocation": "ccr/pause_follow/PauseFollowIndexResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The remote cluster containing the leader indices to match against.", + "docId": "modules-remote-clusters", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-remote-clusters.html", + "name": "remote_cluster", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "aliases": [ - "s" - ], - "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.", - "name": "status", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.", + "name": "follow_index_pattern", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "IndexPattern", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "ste", - "startEpoch" - ], - "description": "The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.", - "name": "start_epoch", - "required": false, - "type": { - "generics": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitSeconds", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } + }, + { + "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", + "name": "leader_index_patterns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexPatterns", + "namespace": "_types" } - ], - "kind": "instance_of", + } + }, + { + "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.", + "name": "leader_index_exclusion_patterns", + "required": false, "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "IndexPatterns", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "sti", - "startTime" - ], - "description": "The time (HH:MM:SS) at which the snapshot process started.", - "name": "start_time", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The maximum number of outstanding reads requests from the remote cluster.", + "name": "max_outstanding_read_requests", + "required": false, + "serverDefault": 12, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", + "name": "settings", + "required": false, "type": { - "name": "ScheduleTimeOfDay", - "namespace": "watcher._types" - } - } - }, - { - "aliases": [ - "ete", - "endEpoch" - ], - "description": "The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.", - "name": "end_epoch", - "required": false, - "type": { - "generics": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitSeconds", - "namespace": "_types" - } - } - ], + "key": { "kind": "instance_of", "type": { - "name": "EpochTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } - ], - "kind": "instance_of", + } + }, + { + "description": "The maximum number of outstanding reads requests from the remote cluster.", + "name": "max_outstanding_write_requests", + "required": false, + "serverDefault": 9, "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "eti", - "endTime" - ], - "description": "The time (HH:MM:SS) at which the snapshot process ended.", - "name": "end_time", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.", + "name": "read_poll_timeout", + "required": false, + "serverDefault": "1m", "type": { - "name": "TimeOfDay", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "dur" - ], - "description": "The time it took the snapshot process to complete, in time units.", - "name": "duration", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The maximum number of operations to pull per read from the remote cluster.", + "name": "max_read_request_operation_count", + "required": false, + "serverDefault": 5120, "type": { - "name": "Duration", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "i" - ], - "description": "The number of indices in the snapshot.", - "name": "indices", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", + "name": "max_read_request_size", + "required": false, + "serverDefault": "32mb", "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "ss" - ], - "description": "The number of successful shards in the snapshot.", - "name": "successful_shards", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", + "name": "max_retry_delay", + "required": false, + "serverDefault": "500ms", "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "fs" - ], - "description": "The number of failed shards in the snapshot.", - "name": "failed_shards", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.", + "name": "max_write_buffer_count", + "required": false, + "serverDefault": 2147483647, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "ts" - ], - "description": "The total number of shards in the snapshot.", - "name": "total_shards", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.", + "name": "max_write_buffer_size", + "required": false, + "serverDefault": "512mb", "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of operations per bulk write request executed on the follower.", + "name": "max_write_request_operation_count", + "required": false, + "serverDefault": 5120, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum total bytes of operations per bulk write request executed on the follower.", + "name": "max_write_request_size", + "required": false, + "serverDefault": "9223372036854775807b", + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } } } - }, + ] + }, + "description": "Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.put_auto_follow_pattern" + }, + "path": [ { - "aliases": [ - "r" - ], - "description": "The reason for any snapshot failures.", - "name": "reason", - "required": false, + "description": "The name of the collection of auto-follow patterns.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } } ], - "specLocation": "cat/snapshots/types.ts#L24-L96" + "query": [], + "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts#L27-L112" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.put_auto_follow_pattern" + }, + "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternResponse.ts#L22-L24" }, { "attachedBehaviors": [ - "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, - "description": "Returns information about tasks currently executing in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", + "description": "Resumes an auto-follow pattern that has been paused", "inherits": { "type": { - "name": "CatRequestBase", - "namespace": "cat._types" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "cat.tasks" + "namespace": "ccr.resume_auto_follow_pattern" }, - "path": [], - "query": [ - { - "description": "The task action names, which are used to limit the response.", - "name": "actions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "If `true`, the response includes detailed information about shard recoveries.", - "name": "detailed", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Unique node identifiers, which are used to limit the response.", - "name": "node_id", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, + "path": [ { - "description": "The parent task identifier, which is used to limit the response.", - "name": "parent_task_id", - "required": false, + "description": "The name of the auto follow pattern to resume discovering new indices to follow.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } } ], - "specLocation": "cat/tasks/CatTasksRequest.ts#L23-L48" + "query": [], + "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts#L23-L32" }, { "body": { "kind": "value", "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TasksRecord", - "namespace": "cat.tasks" - } + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } } }, "kind": "response", "name": { "name": "Response", - "namespace": "cat.tasks" + "namespace": "ccr.resume_auto_follow_pattern" }, - "specLocation": "cat/tasks/CatTasksResponse.ts#L22-L24" + "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternResponse.ts#L22-L24" }, { - "kind": "interface", - "name": { - "name": "TasksRecord", - "namespace": "cat.tasks" - }, - "properties": [ - { - "description": "The identifier of the task with the node.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "max_outstanding_read_requests", + "required": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "ac" - ], - "description": "The task action.", - "name": "action", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "max_outstanding_write_requests", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "ti" - ], - "description": "The unique task identifier.", - "name": "task_id", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "max_read_request_operation_count", + "required": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "pti" - ], - "description": "The parent task identifier.", - "name": "parent_task_id", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "max_read_request_size", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "aliases": [ - "ty" - ], - "description": "The task type.", - "name": "type", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "max_retry_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_write_request_operation_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_write_request_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "read_poll_timeout", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } } } - }, + ] + }, + "description": "Resumes a follower index that has been paused", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.resume_follow" + }, + "path": [ { - "aliases": [ - "start" - ], - "description": "The start time in milliseconds.", - "name": "start_time", - "required": false, + "description": "The name of the follow index to resume following.", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } - }, - { - "aliases": [ - "ts", - "hms", - "hhmmss" - ], - "description": "The start time in `HH:MM:SS` format.", - "name": "timestamp", - "required": false, + } + ], + "query": [], + "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L46" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.resume_follow" + }, + "specLocation": "ccr/resume_follow/ResumeFollowIndexResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "AutoFollowStats", + "namespace": "ccr.stats" + }, + "properties": [ { - "description": "The running time in nanoseconds.", - "name": "running_time_ns", - "required": false, + "name": "auto_followed_clusters", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoFollowedCluster", + "namespace": "ccr.stats" + } } } }, { - "aliases": [ - "time" - ], - "description": "The running time.", - "name": "running_time", - "required": false, + "name": "number_of_failed_follow_indices", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "ni" - ], - "description": "The unique node identifier.", - "name": "node_id", - "required": false, + "name": "number_of_failed_remote_cluster_state_requests", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "NodeId", + "name": "long", "namespace": "_types" } } }, { - "aliases": [ - "i" - ], - "description": "The IP address for the node.", - "name": "ip", - "required": false, + "name": "number_of_successful_follow_indices", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "po" - ], - "description": "The bound transport port for the node.", - "name": "port", - "required": false, + "name": "recent_auto_follow_errors", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } } } - }, + } + ], + "specLocation": "ccr/stats/types.ts.ts#L33-L39" + }, + { + "kind": "interface", + "name": { + "name": "AutoFollowedCluster", + "namespace": "ccr.stats" + }, + "properties": [ { - "aliases": [ - "n" - ], - "description": "The node name.", - "name": "node", - "required": false, + "name": "cluster_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "aliases": [ - "v" - ], - "description": "The Elasticsearch version.", - "name": "version", - "required": false, + "name": "last_seen_metadata_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "VersionNumber", "namespace": "_types" } } }, { - "aliases": [ - "x" - ], - "description": "The X-Opaque-ID header.", - "name": "x_opaque_id", - "required": false, + "name": "time_since_last_check_millis", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DurationValue", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ccr/stats/types.ts.ts#L27-L31" + }, + { + "kind": "interface", + "name": { + "name": "FollowStats", + "namespace": "ccr.stats" + }, + "properties": [ { - "aliases": [ - "desc" - ], - "description": "The task action description.", - "name": "description", - "required": false, + "name": "indices", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FollowIndexStats", + "namespace": "ccr._types" + } } } } ], - "specLocation": "cat/tasks/types.ts#L22-L101" + "specLocation": "ccr/stats/types.ts.ts#L41-L43" }, { "attachedBehaviors": [ - "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, - "description": "Returns information about index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", + "description": "Gets all stats related to cross-cluster replication.", "inherits": { "type": { - "name": "CatRequestBase", - "namespace": "cat._types" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "cat.templates" + "namespace": "ccr.stats" }, - "path": [ - { - "description": "The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.", - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ], + "path": [], "query": [], - "specLocation": "cat/templates/CatTemplatesRequest.ts#L23-L41" + "specLocation": "ccr/stats/CcrStatsRequest.ts#L22-L27" }, { "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", + "kind": "properties", + "properties": [ + { + "name": "auto_follow_stats", + "required": true, "type": { - "name": "TemplatesRecord", - "namespace": "cat.templates" + "kind": "instance_of", + "type": { + "name": "AutoFollowStats", + "namespace": "ccr.stats" + } + } + }, + { + "name": "follow_stats", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FollowStats", + "namespace": "ccr.stats" + } } } - } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "cat.templates" - }, - "specLocation": "cat/templates/CatTemplatesResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "TemplatesRecord", - "namespace": "cat.templates" + "namespace": "ccr.stats" }, - "properties": [ - { - "aliases": [ - "n" - ], - "description": "The template name.", - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "aliases": [ - "t" - ], - "description": "The template index patterns.", - "name": "index_patterns", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "o", - "p" - ], - "description": "The template application order or priority number.", - "name": "order", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "v" - ], - "description": "The template version.", - "name": "version", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "c" - ], - "description": "The component templates that comprise the index template.", - "name": "composed_of", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "cat/templates/types.ts#L22-L48" + "specLocation": "ccr/stats/CcrStatsResponse.ts#L22-L27" }, { "attachedBehaviors": [ - "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, - "description": "Returns thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.", "inherits": { "type": { - "name": "CatRequestBase", - "namespace": "cat._types" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "cat.thread_pool" + "namespace": "ccr.unfollow" }, "path": [ { - "description": "A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.", - "name": "thread_pool_patterns", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, + "description": "The name of the follower index that should be turned into a regular index.", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "IndexName", "namespace": "_types" } } } ], - "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L48" + "query": [], + "specLocation": "ccr/unfollow/UnfollowIndexRequest.ts#L23-L32" }, { "body": { "kind": "value", "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ThreadPoolRecord", - "namespace": "cat.thread_pool" - } + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } } }, "kind": "response", "name": { "name": "Response", - "namespace": "cat.thread_pool" + "namespace": "ccr.unfollow" }, - "specLocation": "cat/thread_pool/CatThreadPoolResponse.ts#L22-L24" + "specLocation": "ccr/unfollow/UnfollowIndexResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "ThreadPoolRecord", - "namespace": "cat.thread_pool" + "name": "ComponentTemplate", + "namespace": "cluster._types" }, "properties": [ { - "aliases": [ - "nn" - ], - "description": "The node name.", - "name": "node_name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "id" - ], - "description": "The persistent node identifier.", - "name": "node_id", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "NodeId", + "name": "Name", "namespace": "_types" } } }, { - "aliases": [ - "eid" - ], - "description": "The ephemeral node identifier.", - "name": "ephemeral_node_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "p" - ], - "description": "The process identifier.", - "name": "pid", - "required": false, + "name": "component_template", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ComponentTemplateNode", + "namespace": "cluster._types" } } - }, + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L30-L33" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplateNode", + "namespace": "cluster._types" + }, + "properties": [ { - "aliases": [ - "h" - ], - "description": "The host name for the current node.", - "name": "host", - "required": false, + "name": "template", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ComponentTemplateSummary", + "namespace": "cluster._types" } } }, { - "aliases": [ - "i" - ], - "description": "The IP address for the current node.", - "name": "ip", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "po" - ], - "description": "The bound transport port for the current node.", - "name": "port", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Metadata", + "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L35-L40" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplateSummary", + "namespace": "cluster._types" + }, + "properties": [ { - "aliases": [ - "n" - ], - "description": "The thread pool name.", - "name": "name", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Metadata", + "namespace": "_types" } } }, { - "aliases": [ - "t" - ], - "description": "The thread pool type.\nReturned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`.", - "name": "type", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "a" - ], - "description": "The number of active threads in the current thread pool.", - "name": "active", + "name": "settings", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } } } }, { - "aliases": [ - "psz" - ], - "description": "The number of threads in the current thread pool.", - "name": "pool_size", + "name": "mappings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "aliases": [ - "q" - ], - "description": "The number of tasks currently in queue.", - "name": "queue", + "name": "aliases", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AliasDefinition", + "namespace": "indices._types" + } } } }, { - "aliases": [ - "qs" - ], - "description": "The maximum number of tasks permitted in the queue.", - "name": "queue_size", + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "name": "lifecycle", "required": false, + "since": "8.11.0", + "stability": "stable", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DataStreamLifecycleWithRollover", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L42-L54" + }, + { + "kind": "interface", + "name": { + "name": "AllocationDecision", + "namespace": "cluster.allocation_explain" + }, + "properties": [ { - "aliases": [ - "r" - ], - "description": "The number of rejected tasks.", - "name": "rejected", - "required": false, + "name": "decider", + "required": true, "type": { "kind": "instance_of", "type": { @@ -95100,27 +99152,19 @@ } }, { - "aliases": [ - "l" - ], - "description": "The highest number of active threads in the current thread pool.", - "name": "largest", - "required": false, + "name": "decision", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AllocationExplainDecision", + "namespace": "cluster.allocation_explain" } } }, { - "aliases": [ - "c" - ], - "description": "The number of completed tasks.", - "name": "completed", - "required": false, + "name": "explanation", + "required": true, "type": { "kind": "instance_of", "type": { @@ -95128,158 +99172,53 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L26-L30" + }, + { + "kind": "enum", + "members": [ { - "aliases": [ - "cr" - ], - "description": "The core number of active threads allowed in a scaling thread pool.", - "name": "core", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "name": "NO" }, { - "aliases": [ - "mx" - ], - "description": "The maximum number of active threads allowed in a scaling thread pool.", - "name": "max", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "name": "YES" }, { - "aliases": [ - "sz" - ], - "description": "The number of active threads allowed in a fixed thread pool.", - "name": "size", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "name": "THROTTLE" }, { - "aliases": [ - "ka" - ], - "description": "The thread keep alive time.", - "name": "keep_alive", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "name": "ALWAYS" } ], - "specLocation": "cat/thread_pool/types.ts#L22-L124" + "name": { + "name": "AllocationExplainDecision", + "namespace": "cluster.allocation_explain" + }, + "specLocation": "cluster/allocation_explain/types.ts#L32-L37" }, { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns configuration and usage information about transforms.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cat.transforms" + "name": "AllocationStore", + "namespace": "cluster.allocation_explain" }, - "path": [ + "properties": [ { - "description": "A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.", - "name": "transform_id", - "required": false, + "name": "allocation_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "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.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, + "name": "found", + "required": true, "type": { "kind": "instance_of", "type": { @@ -95289,103 +99228,174 @@ } }, { - "description": "Skips the specified number of transforms.", - "name": "from", - "required": false, - "serverDefault": 0, + "name": "in_sync", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Comma-separated list of column names to display.", - "name": "h", - "required": false, - "serverDefault": "changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state", + "name": "matching_size_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CatTransformColumns", - "namespace": "cat._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "Comma-separated list of column names or column aliases used to sort the response.", - "name": "s", - "required": false, + "name": "matching_sync_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CatTransformColumns", - "namespace": "cat._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The unit used to display time values.", - "name": "time", - "required": false, + "name": "store_exception", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L39-L46" + }, + { + "kind": "interface", + "name": { + "name": "ClusterInfo", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "nodes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "NodeDiskUsage", + "namespace": "cluster.allocation_explain" + } } } }, { - "description": "The maximum number of transforms to obtain.", - "name": "size", + "name": "shard_sizes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + }, + { + "name": "shard_data_set_sizes", "required": false, - "serverDefault": 100, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ], - "specLocation": "cat/transforms/CatTransformsRequest.ts#L25-L77" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TransformsRecord", - "namespace": "cat.transforms" + }, + { + "name": "shard_paths", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "reserved_sizes", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ReservedSize", + "namespace": "cluster.allocation_explain" + } } } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.transforms" - }, - "specLocation": "cat/transforms/CatTransformsResponse.ts#L22-L24" + ], + "specLocation": "cluster/allocation_explain/types.ts#L48-L54" }, { "kind": "interface", "name": { - "name": "TransformsRecord", - "namespace": "cat.transforms" + "name": "CurrentNode", + "namespace": "cluster.allocation_explain" }, "properties": [ { - "description": "The transform identifier.", "name": "id", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -95395,142 +99405,107 @@ } }, { - "aliases": [ - "s" - ], - "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.", - "name": "state", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "aliases": [ - "c" - ], - "description": "The sequence number for the checkpoint.", - "name": "checkpoint", - "required": false, + "name": "attributes", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "aliases": [ - "docp", - "documentsProcessed" - ], - "description": "The number of documents that have been processed from the source index of the transform.", - "name": "documents_processed", - "required": false, + "name": "transport_address", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TransportAddress", + "namespace": "_types" } } }, { - "aliases": [ - "cp", - "checkpointProgress" - ], - "description": "The progress of the next checkpoint that is currently in progress.", - "name": "checkpoint_progress", - "required": false, + "name": "weight_ranking", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L78-L84" + }, + { + "kind": "enum", + "members": [ + { + "name": "yes" }, { - "aliases": [ - "lst", - "lastSearchTime" - ], - "description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.", - "name": "last_search_time", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "name": "no" }, { - "aliases": [ - "cldt" - ], - "description": "The timestamp when changes were last detected in the source indices.", - "name": "changes_last_detection_time", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "name": "worse_balance" }, { - "aliases": [ - "ct", - "createTime" - ], - "description": "The time the transform was created.", - "name": "create_time", - "required": false, + "name": "throttled" + }, + { + "name": "awaiting_info" + }, + { + "name": "allocation_delayed" + }, + { + "name": "no_valid_shard_copy" + }, + { + "name": "no_attempt" + } + ], + "name": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + }, + "specLocation": "cluster/allocation_explain/types.ts#L86-L95" + }, + { + "kind": "interface", + "name": { + "name": "DiskUsage", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "path", + "required": true, "type": { "kind": "instance_of", "type": { @@ -95540,269 +99515,339 @@ } }, { - "aliases": [ - "v" - ], - "description": "The version of Elasticsearch that existed on the node when the transform was created.", - "name": "version", - "required": false, + "name": "total_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "long", "namespace": "_types" } } }, { - "aliases": [ - "si", - "sourceIndex" - ], - "description": "The source indices for the transform.", - "name": "source_index", - "required": false, + "name": "used_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "di", - "destIndex" - ], - "description": "The destination index for the transform.", - "name": "dest_index", - "required": false, + "name": "free_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "p" - ], - "description": "The unique identifier for the ingest pipeline.", - "name": "pipeline", - "required": false, + "name": "free_disk_percent", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "aliases": [ - "d" - ], - "description": "The description of the transform.", - "name": "description", - "required": false, + "name": "used_disk_percent", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L62-L69" + }, + { + "kind": "interface", + "name": { + "name": "NodeAllocationExplanation", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "deciders", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AllocationDecision", + "namespace": "cluster.allocation_explain" + } } } }, { - "aliases": [ - "tt" - ], - "description": "The type of transform: `batch` or `continuous`.", - "name": "transform_type", - "required": false, + "name": "node_attributes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "node_decision", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Decision", + "namespace": "cluster.allocation_explain" } } }, { - "aliases": [ - "f" - ], - "description": "The interval between checks for changes in the source indices when the transform is running continuously.", - "name": "frequency", - "required": false, + "name": "node_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "aliases": [ - "mpsz" - ], - "description": "The initial page size that is used for the composite aggregation for each checkpoint.", - "name": "max_page_search_size", - "required": false, + "name": "node_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "aliases": [ - "dps" - ], - "description": "The number of input documents per second.", - "name": "docs_per_second", + "name": "store", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AllocationStore", + "namespace": "cluster.allocation_explain" } } }, { - "aliases": [ - "r" - ], - "description": "If a transform has a `failed` state, these details describe the reason for failure.", - "name": "reason", - "required": false, + "name": "transport_address", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TransportAddress", + "namespace": "_types" } } }, { - "aliases": [ - "st" - ], - "description": "The total number of search operations on the source index for the transform.", - "name": "search_total", - "required": false, + "name": "weight_ranking", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L97-L106" + }, + { + "kind": "interface", + "name": { + "name": "NodeDiskUsage", + "namespace": "cluster.allocation_explain" + }, + "properties": [ { - "aliases": [ - "sf" - ], - "description": "The total number of search failures.", - "name": "search_failure", - "required": false, + "name": "node_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "aliases": [ - "stime" - ], - "description": "The total amount of search time, in milliseconds.", - "name": "search_time", - "required": false, + "name": "least_available", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DiskUsage", + "namespace": "cluster.allocation_explain" } } }, { - "aliases": [ - "it" - ], - "description": "The total number of index operations done by the transform.", - "name": "index_total", - "required": false, + "name": "most_available", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DiskUsage", + "namespace": "cluster.allocation_explain" } } - }, + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L56-L60" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.", + "name": "current_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Specifies the name of the index that you would like an explanation for.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "description": "If true, returns explanation for the primary shard for the given shard ID.", + "name": "primary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specifies the ID of the shard that you would like an explanation for.", + "name": "shard", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ] + }, + "description": "Provides explanations for shard allocations in the cluster.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.allocation_explain" + }, + "path": [], + "query": [ { - "aliases": [ - "if" - ], - "description": "The total number of indexing failures.", - "name": "index_failure", + "description": "If true, returns information about disk usage and shard sizes.", + "name": "include_disk_info", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "itime" - ], - "description": "The total time spent indexing documents, in milliseconds.", - "name": "index_time", + "description": "If true, returns YES decisions in explanation.", + "name": "include_yes_decisions", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L24-L61" + }, + { + "kind": "interface", + "name": { + "name": "ReservedSize", + "namespace": "cluster.allocation_explain" + }, + "properties": [ { - "aliases": [ - "doci" - ], - "description": "The number of documents that have been indexed into the destination index for the transform.", - "name": "documents_indexed", - "required": false, + "name": "node_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "aliases": [ - "dtime" - ], - "description": "The total time spent deleting documents, in milliseconds.", - "name": "delete_time", - "required": false, + "name": "path", + "required": true, "type": { "kind": "instance_of", "type": { @@ -95812,102 +99857,384 @@ } }, { - "aliases": [ - "docd" - ], - "description": "The number of documents deleted from the destination index due to the retention policy for the transform.", - "name": "documents_deleted", - "required": false, + "name": "total", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "tc" - ], - "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.", - "name": "trigger_count", - "required": false, + "name": "shards", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, - { - "aliases": [ - "pp" - ], - "description": "The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually.", - "name": "pages_processed", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L71-L76" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "allocate_explanation", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "aliases": [ - "pt" - ], - "description": "The total time spent processing results, in milliseconds.", - "name": "processing_time", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "allocation_delay", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } } - } - }, - { - "aliases": [ - "cdtea", - "checkpointTimeExpAvg" - ], - "description": "The exponential moving average of the duration of the checkpoint, in milliseconds.", - "name": "checkpoint_duration_time_exp_avg", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "allocation_delay_in_millis", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" + } + } + }, + { + "name": "can_allocate", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "can_move_to_other_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "can_rebalance_cluster", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "can_rebalance_cluster_decisions", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AllocationDecision", + "namespace": "cluster.allocation_explain" + } + } + } + }, + { + "name": "can_rebalance_to_other_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "can_remain_decisions", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AllocationDecision", + "namespace": "cluster.allocation_explain" + } + } + } + }, + { + "name": "can_remain_on_current_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "cluster_info", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterInfo", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "configured_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "configured_delay_in_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" + } + } + }, + { + "name": "current_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CurrentNode", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "current_state", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "move_explanation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "node_allocation_decisions", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "NodeAllocationExplanation", + "namespace": "cluster.allocation_explain" + } + } + } + }, + { + "name": "primary", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "rebalance_explanation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "remaining_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "remaining_delay_in_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" + } + } + }, + { + "name": "shard", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "unassigned_info", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "UnassignedInformation", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.14.0" + } + }, + "name": "note", + "required": false, + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.allocation_explain" + }, + "specLocation": "cluster/allocation_explain/ClusterAllocationExplainResponse.ts#L32-L64" + }, + { + "kind": "interface", + "name": { + "name": "UnassignedInformation", + "namespace": "cluster.allocation_explain" + }, + "properties": [ { - "aliases": [ - "idea" - ], - "description": "The exponential moving average of the number of new documents that have been indexed.", - "name": "indexed_documents_exp_avg", - "required": false, + "name": "at", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "aliases": [ - "pdea" - ], - "description": "The exponential moving average of the number of documents that have been processed.", - "name": "processed_documents_exp_avg", + "name": "last_allocation_status", "required": false, "type": { "kind": "instance_of", @@ -95916,273 +100243,603 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/transforms/types.ts#L22-L197" - }, - { - "kind": "interface", - "name": { - "name": "FollowIndexStats", - "namespace": "ccr._types" - }, - "properties": [ + }, { - "name": "index", + "name": "reason", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "UnassignedInformationReason", + "namespace": "cluster.allocation_explain" } } }, { - "name": "shards", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardStats", - "namespace": "ccr._types" - } - } - } - } - ], - "specLocation": "ccr/_types/FollowIndexStats.ts#L30-L33" - }, - { - "kind": "interface", - "name": { - "name": "ReadException", - "namespace": "ccr._types" - }, - "properties": [ + "name": "details", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { - "name": "exception", - "required": true, + "name": "failed_allocation_attempts", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", + "name": "integer", "namespace": "_types" } } }, { - "name": "from_seq_no", - "required": true, + "name": "delayed", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "retries", - "required": true, + "name": "allocation_status", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "ccr/_types/FollowIndexStats.ts#L71-L75" + "specLocation": "cluster/allocation_explain/types.ts#L117-L125" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "INDEX_CREATED" + }, + { + "name": "CLUSTER_RECOVERED" + }, + { + "name": "INDEX_REOPENED" + }, + { + "name": "DANGLING_INDEX_IMPORTED" + }, + { + "name": "NEW_INDEX_RESTORED" + }, + { + "name": "EXISTING_INDEX_RESTORED" + }, + { + "name": "REPLICA_ADDED" + }, + { + "name": "ALLOCATION_FAILED" + }, + { + "name": "NODE_LEFT" + }, + { + "name": "REROUTE_CANCELLED" + }, + { + "name": "REINITIALIZED" + }, + { + "name": "REALLOCATED_REPLICA" + }, + { + "name": "PRIMARY_FAILED" + }, + { + "name": "FORCED_EMPTY_PRIMARY" + }, + { + "name": "MANUAL_ALLOCATION" + } + ], "name": { - "name": "ShardStats", - "namespace": "ccr._types" + "name": "UnassignedInformationReason", + "namespace": "cluster.allocation_explain" }, - "properties": [ + "specLocation": "cluster/allocation_explain/types.ts#L127-L146" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.delete_component_template" + }, + "path": [ { - "name": "bytes_read", + "description": "Comma-separated list or wildcard expression of component template names used to limit the request.", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Names", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "failed_read_requests", - "required": true, + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } }, { - "name": "failed_write_requests", - "required": true, + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L54" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.delete_component_template" + }, + "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Clears cluster voting config exclusions.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.delete_voting_config_exclusions" + }, + "path": [], + "query": [ { - "name": "fatal_exception", + "description": "Specifies whether to wait for all excluded nodes to be removed from the\ncluster before clearing the voting configuration exclusions list.\nDefaults to true, meaning that all excluded nodes must be removed from\nthe cluster before this API takes any action. If set to false then the\nvoting configuration exclusions list is cleared even if some excluded\nnodes are still in the cluster.", + "name": "wait_for_removal", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts#L22-L40" + }, + { + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.delete_voting_config_exclusions" + }, + "specLocation": "cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about whether a particular component template exist", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.exists_component_template" + }, + "path": [ { - "name": "follower_aliases_version", + "description": "Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Names", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "follower_global_checkpoint", - "required": true, + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } }, { - "name": "follower_index", - "required": true, + "description": "If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.", + "name": "local", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L53" + }, + { + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.exists_component_template" + }, + "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves information about component templates.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.get_component_template" + }, + "path": [ { - "name": "follower_mapping_version", - "required": true, + "description": "Comma-separated list of component template names used to limit the request.\nWildcard (`*`) expressions are supported.", + "name": "name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Name", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "follower_max_seq_no", - "required": true, + "description": "If `true`, returns settings in flat format.", + "name": "flat_settings", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "follower_settings_version", - "required": true, + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "description": "Return all default configurations for the component template (default: false)", + "name": "include_defaults", + "required": false, + "serverDefault": false, + "since": "8.11.0", + "stability": "stable", "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "last_requested_seq_no", - "required": true, + "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", + "name": "local", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "leader_global_checkpoint", - "required": true, + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L65" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "component_templates", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ComponentTemplate", + "namespace": "cluster._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.get_component_template" + }, + "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns cluster-wide settings.\nBy default, it returns only settings that have been explicitly defined.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.get_settings" + }, + "path": [], + "query": [ { - "name": "leader_index", - "required": true, + "description": "If `true`, returns settings in flat format.", + "name": "flat_settings", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "leader_max_seq_no", - "required": true, + "description": "If `true`, returns default cluster settings from the local node.", + "name": "include_defaults", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "operations_read", - "required": true, + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } }, { - "name": "operations_written", - "required": true, + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/get_settings/ClusterGetSettingsRequest.ts#L23-L57" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "persistent", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "transient", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "defaults", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.get_settings" + }, + "specLocation": "cluster/get_settings/ClusterGetSettingsResponse.ts#L23-L29" + }, + { + "kind": "interface", + "name": { + "name": "HealthResponseBody", + "namespace": "cluster.health" + }, + "properties": [ { - "name": "outstanding_read_requests", + "description": "The number of active primary shards.", + "name": "active_primary_shards", "required": true, "type": { "kind": "instance_of", @@ -96193,7 +100850,8 @@ } }, { - "name": "outstanding_write_requests", + "description": "The total number of active primary and replica shards.", + "name": "active_shards", "required": true, "type": { "kind": "instance_of", @@ -96204,32 +100862,32 @@ } }, { - "name": "read_exceptions", + "description": "The ratio of active shards in the cluster expressed as a percentage.", + "name": "active_shards_percent_as_number", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ReadException", - "namespace": "ccr._types" - } + "kind": "instance_of", + "type": { + "name": "Percentage", + "namespace": "_types" } } }, { - "name": "remote_cluster", + "description": "The name of the cluster.", + "name": "cluster_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "name": "shard_id", + "description": "The number of shards whose allocation has been delayed by the timeout settings.", + "name": "delayed_unassigned_shards", "required": true, "type": { "kind": "instance_of", @@ -96240,122 +100898,113 @@ } }, { - "name": "successful_read_requests", - "required": true, + "name": "indices", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndexHealthStats", + "namespace": "cluster.health" + } } } }, { - "name": "successful_write_requests", + "description": "The number of shards that are under initialization.", + "name": "initializing_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "time_since_last_read", - "required": false, + "description": "The number of nodes that are dedicated data nodes.", + "name": "number_of_data_nodes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "name": "time_since_last_read_millis", + "description": "The number of unfinished fetches.", + "name": "number_of_in_flight_fetch", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "integer", "namespace": "_types" } } }, { - "name": "total_read_remote_exec_time", - "required": false, + "description": "The number of nodes within the cluster.", + "name": "number_of_nodes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "name": "total_read_remote_exec_time_millis", + "description": "The number of cluster-level changes that have not yet been executed.", + "name": "number_of_pending_tasks", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "integer", "namespace": "_types" } } }, { - "name": "total_read_time", - "required": false, + "description": "The number of shards that are under relocation.", + "name": "relocating_shards", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "name": "total_read_time_millis", + "name": "status", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "HealthStatus", "namespace": "_types" } } }, { - "name": "total_write_time", + "description": "The time since the earliest initiated task is waiting for being performed.", + "name": "task_max_waiting_in_queue", "required": false, "type": { "kind": "instance_of", @@ -96366,7 +101015,8 @@ } }, { - "name": "total_write_time_millis", + "description": "The time expressed in milliseconds since the earliest initiated task is waiting for being performed.", + "name": "task_max_waiting_in_queue_millis", "required": true, "type": { "generics": [ @@ -96386,409 +101036,41 @@ } }, { - "name": "write_buffer_operation_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "write_buffer_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/_types/FollowIndexStats.ts#L35-L69" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Deletes auto-follow patterns.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ccr.delete_auto_follow_pattern" - }, - "path": [ - { - "description": "The name of the auto follow pattern.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts#L23-L32" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.delete_auto_follow_pattern" - }, - "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "leader_index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "max_outstanding_read_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_outstanding_write_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_read_request_operation_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_read_request_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "max_retry_delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "max_write_buffer_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_write_buffer_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "max_write_request_operation_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_write_request_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "read_poll_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "remote_cluster", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "description": "Creates a new follower index configured to follow the referenced leader index.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ccr.follow" - }, - "path": [ - { - "description": "The name of the follower index", - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", - "name": "wait_for_active_shards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "WaitForActiveShards", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L25-L51" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "follow_index_created", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "follow_index_shards_acked", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "index_following_started", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.follow" - }, - "specLocation": "ccr/follow/CreateFollowIndexResponse.ts#L20-L26" - }, - { - "kind": "interface", - "name": { - "name": "FollowerIndex", - "namespace": "ccr.follow_info" - }, - "properties": [ - { - "name": "follower_index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "leader_index", + "description": "If false the response returned within the period of time that is specified by the timeout parameter (30s by default)", + "name": "timed_out", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "parameters", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FollowerIndexParameters", - "namespace": "ccr.follow_info" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "remote_cluster", + "description": "The number of shards that are not allocated.", + "name": "unassigned_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } - }, - { - "name": "status", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "FollowerIndexStatus", - "namespace": "ccr.follow_info" - } - } } ], - "specLocation": "ccr/follow_info/types.ts#L22-L28" + "specLocation": "cluster/health/ClusterHealthResponse.ts#L39-L72" }, { "kind": "interface", "name": { - "name": "FollowerIndexParameters", - "namespace": "ccr.follow_info" + "name": "IndexHealthStats", + "namespace": "cluster.health" }, - "properties": [ - { - "name": "max_outstanding_read_requests", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "max_outstanding_write_requests", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, + "properties": [ { - "name": "max_read_request_operation_count", + "name": "active_primary_shards", "required": true, "type": { "kind": "instance_of", @@ -96799,29 +101081,29 @@ } }, { - "name": "max_read_request_size", + "name": "active_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "max_retry_delay", + "name": "initializing_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "name": "max_write_buffer_count", + "name": "number_of_replicas", "required": true, "type": { "kind": "instance_of", @@ -96832,18 +101114,18 @@ } }, { - "name": "max_write_buffer_size", + "name": "number_of_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "max_write_request_operation_count", + "name": "relocating_shards", "required": true, "type": { "kind": "instance_of", @@ -96854,108 +101136,51 @@ } }, { - "name": "max_write_request_size", - "required": true, + "name": "shards", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ShardHealthStats", + "namespace": "cluster.health" + } } } }, { - "name": "read_poll_timeout", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "HealthStatus", "namespace": "_types" } } - } - ], - "specLocation": "ccr/follow_info/types.ts#L38-L49" - }, - { - "kind": "enum", - "members": [ - { - "name": "active" }, { - "name": "paused" - } - ], - "name": { - "name": "FollowerIndexStatus", - "namespace": "ccr.follow_info" - }, - "specLocation": "ccr/follow_info/types.ts#L30-L33" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Retrieves information about all follower indices, including parameters and status for each follower index", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ccr.follow_info" - }, - "path": [ - { - "description": "A comma-separated list of index patterns; use `_all` to perform the operation on all indices", - "name": "index", + "name": "unassigned_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "integer", "namespace": "_types" } } } ], - "query": [], - "specLocation": "ccr/follow_info/FollowInfoRequest.ts#L23-L32" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "follower_indices", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FollowerIndex", - "namespace": "ccr.follow_info" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.follow_info" - }, - "specLocation": "ccr/follow_info/FollowInfoResponse.ts#L22-L24" + "specLocation": "cluster/health/types.ts#L24-L34" }, { "attachedBehaviors": [ @@ -96964,7 +101189,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.", + "description": "The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.\nThe cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.", "inherits": { "type": { "name": "RequestBase", @@ -96974,13 +101199,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ccr.follow_stats" + "namespace": "cluster.health" }, "path": [ { - "description": "A comma-separated list of index patterns; use `_all` to perform the operation on all indices", + "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -96990,184 +101215,37 @@ } } ], - "query": [], - "specLocation": "ccr/follow_stats/FollowIndexStatsRequest.ts#L23-L32" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "indices", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FollowIndexStats", - "namespace": "ccr._types" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.follow_stats" - }, - "specLocation": "ccr/follow_stats/FollowIndexStatsResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "follower_cluster", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "follower_index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "follower_index_uuid", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Uuid", - "namespace": "_types" - } - } - }, - { - "name": "leader_remote_cluster", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "description": "Removes the follower retention leases from the leader.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ccr.forget_follower" - }, - "path": [ + "query": [ { - "description": "the name of the leader index for which specified follower retention leases should be removed", - "name": "index", - "required": true, + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "ExpandWildcards", "namespace": "_types" } } - } - ], - "query": [], - "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L38" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardStatistics", - "namespace": "_types" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.forget_follower" - }, - "specLocation": "ccr/forget_follower/ForgetFollowerIndexResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "AutoFollowPattern", - "namespace": "ccr.get_auto_follow_pattern" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "description": "Can be one of cluster, indices or shards. Controls the details level of the health information returned.", + "name": "level", + "required": false, + "serverDefault": "cluster", "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Level", "namespace": "_types" } } }, { - "name": "pattern", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AutoFollowPatternSummary", - "namespace": "ccr.get_auto_follow_pattern" - } - } - } - ], - "specLocation": "ccr/get_auto_follow_pattern/types.ts#L23-L26" - }, - { - "kind": "interface", - "name": { - "name": "AutoFollowPatternSummary", - "namespace": "ccr.get_auto_follow_pattern" - }, - "properties": [ - { - "name": "active", - "required": true, + "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "name": "local", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -97177,227 +101255,120 @@ } }, { - "description": "The remote cluster containing the leader indices to match against.", - "name": "remote_cluster", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The name of follower index.", - "name": "follow_index_pattern", + "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.", + "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "IndexPattern", + "name": "Duration", "namespace": "_types" } } }, { - "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", - "name": "leader_index_patterns", - "required": true, + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "IndexPatterns", + "name": "Duration", "namespace": "_types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.14.0" - } - }, - "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed.", - "name": "leader_index_exclusion_patterns", - "required": true, - "since": "7.14.0", + "description": "A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.", + "name": "wait_for_active_shards", + "required": false, + "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "IndexPatterns", + "name": "WaitForActiveShards", "namespace": "_types" } } }, { - "description": "The maximum number of outstanding reads requests from the remote cluster.", - "name": "max_outstanding_read_requests", - "required": true, + "description": "Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.", + "name": "wait_for_events", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "WaitForEvents", "namespace": "_types" } } - } - ], - "specLocation": "ccr/get_auto_follow_pattern/types.ts#L28-L52" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ccr.get_auto_follow_pattern" - }, - "path": [ + }, { - "description": "Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections.", - "name": "name", + "description": "The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status.", + "name": "wait_for_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "HealthStatus", "namespace": "_types" } } } ], - "query": [], - "specLocation": "ccr/pause_follow/PauseFollowIndexRequest.ts#L23-L32" + "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L98" }, { "body": { @@ -97405,272 +101376,110 @@ "value": { "kind": "instance_of", "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "HealthResponseBody", + "namespace": "cluster.health" } } }, + "exceptions": [ + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "HealthResponseBody", + "namespace": "cluster.health" + } + } + }, + "statusCodes": [ + 408 + ] + } + ], "kind": "response", "name": { "name": "Response", - "namespace": "ccr.pause_follow" + "namespace": "cluster.health" }, - "specLocation": "ccr/pause_follow/PauseFollowIndexResponse.ts#L22-L24" + "specLocation": "cluster/health/ClusterHealthResponse.ts#L26-L37" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The remote cluster containing the leader indices to match against.", - "docId": "modules-remote-clusters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-remote-clusters.html", - "name": "remote_cluster", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.", - "name": "follow_index_pattern", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexPattern", - "namespace": "_types" - } - } - }, - { - "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", - "name": "leader_index_patterns", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexPatterns", - "namespace": "_types" - } - } - }, - { - "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.", - "name": "leader_index_exclusion_patterns", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexPatterns", - "namespace": "_types" - } - } - }, - { - "description": "The maximum number of outstanding reads requests from the remote cluster.", - "name": "max_outstanding_read_requests", - "required": false, - "serverDefault": 12, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", - "name": "settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "description": "The maximum number of outstanding reads requests from the remote cluster.", - "name": "max_outstanding_write_requests", - "required": false, - "serverDefault": 9, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.", - "name": "read_poll_timeout", - "required": false, - "serverDefault": "1m", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The maximum number of operations to pull per read from the remote cluster.", - "name": "max_read_request_operation_count", - "required": false, - "serverDefault": 5120, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", - "name": "max_read_request_size", - "required": false, - "serverDefault": "32mb", - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", - "name": "max_retry_delay", - "required": false, - "serverDefault": "500ms", + "kind": "interface", + "name": { + "name": "ShardHealthStats", + "namespace": "cluster.health" + }, + "properties": [ + { + "name": "active_shards", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.", - "name": "max_write_buffer_count", - "required": false, - "serverDefault": 2147483647, + } + }, + { + "name": "initializing_shards", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.", - "name": "max_write_buffer_size", - "required": false, - "serverDefault": "512mb", + } + }, + { + "name": "primary_active", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "description": "The maximum number of operations per bulk write request executed on the follower.", - "name": "max_write_request_operation_count", - "required": false, - "serverDefault": 5120, + } + }, + { + "name": "relocating_shards", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "description": "The maximum total bytes of operations per bulk write request executed on the follower.", - "name": "max_write_request_size", - "required": false, - "serverDefault": "9223372036854775807b", + } + }, + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } + "name": "HealthStatus", + "namespace": "_types" } } - ] - }, - "description": "Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ccr.put_auto_follow_pattern" - }, - "path": [ + }, { - "description": "The name of the collection of auto-follow patterns.", - "name": "name", + "name": "unassigned_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } } ], - "query": [], - "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts#L27-L112" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.put_auto_follow_pattern" - }, - "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternResponse.ts#L22-L24" + "specLocation": "cluster/health/types.ts#L36-L43" }, { "attachedBehaviors": [ @@ -97679,7 +101488,7 @@ "body": { "kind": "no_body" }, - "description": "Resumes an auto-follow pattern that has been paused", + "description": "Returns different information about the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -97689,311 +101498,174 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ccr.resume_auto_follow_pattern" + "namespace": "cluster.info" }, "path": [ { - "description": "The name of the auto follow pattern to resume discovering new indices to follow.", - "name": "name", + "description": "Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.", + "name": "target", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "ClusterInfoTargets", "namespace": "_types" } } } ], "query": [], - "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts#L23-L32" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.resume_auto_follow_pattern" - }, - "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternResponse.ts#L22-L24" + "specLocation": "cluster/info/ClusterInfoRequest.ts#L23-L34" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "max_outstanding_read_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_outstanding_write_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_read_request_operation_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_read_request_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "max_retry_delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "max_write_buffer_count", - "required": false, + "name": "cluster_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Name", "namespace": "_types" } } }, { - "name": "max_write_buffer_size", + "name": "http", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Http", + "namespace": "nodes._types" } } }, { - "name": "max_write_request_operation_count", + "name": "ingest", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Ingest", + "namespace": "nodes._types" } } }, { - "name": "max_write_request_size", + "name": "thread_pool", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ThreadCount", + "namespace": "nodes._types" + } } } }, { - "name": "read_poll_timeout", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "Scripting", + "namespace": "nodes._types" } } } ] }, - "description": "Resumes a follower index that has been paused", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ccr.resume_follow" - }, - "path": [ - { - "description": "The name of the follow index to resume following.", - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L46" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "ccr.resume_follow" + "namespace": "cluster.info" }, - "specLocation": "ccr/resume_follow/ResumeFollowIndexResponse.ts#L22-L24" + "specLocation": "cluster/info/ClusterInfoResponse.ts#L26-L34" }, { "kind": "interface", "name": { - "name": "AutoFollowStats", - "namespace": "ccr.stats" + "name": "PendingTask", + "namespace": "cluster.pending_tasks" }, "properties": [ { - "name": "auto_followed_clusters", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AutoFollowedCluster", - "namespace": "ccr.stats" - } - } - } - }, - { - "name": "number_of_failed_follow_indices", + "description": "Indicates whether the pending tasks are currently executing or not.", + "name": "executing", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "number_of_failed_remote_cluster_state_requests", + "description": "The number that represents when the task has been inserted into the task queue.", + "name": "insert_order", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "number_of_successful_follow_indices", + "description": "The priority of the pending task.\nThe valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`.", + "name": "priority", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "recent_auto_follow_errors", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ErrorCause", - "namespace": "_types" - } - } - } - } - ], - "specLocation": "ccr/stats/types.ts.ts#L33-L39" - }, - { - "kind": "interface", - "name": { - "name": "AutoFollowedCluster", - "namespace": "ccr.stats" - }, - "properties": [ - { - "name": "cluster_name", + "description": "A general description of the cluster task that may include a reason and origin.", + "name": "source", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "last_seen_metadata_version", - "required": true, + "description": "The time since the task is waiting for being performed.", + "name": "time_in_queue", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Duration", "namespace": "_types" } } }, { - "name": "time_since_last_check_millis", + "description": "The time expressed in milliseconds since the task is waiting for being performed.", + "name": "time_in_queue_millis", "required": true, "type": { "generics": [ @@ -98013,31 +101685,7 @@ } } ], - "specLocation": "ccr/stats/types.ts.ts#L27-L31" - }, - { - "kind": "interface", - "name": { - "name": "FollowStats", - "namespace": "ccr.stats" - }, - "properties": [ - { - "name": "indices", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FollowIndexStats", - "namespace": "ccr._types" - } - } - } - } - ], - "specLocation": "ccr/stats/types.ts.ts#L41-L43" + "specLocation": "cluster/pending_tasks/types.ts#L23-L47" }, { "attachedBehaviors": [ @@ -98046,7 +101694,7 @@ "body": { "kind": "no_body" }, - "description": "Gets all stats related to cross-cluster replication.", + "description": "Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.\nNOTE: This API returns a list of any pending updates to the cluster state.\nThese are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.\nHowever, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.", "inherits": { "type": { "name": "RequestBase", @@ -98056,35 +101704,54 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ccr.stats" + "namespace": "cluster.pending_tasks" }, "path": [], - "query": [], - "specLocation": "ccr/stats/CcrStatsRequest.ts#L22-L27" + "query": [ + { + "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", + "name": "local", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/pending_tasks/ClusterPendingTasksRequest.ts#L23-L48" }, { "body": { "kind": "properties", "properties": [ { - "name": "auto_follow_stats", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AutoFollowStats", - "namespace": "ccr.stats" - } - } - }, - { - "name": "follow_stats", + "name": "tasks", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "FollowStats", - "namespace": "ccr.stats" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PendingTask", + "namespace": "cluster.pending_tasks" + } } } } @@ -98093,9 +101760,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ccr.stats" + "namespace": "cluster.pending_tasks" }, - "specLocation": "ccr/stats/CcrStatsResponse.ts#L22-L27" + "specLocation": "cluster/pending_tasks/ClusterPendingTasksResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -98104,7 +101771,7 @@ "body": { "kind": "no_body" }, - "description": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.", + "description": "Updates the cluster voting config exclusions by node ids or node names.", "inherits": { "type": { "name": "RequestBase", @@ -98114,51 +101781,133 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ccr.unfollow" + "namespace": "cluster.post_voting_config_exclusions" }, - "path": [ + "path": [], + "query": [ { - "description": "The name of the follower index that should be turned into a regular index.", - "name": "index", - "required": true, + "description": "A comma-separated list of the names of the nodes to exclude from the\nvoting configuration. If specified, you may not also specify node_ids.", + "name": "node_names", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Names", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of the persistent ids of the nodes to exclude\nfrom the voting configuration. If specified, you may not also specify node_names.", + "name": "node_ids", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" + } + } + }, + { + "description": "When adding a voting configuration exclusion, the API waits for the\nspecified nodes to be excluded from the voting configuration before\nreturning. If the timeout expires before the appropriate condition\nis satisfied, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", "namespace": "_types" } } } ], - "query": [], - "specLocation": "ccr/unfollow/UnfollowIndexRequest.ts#L23-L32" + "specLocation": "cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts#L24-L50" }, { "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } + "kind": "no_body" }, "kind": "response", "name": { "name": "Response", - "namespace": "ccr.unfollow" + "namespace": "cluster.post_voting_config_exclusions" }, - "specLocation": "ccr/unfollow/UnfollowIndexResponse.ts#L22-L24" + "specLocation": "cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts#L22-L24" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "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\ntemplate even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false` then data streams matching the template must always be explicitly created.", + "name": "allow_auto_create", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The template to be applied which includes mappings, settings, or aliases configuration.", + "name": "template", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexState", + "namespace": "indices._types" + } + } + }, + { + "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.", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "description": "Optional user metadata about the component template.\nMay 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.", + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } + } + ] + }, + "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ComponentTemplate", - "namespace": "cluster._types" + "name": "Request", + "namespace": "cluster.put_component_template" }, - "properties": [ + "path": [ { + "description": "Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.", "name": "name", "required": true, "type": { @@ -98168,186 +101917,308 @@ "namespace": "_types" } } + } + ], + "query": [ + { + "description": "If `true`, this request cannot replace or update existing component templates.", + "name": "create", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "component_template", - "required": true, + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" + "name": "Duration", + "namespace": "_types" } } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L30-L33" + "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L29-L99" }, { - "kind": "interface", + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", "name": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" + "name": "Response", + "namespace": "cluster.put_component_template" }, - "properties": [ + "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "persistent", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "transient", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "description": "Updates the cluster settings.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.put_settings" + }, + "path": [], + "query": [ { - "name": "template", - "required": true, + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ComponentTemplateSummary", - "namespace": "cluster._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "version", + "description": "Explicit operation timeout for connection to master node", + "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Duration", "namespace": "_types" } } }, { - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", - "name": "_meta", + "description": "Explicit operation timeout", + "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Metadata", + "name": "Duration", "namespace": "_types" } } - } - ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L35-L40" + } + ], + "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "acknowledged", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "persistent", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "transient", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.put_settings" + }, + "specLocation": "cluster/put_settings/ClusterPutSettingsResponse.ts#L23-L29" + }, + { + "kind": "type_alias", + "name": { + "name": "ClusterRemoteInfo", + "namespace": "cluster.remote_info" + }, + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L29-L30", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ClusterRemoteSniffInfo", + "namespace": "cluster.remote_info" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ClusterRemoteProxyInfo", + "namespace": "cluster.remote_info" + } + } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "mode" + } }, { "kind": "interface", "name": { - "name": "ComponentTemplateSummary", - "namespace": "cluster._types" + "name": "ClusterRemoteProxyInfo", + "namespace": "cluster.remote_info" }, "properties": [ { - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", - "name": "_meta", - "required": false, + "name": "mode", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } + "kind": "literal_value", + "value": "proxy" } }, { - "name": "version", - "required": false, + "name": "connected", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "name": "settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "mappings", - "required": false, + "name": "initial_connect_timeout", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "aliases", - "required": false, + "name": "skip_unavailable", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AliasDefinition", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "availability": { - "serverless": { - "stability": "stable" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" - } - }, - "name": "lifecycle", - "required": false, - "since": "8.11.0", - "stability": "stable", + "name": "proxy_address", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleWithRollover", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L42-L54" - }, - { - "kind": "interface", - "name": { - "name": "AllocationDecision", - "namespace": "cluster.allocation_explain" - }, - "properties": [ + }, { - "name": "decider", + "name": "server_name", "required": true, "type": { "kind": "instance_of", @@ -98358,72 +102229,47 @@ } }, { - "name": "decision", + "name": "num_proxy_sockets_connected", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AllocationExplainDecision", - "namespace": "cluster.allocation_explain" + "name": "integer", + "namespace": "_types" } } }, { - "name": "explanation", + "name": "max_proxy_socket_connections", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "cluster/allocation_explain/types.ts#L26-L30" - }, - { - "kind": "enum", - "members": [ - { - "name": "NO" - }, - { - "name": "YES" - }, - { - "name": "THROTTLE" - }, - { - "name": "ALWAYS" - } - ], - "name": { - "name": "AllocationExplainDecision", - "namespace": "cluster.allocation_explain" - }, - "specLocation": "cluster/allocation_explain/types.ts#L32-L37" + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L42-L51" }, { "kind": "interface", "name": { - "name": "AllocationStore", - "namespace": "cluster.allocation_explain" + "name": "ClusterRemoteSniffInfo", + "namespace": "cluster.remote_info" }, "properties": [ { - "name": "allocation_id", + "name": "mode", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "sniff" } }, { - "name": "found", + "name": "connected", "required": true, "type": { "kind": "instance_of", @@ -98434,18 +102280,18 @@ } }, { - "name": "in_sync", + "name": "max_connections_per_cluster", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "matching_size_in_bytes", + "name": "num_nodes_connected", "required": true, "type": { "kind": "instance_of", @@ -98456,94 +102302,32 @@ } }, { - "name": "matching_sync_id", + "name": "initial_connect_timeout", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "store_exception", + "name": "skip_unavailable", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - } - ], - "specLocation": "cluster/allocation_explain/types.ts#L39-L46" - }, - { - "kind": "interface", - "name": { - "name": "ClusterInfo", - "namespace": "cluster.allocation_explain" - }, - "properties": [ - { - "name": "nodes", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "NodeDiskUsage", - "namespace": "cluster.allocation_explain" - } - } - } }, { - "name": "shard_sizes", + "name": "seeds", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - }, - { - "name": "shard_data_set_sizes", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { @@ -98552,386 +102336,341 @@ } } } - }, - { - "name": "shard_paths", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + } + ], + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L32-L40" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "The cluster remote info API allows you to retrieve all of the configured\nremote cluster information. It returns connection and endpoint information\nkeyed by the configured remote cluster alias.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.remote_info" + }, + "path": [], + "query": [], + "specLocation": "cluster/remote_info/ClusterRemoteInfoRequest.ts#L23-L31" + }, + { + "body": { + "kind": "value", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "reserved_sizes", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ReservedSize", - "namespace": "cluster.allocation_explain" - } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterRemoteInfo", + "namespace": "cluster.remote_info" } } } - ], - "specLocation": "cluster/allocation_explain/types.ts#L48-L54" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.remote_info" + }, + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L24-L27" }, { "kind": "interface", "name": { - "name": "CurrentNode", - "namespace": "cluster.allocation_explain" + "name": "Command", + "namespace": "cluster.reroute" }, "properties": [ { - "name": "id", - "required": true, + "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.", + "name": "cancel", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "CommandCancelAction", + "namespace": "cluster.reroute" } } }, { - "name": "name", - "required": true, + "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.", + "name": "move", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "CommandMoveAction", + "namespace": "cluster.reroute" } } }, { - "name": "attributes", - "required": true, + "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.", + "name": "allocate_replica", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "CommandAllocateReplicaAction", + "namespace": "cluster.reroute" } } }, { - "name": "transport_address", - "required": true, + "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.", + "name": "allocate_stale_primary", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TransportAddress", - "namespace": "_types" + "name": "CommandAllocatePrimaryAction", + "namespace": "cluster.reroute" } } }, { - "name": "weight_ranking", - "required": true, + "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.", + "name": "allocate_empty_primary", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "CommandAllocatePrimaryAction", + "namespace": "cluster.reroute" } } } ], - "specLocation": "cluster/allocation_explain/types.ts#L78-L84" - }, - { - "kind": "enum", - "members": [ - { - "name": "yes" - }, - { - "name": "no" - }, - { - "name": "worse_balance" - }, - { - "name": "throttled" - }, - { - "name": "awaiting_info" - }, - { - "name": "allocation_delayed" - }, - { - "name": "no_valid_shard_copy" - }, - { - "name": "no_attempt" - } - ], - "name": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - }, - "specLocation": "cluster/allocation_explain/types.ts#L86-L95" + "specLocation": "cluster/reroute/types.ts#L22-L43" }, { "kind": "interface", "name": { - "name": "DiskUsage", - "namespace": "cluster.allocation_explain" + "name": "CommandAllocatePrimaryAction", + "namespace": "cluster.reroute" }, "properties": [ { - "name": "path", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "total_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "used_bytes", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "free_bytes", + "name": "shard", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "free_disk_percent", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "used_disk_percent", + "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", + "name": "accept_data_loss", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/allocation_explain/types.ts#L62-L69" + "specLocation": "cluster/reroute/types.ts#L78-L84" }, { + "docId": "modules-cluster", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cluster.html", "kind": "interface", "name": { - "name": "NodeAllocationExplanation", - "namespace": "cluster.allocation_explain" + "name": "CommandAllocateReplicaAction", + "namespace": "cluster.reroute" }, "properties": [ { - "name": "deciders", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AllocationDecision", - "namespace": "cluster.allocation_explain" - } - } - } - }, - { - "name": "node_attributes", + "name": "index", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "node_decision", + "name": "shard", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" + "name": "integer", + "namespace": "_types" } } }, { - "name": "node_id", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cluster/reroute/types.ts#L69-L76" + }, + { + "kind": "interface", + "name": { + "name": "CommandCancelAction", + "namespace": "cluster.reroute" + }, + "properties": [ { - "name": "node_name", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "store", - "required": false, + "name": "shard", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "AllocationStore", - "namespace": "cluster.allocation_explain" + "name": "integer", + "namespace": "_types" } } }, { - "name": "transport_address", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TransportAddress", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "weight_ranking", - "required": true, + "name": "allow_primary", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/allocation_explain/types.ts#L97-L106" + "specLocation": "cluster/reroute/types.ts#L45-L50" }, { "kind": "interface", "name": { - "name": "NodeDiskUsage", - "namespace": "cluster.allocation_explain" + "name": "CommandMoveAction", + "namespace": "cluster.reroute" }, "properties": [ { - "name": "node_name", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "least_available", + "name": "shard", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DiskUsage", - "namespace": "cluster.allocation_explain" + "name": "integer", + "namespace": "_types" } } }, { - "name": "most_available", + "description": "The node to move the shard from", + "name": "from_node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DiskUsage", - "namespace": "cluster.allocation_explain" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The node to move the shard to", + "name": "to_node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/allocation_explain/types.ts#L56-L60" + "specLocation": "cluster/reroute/types.ts#L60-L67" }, { "attachedBehaviors": [ @@ -98941,56 +102680,23 @@ "kind": "properties", "properties": [ { - "description": "Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.", - "name": "current_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Specifies the name of the index that you would like an explanation for.", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "description": "If true, returns explanation for the primary shard for the given shard ID.", - "name": "primary", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Specifies the ID of the shard that you would like an explanation for.", - "name": "shard", + "description": "Defines the commands to perform.", + "name": "commands", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Command", + "namespace": "cluster.reroute" + } } } } ] }, - "description": "Provides explanations for shard allocations in the cluster.", + "description": "Allows to manually change the allocation of individual shards in the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -99000,13 +102706,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.allocation_explain" + "namespace": "cluster.reroute" }, "path": [], "query": [ { - "description": "If true, returns information about disk usage and shard sizes.", - "name": "include_disk_info", + "description": "If true, then the request simulates the operation only and returns the resulting state.", + "name": "dry_run", "required": false, "serverDefault": false, "type": { @@ -99018,8 +102724,34 @@ } }, { - "description": "If true, returns YES decisions in explanation.", - "name": "include_yes_decisions", + "description": "If true, then the response contains an explanation of why the commands can or cannot be executed.", + "name": "explain", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Limits the information returned to the specified metrics.", + "name": "metric", + "required": false, + "serverDefault": "all", + "type": { + "kind": "instance_of", + "type": { + "name": "Metrics", + "namespace": "_types" + } + } + }, + { + "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", + "name": "retry_failed", "required": false, "serverDefault": false, "type": { @@ -99029,30 +102761,56 @@ "namespace": "_builtins" } } + }, + { + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L24-L61" + "specLocation": "cluster/reroute/ClusterRerouteRequest.ts#L25-L70" }, { "kind": "interface", "name": { - "name": "ReservedSize", - "namespace": "cluster.allocation_explain" + "name": "RerouteDecision", + "namespace": "cluster.reroute" }, "properties": [ { - "name": "node_id", + "name": "decider", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "path", + "name": "decision", "required": true, "type": { "kind": "instance_of", @@ -99063,353 +102821,176 @@ } }, { - "name": "total", + "name": "explanation", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L86-L90" + }, + { + "kind": "interface", + "name": { + "name": "RerouteExplanation", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "command", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "shards", + "name": "decisions", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RerouteDecision", + "namespace": "cluster.reroute" } } } + }, + { + "name": "parameters", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RerouteParameters", + "namespace": "cluster.reroute" + } + } } ], - "specLocation": "cluster/allocation_explain/types.ts#L71-L76" + "specLocation": "cluster/reroute/types.ts#L92-L96" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "allocate_explanation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "allocation_delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "allocation_delay_in_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "can_allocate", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "can_move_to_other_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "can_rebalance_cluster", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "can_rebalance_cluster_decisions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AllocationDecision", - "namespace": "cluster.allocation_explain" - } - } - } - }, - { - "name": "can_rebalance_to_other_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "can_remain_decisions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AllocationDecision", - "namespace": "cluster.allocation_explain" - } - } - } - }, - { - "name": "can_remain_on_current_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "cluster_info", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ClusterInfo", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "configured_delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "configured_delay_in_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "current_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CurrentNode", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "current_state", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "move_explanation", - "required": false, + "kind": "interface", + "name": { + "name": "RerouteParameters", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "allow_primary", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "node_allocation_decisions", - "required": false, + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "NodeAllocationExplanation", - "namespace": "cluster.allocation_explain" - } - } + "name": "IndexName", + "namespace": "_types" } - }, - { - "name": "primary", - "required": true, + } + }, + { + "name": "node", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "name": "NodeName", + "namespace": "_types" } - }, - { - "name": "rebalance_explanation", - "required": false, + } + }, + { + "name": "shard", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "integer", + "namespace": "_types" } - }, - { - "name": "remaining_delay", - "required": false, + } + }, + { + "name": "from_node", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } + "name": "NodeName", + "namespace": "_types" } - }, - { - "name": "remaining_delay_in_millis", - "required": false, + } + }, + { + "name": "to_node", + "required": false, + "type": { + "kind": "instance_of", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } + "name": "NodeName", + "namespace": "_types" } - }, + } + } + ], + "specLocation": "cluster/reroute/types.ts#L98-L105" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "name": "shard", + "name": "acknowledged", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "unassigned_info", + "name": "explanations", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "UnassignedInformation", - "namespace": "cluster.allocation_explain" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RerouteExplanation", + "namespace": "cluster.reroute" + } } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.14.0" - } - }, - "name": "note", + "description": "There aren't any guarantees on the output/structure of the raw cluster state.\nHere you will find the internal representation of the cluster, which can\ndiffer from the external representation.", + "name": "state", "required": false, - "since": "7.14.0", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "user_defined_value" } } ] @@ -99417,75 +102998,99 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cluster.allocation_explain" + "namespace": "cluster.reroute" }, - "specLocation": "cluster/allocation_explain/ClusterAllocationExplainResponse.ts#L32-L64" + "specLocation": "cluster/reroute/ClusterRerouteResponse.ts#L23-L34" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns a comprehensive information about the state of the cluster.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "UnassignedInformation", - "namespace": "cluster.allocation_explain" + "name": "Request", + "namespace": "cluster.state" }, - "properties": [ + "path": [ { - "name": "at", - "required": true, + "description": "Limit the information returned to the specified metrics", + "name": "metric", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "Metrics", "namespace": "_types" } } }, { - "name": "last_allocation_status", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Indices", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "reason", - "required": true, + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "UnassignedInformationReason", - "namespace": "cluster.allocation_explain" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "details", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ExpandWildcards", + "namespace": "_types" } } }, { - "name": "failed_allocation_attempts", + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "delayed", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -99495,569 +103100,671 @@ } }, { - "name": "allocation_status", + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - } - ], - "specLocation": "cluster/allocation_explain/types.ts#L117-L125" - }, - { - "kind": "enum", - "members": [ - { - "name": "INDEX_CREATED" }, { - "name": "CLUSTER_RECOVERED" + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } }, { - "name": "INDEX_REOPENED" + "description": "Wait for the metadata version to be equal or greater than the specified metadata version", + "name": "wait_for_metadata_version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } }, { - "name": "DANGLING_INDEX_IMPORTED" - }, + "description": "The maximum time to wait for wait_for_metadata_version before timing out", + "name": "wait_for_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/state/ClusterStateRequest.ts#L29-L56" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "user_defined_value" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.state" + }, + "specLocation": "cluster/state/ClusterStateResponse.ts#L22-L29" + }, + { + "kind": "interface", + "name": { + "name": "CharFilterTypes", + "namespace": "cluster.stats" + }, + "properties": [ { - "name": "NEW_INDEX_RESTORED" + "description": "Contains statistics about analyzer types used in selected nodes.", + "name": "analyzer_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } }, { - "name": "EXISTING_INDEX_RESTORED" + "description": "Contains statistics about built-in analyzers used in selected nodes.", + "name": "built_in_analyzers", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } }, { - "name": "REPLICA_ADDED" + "description": "Contains statistics about built-in character filters used in selected nodes.", + "name": "built_in_char_filters", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } }, { - "name": "ALLOCATION_FAILED" + "description": "Contains statistics about built-in token filters used in selected nodes.", + "name": "built_in_filters", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } }, { - "name": "NODE_LEFT" + "description": "Contains statistics about built-in tokenizers used in selected nodes.", + "name": "built_in_tokenizers", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } }, { - "name": "REROUTE_CANCELLED" + "description": "Contains statistics about character filter types used in selected nodes.", + "name": "char_filter_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } }, { - "name": "REINITIALIZED" + "description": "Contains statistics about token filter types used in selected nodes.", + "name": "filter_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } }, { - "name": "REALLOCATED_REPLICA" - }, + "description": "Contains statistics about tokenizer types used in selected nodes.", + "name": "tokenizer_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L228-L261" + }, + { + "kind": "interface", + "name": { + "name": "ClusterFileSystem", + "namespace": "cluster.stats" + }, + "properties": [ { - "name": "PRIMARY_FAILED" + "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.", + "name": "available_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } }, { - "name": "FORCED_EMPTY_PRIMARY" + "description": "Total number of unallocated bytes in file stores across all selected nodes.", + "name": "free_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } }, { - "name": "MANUAL_ALLOCATION" + "description": "Total size, in bytes, of all file stores across all selected nodes.", + "name": "total_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } } ], - "name": { - "name": "UnassignedInformationReason", - "namespace": "cluster.allocation_explain" - }, - "specLocation": "cluster/allocation_explain/types.ts#L127-L146" + "specLocation": "cluster/stats/types.ts#L34-L49" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cluster.delete_component_template" + "name": "ClusterIndices", + "namespace": "cluster.stats" }, - "path": [ + "properties": [ { - "description": "Comma-separated list or wildcard expression of component template names used to limit the request.", - "name": "name", + "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", + "name": "analysis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "CharFilterTypes", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about memory used for completion in selected nodes.", + "name": "completion", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "CompletionStats", + "namespace": "_types" + } + } + }, + { + "description": "Total number of indices with shards assigned to selected nodes.", + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Contains counts for documents in selected nodes.", + "name": "docs", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "DocStats", "namespace": "_types" } } - } - ], - "query": [ + }, { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "description": "Contains statistics about the field data cache of selected nodes.", + "docId": "modules-fielddata", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-fielddata.html", + "name": "fielddata", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "FielddataStats", "namespace": "_types" } } }, { - "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", + "description": "Contains statistics about the query cache of selected nodes.", + "name": "query_cache", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "QueryCacheStats", "namespace": "_types" } } - } - ], - "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L54" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", + }, + { + "description": "Contains statistics about segments in selected nodes.", + "name": "segments", + "required": true, "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "SegmentsStats", + "namespace": "_types" + } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.delete_component_template" - }, - "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Clears cluster voting config exclusions.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.delete_voting_config_exclusions" - }, - "path": [], - "query": [ + }, { - "description": "Specifies whether to wait for all excluded nodes to be removed from the\ncluster before clearing the voting configuration exclusions list.\nDefaults to true, meaning that all excluded nodes must be removed from\nthe cluster before this API takes any action. If set to false then the\nvoting configuration exclusions list is cleared even if some excluded\nnodes are still in the cluster.", - "name": "wait_for_removal", - "required": false, - "serverDefault": true, + "description": "Contains statistics about indices with shards assigned to selected nodes.", + "name": "shards", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ClusterIndicesShards", + "namespace": "cluster.stats" } } - } - ], - "specLocation": "cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts#L22-L40" - }, - { - "body": { - "kind": "no_body" - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.delete_voting_config_exclusions" - }, - "specLocation": "cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns information about whether a particular component template exist", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.exists_component_template" - }, - "path": [ + }, { - "description": "Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.", - "name": "name", + "description": "Contains statistics about the size of shards assigned to selected nodes.", + "name": "store", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "StoreStats", "namespace": "_types" } } - } - ], - "query": [ + }, { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "description": "Contains statistics about field mappings in selected nodes.", + "name": "mappings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "FieldTypesMappings", + "namespace": "cluster.stats" } } }, { - "description": "If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.", - "name": "local", + "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", + "docId": "analyzer-anatomy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analyzer-anatomy.html", + "name": "versions", "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndicesVersions", + "namespace": "cluster.stats" + } } } } ], - "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L53" - }, - { - "body": { - "kind": "no_body" - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.exists_component_template" - }, - "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsResponse.ts#L22-L24" + "specLocation": "cluster/stats/types.ts#L74-L107" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Retrieves information about component templates.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "description": "Contains statistics about shards assigned to selected nodes.", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cluster.get_component_template" + "name": "ClusterIndicesShards", + "namespace": "cluster.stats" }, - "path": [ + "properties": [ { - "description": "Comma-separated list of component template names used to limit the request.\nWildcard (`*`) expressions are supported.", - "name": "name", + "description": "Contains statistics about shards assigned to selected nodes.", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "ClusterIndicesShardsIndex", + "namespace": "cluster.stats" } } - } - ], - "query": [ + }, { - "description": "If `true`, returns settings in flat format.", - "name": "flat_settings", + "description": "Number of primary shards assigned to selected nodes.", + "name": "primaries", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "availability": { - "serverless": { - "stability": "stable" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" - } - }, - "description": "Return all default configurations for the component template (default: false)", - "name": "include_defaults", + "description": "Ratio of replica shards to primary shards across all selected nodes.", + "name": "replication", "required": false, - "serverDefault": false, - "since": "8.11.0", - "stability": "stable", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", - "name": "local", + "description": "Total number of shards assigned to selected nodes.", + "name": "total", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L60-L72" + }, + { + "kind": "interface", + "name": { + "name": "ClusterIndicesShardsIndex", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Contains statistics about the number of primary shards assigned to selected nodes.", + "name": "primaries", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterShardMetrics", + "namespace": "cluster.stats" } } }, { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "description": "Contains statistics about the number of replication shards assigned to selected nodes.", + "name": "replication", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "ClusterShardMetrics", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about the number of shards assigned to selected nodes.", + "name": "shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterShardMetrics", + "namespace": "cluster.stats" } } } ], - "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L65" + "specLocation": "cluster/stats/types.ts#L51-L58" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "component_templates", - "required": true, + "kind": "interface", + "name": { + "name": "ClusterIngest", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "number_of_pipelines", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ComponentTemplate", - "namespace": "cluster._types" - } + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "processor_stats", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterProcessor", + "namespace": "cluster.stats" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.get_component_template" - }, - "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateResponse.ts#L22-L24" + } + ], + "specLocation": "cluster/stats/types.ts#L270-L273" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns cluster-wide settings.\nBy default, it returns only settings that have been explicitly defined.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cluster.get_settings" + "name": "ClusterJvm", + "namespace": "cluster.stats" }, - "path": [], - "query": [ + "properties": [ { - "description": "If `true`, returns settings in flat format.", - "name": "flat_settings", - "required": false, - "serverDefault": false, + "description": "Uptime duration, in milliseconds, since JVM last started.", + "name": "max_uptime_in_millis", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DurationValue", + "namespace": "_types" } } }, { - "description": "If `true`, returns default cluster settings from the local node.", - "name": "include_defaults", - "required": false, - "serverDefault": false, + "description": "Contains statistics about memory used by selected nodes.", + "name": "mem", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ClusterJvmMemory", + "namespace": "cluster.stats" } } }, { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "description": "Number of active threads in use by JVM across all selected nodes.", + "name": "threads", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", + "description": "Contains statistics about the JVM versions used by selected nodes.", + "name": "versions", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterJvmVersion", + "namespace": "cluster.stats" + } } } } ], - "specLocation": "cluster/get_settings/ClusterGetSettingsRequest.ts#L23-L57" + "specLocation": "cluster/stats/types.ts#L275-L292" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "persistent", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "transient", - "required": true, + "kind": "interface", + "name": { + "name": "ClusterJvmMemory", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.", + "name": "heap_max_in_bytes", + "required": true, + "type": { + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "defaults", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } + } + }, + { + "description": "Memory, in bytes, currently in use by the heap across all selected nodes.", + "name": "heap_used_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.get_settings" - }, - "specLocation": "cluster/get_settings/ClusterGetSettingsResponse.ts#L23-L29" + } + ], + "specLocation": "cluster/stats/types.ts#L294-L303" }, { "kind": "interface", "name": { - "name": "HealthResponseBody", - "namespace": "cluster.health" + "name": "ClusterJvmVersion", + "namespace": "cluster.stats" }, "properties": [ { - "description": "The number of active primary shards.", - "name": "active_primary_shards", + "description": "Always `true`. All distributions come with a bundled Java Development Kit (JDK).", + "name": "bundled_jdk", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The total number of active primary and replica shards.", - "name": "active_shards", + "description": "Total number of selected nodes using JVM.", + "name": "count", "required": true, "type": { "kind": "instance_of", @@ -100068,50 +103775,85 @@ } }, { - "description": "The ratio of active shards in the cluster expressed as a percentage.", - "name": "active_shards_percent_as_number", + "description": "If `true`, a bundled JDK is in use by JVM.", + "name": "using_bundled_jdk", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The name of the cluster.", - "name": "cluster_name", + "description": "Version of JVM used by one or more selected nodes.", + "name": "version", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "VersionString", "namespace": "_types" } } }, { - "description": "The number of shards whose allocation has been delayed by the timeout settings.", - "name": "delayed_unassigned_shards", + "description": "Name of the JVM.", + "name": "vm_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "indices", - "required": false, + "description": "Vendor of the JVM.", + "name": "vm_vendor", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Full version number of JVM.\nThe full version number includes a plus sign (+) followed by the build number.", + "name": "vm_version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L305-L335" + }, + { + "kind": "interface", + "name": { + "name": "ClusterNetworkTypes", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Contains statistics about the HTTP network types used by selected nodes.", + "name": "http_types", + "required": true, "type": { "key": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -100119,27 +103861,47 @@ "value": { "kind": "instance_of", "type": { - "name": "IndexHealthStats", - "namespace": "cluster.health" + "name": "integer", + "namespace": "_types" } } } }, { - "description": "The number of shards that are under initialization.", - "name": "initializing_shards", + "description": "Contains statistics about the transport network types used by selected nodes.", + "name": "transport_types", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } - }, + } + ], + "specLocation": "cluster/stats/types.ts#L337-L346" + }, + { + "kind": "interface", + "name": { + "name": "ClusterNodeCount", + "namespace": "cluster.stats" + }, + "properties": [ { - "description": "The number of nodes that are dedicated data nodes.", - "name": "number_of_data_nodes", + "name": "coordinating_only", "required": true, "type": { "kind": "instance_of", @@ -100150,8 +103912,7 @@ } }, { - "description": "The number of unfinished fetches.", - "name": "number_of_in_flight_fetch", + "name": "data", "required": true, "type": { "kind": "instance_of", @@ -100162,8 +103923,7 @@ } }, { - "description": "The number of nodes within the cluster.", - "name": "number_of_nodes", + "name": "data_cold", "required": true, "type": { "kind": "instance_of", @@ -100174,8 +103934,7 @@ } }, { - "description": "The number of cluster-level changes that have not yet been executed.", - "name": "number_of_pending_tasks", + "name": "data_content", "required": true, "type": { "kind": "instance_of", @@ -100186,9 +103945,15 @@ } }, { - "description": "The number of shards that are under relocation.", - "name": "relocating_shards", - "required": true, + "availability": { + "serverless": {}, + "stack": { + "since": "7.13.0" + } + }, + "name": "data_frozen", + "required": false, + "since": "7.13.0", "type": { "kind": "instance_of", "type": { @@ -100198,64 +103963,40 @@ } }, { - "name": "status", + "name": "data_hot", "required": true, "type": { "kind": "instance_of", "type": { - "name": "HealthStatus", - "namespace": "_types" - } - } - }, - { - "description": "The time since the earliest initiated task is waiting for being performed.", - "name": "task_max_waiting_in_queue", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "description": "The time expressed in milliseconds since the earliest initiated task is waiting for being performed.", - "name": "task_max_waiting_in_queue_millis", + "name": "data_warm", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "integer", "namespace": "_types" } } }, { - "description": "If false the response returned within the period of time that is specified by the timeout parameter (30s by default)", - "name": "timed_out", + "name": "ingest", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "The number of shards that are not allocated.", - "name": "unassigned_shards", + "name": "master", "required": true, "type": { "kind": "instance_of", @@ -100264,19 +104005,9 @@ "namespace": "_types" } } - } - ], - "specLocation": "cluster/health/ClusterHealthResponse.ts#L39-L72" - }, - { - "kind": "interface", - "name": { - "name": "IndexHealthStats", - "namespace": "cluster.health" - }, - "properties": [ + }, { - "name": "active_primary_shards", + "name": "ml", "required": true, "type": { "kind": "instance_of", @@ -100287,7 +104018,7 @@ } }, { - "name": "active_shards", + "name": "remote_cluster_client", "required": true, "type": { "kind": "instance_of", @@ -100298,7 +104029,7 @@ } }, { - "name": "initializing_shards", + "name": "total", "required": true, "type": { "kind": "instance_of", @@ -100309,7 +104040,7 @@ } }, { - "name": "number_of_replicas", + "name": "transform", "required": true, "type": { "kind": "instance_of", @@ -100320,7 +104051,7 @@ } }, { - "name": "number_of_shards", + "name": "voting_only", "required": true, "type": { "kind": "instance_of", @@ -100329,21 +104060,35 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/stats/types.ts#L348-L367" + }, + { + "kind": "interface", + "name": { + "name": "ClusterNodes", + "namespace": "cluster.stats" + }, + "properties": [ { - "name": "relocating_shards", + "description": "Contains counts for nodes selected by the request’s node filters.", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ClusterNodeCount", + "namespace": "cluster.stats" } } }, { - "name": "shards", - "required": false, + "description": "Contains statistics about the discovery types used by selected nodes.", + "docId": "modules-discovery-hosts-providers", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-discovery-hosts-providers.html", + "name": "discovery_types", + "required": true, "type": { "key": { "kind": "instance_of", @@ -100357,269 +104102,284 @@ "value": { "kind": "instance_of", "type": { - "name": "ShardHealthStats", - "namespace": "cluster.health" + "name": "integer", + "namespace": "_types" } } } }, { - "name": "status", + "description": "Contains statistics about file stores by selected nodes.", + "name": "fs", "required": true, "type": { "kind": "instance_of", "type": { - "name": "HealthStatus", - "namespace": "_types" + "name": "ClusterFileSystem", + "namespace": "cluster.stats" } } }, { - "name": "unassigned_shards", + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "indexing_pressure", "required": true, + "since": "7.16.0", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexingPressure", + "namespace": "cluster.stats" } } - } - ], - "specLocation": "cluster/health/types.ts#L24-L34" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.\nThe cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.health" - }, - "path": [ + }, { - "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.", - "name": "index", - "required": false, + "name": "ingest", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "ClusterIngest", + "namespace": "cluster.stats" } } - } - ], - "query": [ + }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "name": "expand_wildcards", - "required": false, + "description": "Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.", + "name": "jvm", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "ClusterJvm", + "namespace": "cluster.stats" } } }, { - "description": "Can be one of cluster, indices or shards. Controls the details level of the health information returned.", - "name": "level", - "required": false, - "serverDefault": "cluster", + "description": "Contains statistics about the transport and HTTP networks used by selected nodes.", + "name": "network_types", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Level", - "namespace": "_types" + "name": "ClusterNetworkTypes", + "namespace": "cluster.stats" } } }, { - "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", - "name": "local", - "required": false, - "serverDefault": false, + "description": "Contains statistics about the operating systems used by selected nodes.", + "name": "os", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ClusterOperatingSystem", + "namespace": "cluster.stats" } } }, { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "description": "Contains statistics about Elasticsearch distributions installed on selected nodes.", + "name": "packaging_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "NodePackagingType", + "namespace": "cluster.stats" + } + } + } + }, + { + "description": "Contains statistics about installed plugins and modules by selected nodes.\nIf no plugins or modules are installed, this array is empty.", + "name": "plugins", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PluginStats", + "namespace": "_types" + } + } + } + }, + { + "description": "Contains statistics about processes used by selected nodes.", + "name": "process", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "ClusterProcess", + "namespace": "cluster.stats" } } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", + "description": "Array of Elasticsearch versions used on selected nodes.", + "name": "versions", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L369-L402" + }, + { + "kind": "interface", + "name": { + "name": "ClusterOperatingSystem", + "namespace": "cluster.stats" + }, + "properties": [ + { + "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.", + "name": "allocated_processors", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "description": "A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.", - "name": "wait_for_active_shards", + "description": "Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.", + "name": "architectures", "required": false, - "serverDefault": "0", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterOperatingSystemArchitecture", + "namespace": "cluster.stats" + } + } + } + }, + { + "description": "Number of processors available to JVM across all selected nodes.", + "name": "available_processors", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", + "name": "integer", "namespace": "_types" } } }, { - "description": "Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.", - "name": "wait_for_events", - "required": false, + "description": "Contains statistics about memory used by selected nodes.", + "name": "mem", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "WaitForEvents", - "namespace": "_types" + "name": "OperatingSystemMemoryInfo", + "namespace": "cluster.stats" } } }, { - "description": "The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status.", - "name": "wait_for_status", - "required": false, + "description": "Number of selected nodes using the architecture.", + "name": "count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "HealthStatus", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L98" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "HealthResponseBody", - "namespace": "cluster.health" - } - } - }, - "exceptions": [ - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "HealthResponseBody", - "namespace": "cluster.health" - } - } - }, - "statusCodes": [ - 408 - ] - } - ], - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.health" - }, - "specLocation": "cluster/health/ClusterHealthResponse.ts#L26-L37" + "specLocation": "cluster/stats/types.ts#L404-L413" }, { "kind": "interface", "name": { - "name": "ShardHealthStats", - "namespace": "cluster.health" + "name": "ClusterOperatingSystemName", + "namespace": "cluster.stats" }, "properties": [ { - "name": "active_shards", + "description": "Number of selected nodes using the operating system.", + "name": "count", "required": true, "type": { "kind": "instance_of", @@ -100630,875 +104390,572 @@ } }, { - "name": "initializing_shards", + "description": "Name of an operating system used by one or more selected nodes.", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/stats/types.ts#L444-L453" + }, + { + "kind": "interface", + "name": { + "name": "ClusterOperatingSystemPrettyName", + "namespace": "cluster.stats" + }, + "properties": [ { - "name": "primary_active", + "description": "Number of selected nodes using the operating system.", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "relocating_shards", + "description": "Human-readable name of an operating system used by one or more selected nodes.", + "name": "pretty_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/stats/types.ts#L455-L464" + }, + { + "kind": "interface", + "name": { + "name": "ClusterProcess", + "namespace": "cluster.stats" + }, + "properties": [ { - "name": "status", + "description": "Contains statistics about CPU used by selected nodes.", + "name": "cpu", "required": true, "type": { "kind": "instance_of", "type": { - "name": "HealthStatus", - "namespace": "_types" + "name": "ClusterProcessCpu", + "namespace": "cluster.stats" } } }, { - "name": "unassigned_shards", + "description": "Contains statistics about open file descriptors in selected nodes.", + "name": "open_file_descriptors", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ClusterProcessOpenFileDescriptors", + "namespace": "cluster.stats" } } } ], - "specLocation": "cluster/health/types.ts#L36-L43" + "specLocation": "cluster/stats/types.ts#L466-L475" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns different information about the cluster.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cluster.info" + "name": "ClusterProcessCpu", + "namespace": "cluster.stats" }, - "path": [ + "properties": [ { - "description": "Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.", - "name": "target", + "description": "Percentage of CPU used across all selected nodes.\nReturns `-1` if not supported.", + "name": "percent", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterInfoTargets", + "name": "integer", "namespace": "_types" } } } ], - "query": [], - "specLocation": "cluster/info/ClusterInfoRequest.ts#L23-L34" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "http", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Http", - "namespace": "nodes._types" - } - } - }, - { - "name": "ingest", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Ingest", - "namespace": "nodes._types" - } - } - }, - { - "name": "thread_pool", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ThreadCount", - "namespace": "nodes._types" - } - } - } - }, - { - "name": "script", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Scripting", - "namespace": "nodes._types" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.info" - }, - "specLocation": "cluster/info/ClusterInfoResponse.ts#L26-L34" + "specLocation": "cluster/stats/types.ts#L477-L483" }, { "kind": "interface", "name": { - "name": "PendingTask", - "namespace": "cluster.pending_tasks" + "name": "ClusterProcessOpenFileDescriptors", + "namespace": "cluster.stats" }, "properties": [ { - "description": "Indicates whether the pending tasks are currently executing or not.", - "name": "executing", + "description": "Average number of concurrently open file descriptors.\nReturns `-1` if not supported.", + "name": "avg", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "description": "The number that represents when the task has been inserted into the task queue.", - "name": "insert_order", + "description": "Maximum number of concurrently open file descriptors allowed across all selected nodes.\nReturns `-1` if not supported.", + "name": "max", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "description": "The priority of the pending task.\nThe valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`.", - "name": "priority", + "description": "Minimum number of concurrently open file descriptors across all selected nodes.\nReturns -1 if not supported.", + "name": "min", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/stats/types.ts#L485-L501" + }, + { + "kind": "interface", + "name": { + "name": "ClusterProcessor", + "namespace": "cluster.stats" + }, + "properties": [ { - "description": "A general description of the cluster task that may include a reason and origin.", - "name": "source", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "description": "The time since the task is waiting for being performed.", - "name": "time_in_queue", - "required": false, + "name": "current", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "description": "The time expressed in milliseconds since the task is waiting for being performed.", - "name": "time_in_queue_millis", + "name": "failed", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "long", "namespace": "_types" } } - } - ], - "specLocation": "cluster/pending_tasks/types.ts#L23-L47" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.\nNOTE: This API returns a list of any pending updates to the cluster state.\nThese are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.\nHowever, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.pending_tasks" - }, - "path": [], - "query": [ + }, { - "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", - "name": "local", + "name": "time", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "name": "time_in_millis", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "Duration", + "name": "DurationValue", "namespace": "_types" } } } ], - "specLocation": "cluster/pending_tasks/ClusterPendingTasksRequest.ts#L23-L48" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "tasks", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PendingTask", - "namespace": "cluster.pending_tasks" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.pending_tasks" - }, - "specLocation": "cluster/pending_tasks/ClusterPendingTasksResponse.ts#L22-L24" + "specLocation": "cluster/stats/types.ts#L503-L509" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Updates the cluster voting config exclusions by node ids or node names.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cluster.post_voting_config_exclusions" + "name": "ClusterShardMetrics", + "namespace": "cluster.stats" }, - "path": [], - "query": [ + "properties": [ { - "description": "A comma-separated list of the names of the nodes to exclude from the\nvoting configuration. If specified, you may not also specify node_ids.", - "name": "node_names", - "required": false, + "description": "Mean number of shards in an index, counting only shards assigned to selected nodes.", + "name": "avg", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "double", "namespace": "_types" } } }, { - "description": "A comma-separated list of the persistent ids of the nodes to exclude\nfrom the voting configuration. If specified, you may not also specify node_names.", - "name": "node_ids", - "required": false, + "description": "Maximum number of shards in an index, counting only shards assigned to selected nodes.", + "name": "max", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "double", "namespace": "_types" } } }, { - "description": "When adding a voting configuration exclusion, the API waits for the\nspecified nodes to be excluded from the voting configuration before\nreturning. If the timeout expires before the appropriate condition\nis satisfied, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", + "description": "Minimum number of shards in an index, counting only shards assigned to selected nodes.", + "name": "min", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "double", "namespace": "_types" } } } ], - "specLocation": "cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts#L24-L50" + "specLocation": "cluster/stats/types.ts#L511-L524" }, { - "body": { - "kind": "no_body" - }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "cluster.post_voting_config_exclusions" + "name": "FieldTypes", + "namespace": "cluster.stats" }, - "specLocation": "cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "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\ntemplate even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false` then data streams matching the template must always be explicitly created.", - "name": "allow_auto_create", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The template to be applied which includes mappings, settings, or aliases configuration.", - "name": "template", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexState", - "namespace": "indices._types" - } - } - }, - { - "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.", - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "description": "Optional user metadata about the component template.\nMay 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.", - "name": "_meta", - "required": false, + "properties": [ + { + "description": "The name for the field type in selected nodes.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } + "name": "Name", + "namespace": "_types" } } - ] - }, - "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.put_component_template" - }, - "path": [ + }, { - "description": "Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.", - "name": "name", + "description": "The number of occurrences of the field type in selected nodes.", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } - } - ], - "query": [ + }, { - "description": "If `true`, this request cannot replace or update existing component templates.", - "name": "create", - "required": false, - "serverDefault": false, + "description": "The number of indices containing the field type in selected nodes.", + "name": "index_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "master_timeout", + "description": "For dense_vector field types, number of indexed vector types in selected nodes.", + "name": "indexed_vector_count", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } - } - ], - "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L29-L99" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.put_component_template" - }, - "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "persistent", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "transient", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] - }, - "description": "Updates the cluster settings.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.put_settings" - }, - "path": [], - "query": [ + }, { - "description": "Return settings in flat format (default: false)", - "name": "flat_settings", + "description": "For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.", + "name": "indexed_vector_dim_max", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "description": "Explicit operation timeout for connection to master node", - "name": "master_timeout", + "description": "For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.", + "name": "indexed_vector_dim_min", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "description": "Explicit operation timeout", - "name": "timeout", + "availability": { + "serverless": {}, + "stack": { + "since": "7.13.0" + } + }, + "description": "The number of fields that declare a script.", + "name": "script_count", "required": false, - "serverDefault": "30s", + "since": "7.13.0", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L43" + "specLocation": "cluster/stats/types.ts#L136-L167" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "acknowledged", - "required": true, - "type": { + "kind": "interface", + "name": { + "name": "FieldTypesMappings", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Contains statistics about field data types used in selected nodes.", + "name": "field_types", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "persistent", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "name": "FieldTypes", + "namespace": "cluster.stats" } } - }, - { - "name": "transient", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + } + }, + { + "description": "Contains statistics about runtime field data types used in selected nodes.", + "name": "runtime_field_types", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RuntimeFieldTypes", + "namespace": "cluster.stats" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.put_settings" - }, - "specLocation": "cluster/put_settings/ClusterPutSettingsResponse.ts#L23-L29" - }, - { - "kind": "type_alias", - "name": { - "name": "ClusterRemoteInfo", - "namespace": "cluster.remote_info" - }, - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L29-L30", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ClusterRemoteSniffInfo", - "namespace": "cluster.remote_info" - } - }, - { + }, + { + "description": "Total number of fields in all non-system indices.", + "name": "total_field_count", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ClusterRemoteProxyInfo", - "namespace": "cluster.remote_info" + "name": "integer", + "namespace": "_types" } } - ], - "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "tag": "mode" - } - }, - { - "kind": "interface", - "name": { - "name": "ClusterRemoteProxyInfo", - "namespace": "cluster.remote_info" - }, - "properties": [ - { - "name": "mode", - "required": true, - "type": { - "kind": "literal_value", - "value": "proxy" - } }, { - "name": "connected", - "required": true, + "description": "Total number of fields in all non-system indices, accounting for mapping deduplication.", + "name": "total_deduplicated_field_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "initial_connect_timeout", - "required": true, + "description": "Total size of all mappings after deduplication and compression.", + "name": "total_deduplicated_mapping_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "skip_unavailable", - "required": true, + "description": "Total size of all mappings, in bytes, after deduplication and compression.", + "name": "total_deduplicated_mapping_size_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - }, + } + ], + "specLocation": "cluster/stats/types.ts#L109-L134" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressure", + "namespace": "cluster.stats" + }, + "properties": [ { - "name": "proxy_address", + "name": "memory", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexingPressureMemory", + "namespace": "cluster.stats" } } - }, + } + ], + "specLocation": "cluster/stats/types.ts#L570-L572" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressureMemory", + "namespace": "cluster.stats" + }, + "properties": [ { - "name": "server_name", + "name": "current", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexingPressureMemorySummary", + "namespace": "cluster.stats" } } }, { - "name": "num_proxy_sockets_connected", + "name": "limit_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "max_proxy_socket_connections", + "name": "total", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexingPressureMemorySummary", + "namespace": "cluster.stats" } } } ], - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L42-L51" + "specLocation": "cluster/stats/types.ts#L574-L578" }, { "kind": "interface", "name": { - "name": "ClusterRemoteSniffInfo", - "namespace": "cluster.remote_info" + "name": "IndexingPressureMemorySummary", + "namespace": "cluster.stats" }, "properties": [ { - "name": "mode", + "name": "all_in_bytes", "required": true, "type": { - "kind": "literal_value", - "value": "sniff" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } }, { - "name": "connected", + "name": "combined_coordinating_and_primary_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "max_connections_per_cluster", + "name": "coordinating_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "num_nodes_connected", - "required": true, + "name": "coordinating_rejections", + "required": false, "type": { "kind": "instance_of", "type": { @@ -101508,186 +104965,193 @@ } }, { - "name": "initial_connect_timeout", + "name": "primary_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "name": "skip_unavailable", - "required": true, + "name": "primary_rejections", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "seeds", + "name": "replica_in_bytes", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - } - ], - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L32-L40" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "The cluster remote info API allows you to retrieve all of the configured\nremote cluster information. It returns connection and endpoint information\nkeyed by the configured remote cluster alias.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.remote_info" - }, - "path": [], - "query": [], - "specLocation": "cluster/remote_info/ClusterRemoteInfoRequest.ts#L23-L31" - }, - { - "body": { - "kind": "value", - "value": { - "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { + } + }, + { + "name": "replica_rejections", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ClusterRemoteInfo", - "namespace": "cluster.remote_info" + "name": "long", + "namespace": "_types" } } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.remote_info" - }, - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L24-L27" + ], + "specLocation": "cluster/stats/types.ts#L580-L589" }, { "kind": "interface", "name": { - "name": "Command", - "namespace": "cluster.reroute" + "name": "IndicesVersions", + "namespace": "cluster.stats" }, "properties": [ { - "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.", - "name": "cancel", - "required": false, + "name": "index_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CommandCancelAction", - "namespace": "cluster.reroute" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "move", - "required": false, + "name": "primary_shard_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CommandMoveAction", - "namespace": "cluster.reroute" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "allocate_replica", - "required": false, + "name": "total_primary_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CommandAllocateReplicaAction", - "namespace": "cluster.reroute" + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L263-L268" + }, + { + "kind": "interface", + "name": { + "name": "NodePackagingType", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Number of selected nodes using the distribution flavor and file type.", + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "allocate_stale_primary", - "required": false, + "description": "Type of Elasticsearch distribution. This is always `default`.", + "name": "flavor", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CommandAllocatePrimaryAction", - "namespace": "cluster.reroute" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "allocate_empty_primary", - "required": false, + "description": "File type (such as `tar` or `zip`) used for the distribution package.", + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CommandAllocatePrimaryAction", - "namespace": "cluster.reroute" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/reroute/types.ts#L22-L43" + "specLocation": "cluster/stats/types.ts#L526-L539" }, { "kind": "interface", "name": { - "name": "CommandAllocatePrimaryAction", - "namespace": "cluster.reroute" + "name": "OperatingSystemMemoryInfo", + "namespace": "cluster.stats" }, "properties": [ { - "name": "index", + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "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.", + "name": "adjusted_total_in_bytes", + "required": false, + "since": "7.16.0", + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Amount, in bytes, of free physical memory across all selected nodes.", + "name": "free_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "long", "namespace": "_types" } } }, { - "name": "shard", + "description": "Percentage of free physical memory across all selected nodes.", + "name": "free_percent", "required": true, "type": { "kind": "instance_of", @@ -101698,96 +105162,146 @@ } }, { - "name": "node", + "description": "Total amount, in bytes, of physical memory across all selected nodes.", + "name": "total_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "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", - "name": "accept_data_loss", + "description": "Amount, in bytes, of physical memory in use across all selected nodes.", + "name": "used_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Percentage of physical memory in use across all selected nodes.", + "name": "used_percent", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "cluster/reroute/types.ts#L78-L84" + "specLocation": "cluster/stats/types.ts#L541-L568" }, { - "docId": "modules-cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cluster.html", - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns cluster statistics.\nIt returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "CommandAllocateReplicaAction", - "namespace": "cluster.reroute" + "name": "Request", + "namespace": "cluster.stats" }, - "properties": [ + "path": [ { - "name": "index", - "required": true, + "description": "Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.", + "name": "node_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "NodeIds", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "shard", - "required": true, + "description": "If `true`, returns settings in flat format.", + "name": "flat_settings", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "node", - "required": true, + "description": "Period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its stats.\nHowever, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout.", + "name": "timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } } ], - "specLocation": "cluster/reroute/types.ts#L69-L76" + "specLocation": "cluster/stats/ClusterStatsRequest.ts#L24-L50" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "StatsResponseBase", + "namespace": "cluster.stats" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.stats" + }, + "specLocation": "cluster/stats/ClusterStatsResponse.ts#L53-L55" }, { "kind": "interface", "name": { - "name": "CommandCancelAction", - "namespace": "cluster.reroute" + "name": "RuntimeFieldTypes", + "namespace": "cluster.stats" }, "properties": [ { - "name": "index", + "description": "Maximum number of characters for a single runtime field script.", + "name": "chars_max", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } }, { - "name": "shard", + "description": "Total number of characters for the scripts that define the current runtime field data type.", + "name": "chars_total", "required": true, "type": { "kind": "instance_of", @@ -101798,50 +105312,44 @@ } }, { - "name": "node", + "description": "Number of runtime fields mapped to the field data type in selected nodes.", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "allow_primary", - "required": false, + "description": "Maximum number of accesses to doc_values for a single runtime field script", + "name": "doc_max", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "cluster/reroute/types.ts#L45-L50" - }, - { - "kind": "interface", - "name": { - "name": "CommandMoveAction", - "namespace": "cluster.reroute" - }, - "properties": [ + }, { - "name": "index", + "description": "Total number of accesses to doc_values for the scripts that define the current runtime field data type.", + "name": "doc_total", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } }, { - "name": "shard", + "description": "Number of indices containing a mapping of the runtime field data type in selected nodes.", + "name": "index_count", "required": true, "type": { "kind": "instance_of", @@ -101852,413 +105360,309 @@ } }, { - "description": "The node to move the shard from", - "name": "from_node", + "description": "Script languages used for the runtime fields scripts.", + "name": "lang", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "The node to move the shard to", - "name": "to_node", + "description": "Maximum number of lines for a single runtime field script.", + "name": "lines_max", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "cluster/reroute/types.ts#L60-L67" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "Defines the commands to perform.", - "name": "commands", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Command", - "namespace": "cluster.reroute" - } - } + "name": "integer", + "namespace": "_types" } } - ] - }, - "description": "Allows to manually change the allocation of individual shards in the cluster.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.reroute" - }, - "path": [], - "query": [ + }, { - "description": "If true, then the request simulates the operation only and returns the resulting state.", - "name": "dry_run", - "required": false, - "serverDefault": false, + "description": "Total number of lines for the scripts that define the current runtime field data type.", + "name": "lines_total", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "If true, then the response contains an explanation of why the commands can or cannot be executed.", - "name": "explain", - "required": false, - "serverDefault": false, + "description": "Field data type used in selected nodes.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "description": "Limits the information returned to the specified metrics.", - "name": "metric", - "required": false, - "serverDefault": "all", + "description": "Number of runtime fields that don’t declare a script.", + "name": "scriptless_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Metrics", + "name": "integer", "namespace": "_types" } } }, { - "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", - "name": "retry_failed", - "required": false, - "serverDefault": false, + "description": "Number of runtime fields that shadow an indexed field.", + "name": "shadowed_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "description": "Maximum number of accesses to _source for a single runtime field script.", + "name": "source_max", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", + "description": "Total number of accesses to _source for the scripts that define the current runtime field data type.", + "name": "source_total", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "cluster/reroute/ClusterRerouteRequest.ts#L25-L70" + "specLocation": "cluster/stats/types.ts#L169-L226" }, { + "inherits": { + "type": { + "name": "NodesResponseBase", + "namespace": "nodes._types" + } + }, "kind": "interface", "name": { - "name": "RerouteDecision", - "namespace": "cluster.reroute" + "name": "StatsResponseBase", + "namespace": "cluster.stats" }, "properties": [ { - "name": "decider", + "description": "Name of the cluster, based on the cluster name setting.", + "name": "cluster_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "name": "decision", + "description": "Unique identifier for the cluster.", + "name": "cluster_uuid", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Uuid", + "namespace": "_types" } } }, { - "name": "explanation", + "description": "Contains statistics about indices with shards assigned to selected nodes.", + "name": "indices", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ClusterIndices", + "namespace": "cluster.stats" } } - } - ], - "specLocation": "cluster/reroute/types.ts#L86-L90" - }, - { - "kind": "interface", - "name": { - "name": "RerouteExplanation", - "namespace": "cluster.reroute" - }, - "properties": [ + }, { - "name": "command", + "description": "Contains statistics about nodes selected by the request’s node filters.", + "docId": "cluster-nodes", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html#cluster-nodes", + "name": "nodes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ClusterNodes", + "namespace": "cluster.stats" } } }, { - "name": "decisions", + "description": "Health status of the cluster, based on the state of its primary and replica shards.", + "name": "status", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RerouteDecision", - "namespace": "cluster.reroute" - } + "kind": "instance_of", + "type": { + "name": "HealthStatus", + "namespace": "_types" } } }, { - "name": "parameters", + "description": "Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.", + "name": "timestamp", "required": true, "type": { "kind": "instance_of", "type": { - "name": "RerouteParameters", - "namespace": "cluster.reroute" + "name": "long", + "namespace": "_types" } } } ], - "specLocation": "cluster/reroute/types.ts#L92-L96" + "specLocation": "cluster/stats/ClusterStatsResponse.ts#L25-L51" }, { "kind": "interface", "name": { - "name": "RerouteParameters", - "namespace": "cluster.reroute" + "name": "Connector", + "namespace": "connector._types" }, "properties": [ { - "name": "allow_primary", - "required": true, + "name": "api_key_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "index", + "name": "configuration", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "ConnectorConfiguration", + "namespace": "connector._types" } } }, { - "name": "node", + "name": "custom_scheduling", "required": true, "type": { "kind": "instance_of", "type": { - "name": "NodeName", - "namespace": "_types" + "name": "ConnectorCustomScheduling", + "namespace": "connector._types" } } }, { - "name": "shard", - "required": true, + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "from_node", + "name": "error", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "to_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeName", - "namespace": "_types" - } - } - } - ], - "specLocation": "cluster/reroute/types.ts#L98-L105" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "explanations", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RerouteExplanation", - "namespace": "cluster.reroute" - } - } - } - }, - { - "description": "There aren't any guarantees on the output/structure of the raw cluster state.\nHere you will find the internal representation of the cluster, which can\ndiffer from the external representation.", - "name": "state", - "required": false, - "type": { - "kind": "user_defined_value" - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.reroute" - }, - "specLocation": "cluster/reroute/ClusterRerouteResponse.ts#L23-L34" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns a comprehensive information about the state of the cluster.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.state" - }, - "path": [ + "name": "features", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ConnectorFeatures", + "namespace": "connector._types" + } + } + }, { - "description": "Limit the information returned to the specified metrics", - "name": "metric", + "name": "filtering", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FilteringConfig", + "namespace": "connector._types" + } + } + } + }, + { + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Metrics", + "name": "Id", "namespace": "_types" } } }, { - "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", - "name": "index", + "name": "index_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", - "name": "allow_no_indices", - "required": false, - "serverDefault": true, + "name": "is_native", + "required": true, "type": { "kind": "instance_of", "type": { @@ -102268,745 +105672,643 @@ } }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "name": "expand_wildcards", + "name": "language", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Return settings in flat format (default: false)", - "name": "flat_settings", + "name": "last_access_control_sync_error", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", - "name": "ignore_unavailable", + "name": "last_access_control_sync_scheduled_at", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Return local information, do not retrieve the state from master node (default: false)", - "name": "local", + "name": "last_access_control_sync_status", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SyncStatus", + "namespace": "connector._types" } } }, { - "description": "Specify timeout for connection to master", - "name": "master_timeout", + "name": "last_deleted_document_count", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "description": "Wait for the metadata version to be equal or greater than the specified metadata version", - "name": "wait_for_metadata_version", + "name": "last_incremental_sync_scheduled_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The maximum time to wait for wait_for_metadata_version before timing out", - "name": "wait_for_timeout", + "name": "last_indexed_document_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } - } - ], - "specLocation": "cluster/state/ClusterStateRequest.ts#L29-L56" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "user_defined_value" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.state" - }, - "specLocation": "cluster/state/ClusterStateResponse.ts#L22-L29" - }, - { - "kind": "interface", - "name": { - "name": "CharFilterTypes", - "namespace": "cluster.stats" - }, - "properties": [ + }, { - "description": "Contains statistics about analyzer types used in selected nodes.", - "name": "analyzer_types", - "required": true, + "name": "last_seen", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about built-in analyzers used in selected nodes.", - "name": "built_in_analyzers", - "required": true, + "name": "last_sync_error", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about built-in character filters used in selected nodes.", - "name": "built_in_char_filters", - "required": true, + "name": "last_sync_scheduled_at", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about built-in token filters used in selected nodes.", - "name": "built_in_filters", - "required": true, + "name": "last_sync_status", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "SyncStatus", + "namespace": "connector._types" } } }, { - "description": "Contains statistics about built-in tokenizers used in selected nodes.", - "name": "built_in_tokenizers", - "required": true, + "name": "last_synced", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about character filter types used in selected nodes.", - "name": "char_filter_types", - "required": true, + "name": "name", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about token filter types used in selected nodes.", - "name": "filter_types", - "required": true, + "name": "pipeline", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "IngestPipelineParams", + "namespace": "connector._types" } } }, { - "description": "Contains statistics about tokenizer types used in selected nodes.", - "name": "tokenizer_types", + "name": "scheduling", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "SchedulingConfiguration", + "namespace": "connector._types" } } - } - ], - "specLocation": "cluster/stats/types.ts#L228-L261" - }, - { - "kind": "interface", - "name": { - "name": "ClusterFileSystem", - "namespace": "cluster.stats" - }, - "properties": [ + }, { - "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.", - "name": "available_in_bytes", + "name": "service_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Total number of unallocated bytes in file stores across all selected nodes.", - "name": "free_in_bytes", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ConnectorStatus", + "namespace": "connector._types" } } }, { - "description": "Total size, in bytes, of all file stores across all selected nodes.", - "name": "total_in_bytes", + "name": "sync_now", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/stats/types.ts#L34-L49" + "specLocation": "connector/_types/Connector.ts#L237-L266" }, { "kind": "interface", "name": { - "name": "ClusterIndices", - "namespace": "cluster.stats" + "name": "ConnectorConfigProperties", + "namespace": "connector._types" }, "properties": [ { - "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", - "name": "analysis", - "required": true, + "name": "category", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "CharFilterTypes", - "namespace": "cluster.stats" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about memory used for completion in selected nodes.", - "name": "completion", + "name": "default_value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "CompletionStats", + "name": "ScalarValue", "namespace": "_types" } } }, { - "description": "Total number of indices with shards assigned to selected nodes.", - "name": "count", + "name": "depends_on", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Dependency", + "namespace": "connector._types" + } } } }, { - "description": "Contains counts for documents in selected nodes.", - "name": "docs", + "name": "display", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DocStats", - "namespace": "_types" + "name": "DisplayType", + "namespace": "connector._types" } } }, { - "description": "Contains statistics about the field data cache of selected nodes.", - "docId": "modules-fielddata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-fielddata.html", - "name": "fielddata", + "name": "label", "required": true, "type": { "kind": "instance_of", "type": { - "name": "FielddataStats", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about the query cache of selected nodes.", - "name": "query_cache", + "name": "options", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "QueryCacheStats", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SelectOption", + "namespace": "connector._types" + } } } }, { - "description": "Contains statistics about segments in selected nodes.", - "name": "segments", - "required": true, + "name": "order", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SegmentsStats", + "name": "integer", "namespace": "_types" } } }, { - "description": "Contains statistics about indices with shards assigned to selected nodes.", - "name": "shards", - "required": true, + "name": "placeholder", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterIndicesShards", - "namespace": "cluster.stats" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about the size of shards assigned to selected nodes.", - "name": "store", + "name": "required", "required": true, "type": { "kind": "instance_of", "type": { - "name": "StoreStats", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about field mappings in selected nodes.", - "name": "mappings", + "name": "sensitive", "required": true, "type": { "kind": "instance_of", "type": { - "name": "FieldTypesMappings", - "namespace": "cluster.stats" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", - "docId": "analyzer-anatomy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analyzer-anatomy.html", - "name": "versions", + "name": "tooltip", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesVersions", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "cluster/stats/types.ts#L74-L107" - }, - { - "description": "Contains statistics about shards assigned to selected nodes.", - "kind": "interface", - "name": { - "name": "ClusterIndicesShards", - "namespace": "cluster.stats" - }, - "properties": [ + }, { - "description": "Contains statistics about shards assigned to selected nodes.", - "name": "index", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterIndicesShardsIndex", - "namespace": "cluster.stats" + "name": "ConnectorFieldType", + "namespace": "connector._types" } } }, { - "description": "Number of primary shards assigned to selected nodes.", - "name": "primaries", - "required": false, + "name": "ui_restrictions", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "Ratio of replica shards to primary shards across all selected nodes.", - "name": "replication", - "required": false, + "name": "validations", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Validation", + "namespace": "connector._types" + } } } }, { - "description": "Total number of shards assigned to selected nodes.", - "name": "total", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "ScalarValue", "namespace": "_types" } } } ], - "specLocation": "cluster/stats/types.ts#L60-L72" + "specLocation": "connector/_types/Connector.ts#L82-L98" }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "ClusterIndicesShardsIndex", - "namespace": "cluster.stats" + "name": "ConnectorConfiguration", + "namespace": "connector._types" }, - "properties": [ - { - "description": "Contains statistics about the number of primary shards assigned to selected nodes.", - "name": "primaries", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ClusterShardMetrics", - "namespace": "cluster.stats" - } - } - }, - { - "description": "Contains statistics about the number of replication shards assigned to selected nodes.", - "name": "replication", - "required": true, + "specLocation": "connector/_types/Connector.ts#L100-L103", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ClusterShardMetrics", - "namespace": "cluster.stats" - } + "name": "string", + "namespace": "_builtins" } }, - { - "description": "Contains statistics about the number of shards assigned to selected nodes.", - "name": "shards", - "required": true, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ClusterShardMetrics", - "namespace": "cluster.stats" - } + "name": "ConnectorConfigProperties", + "namespace": "connector._types" } } - ], - "specLocation": "cluster/stats/types.ts#L51-L58" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "ClusterIngest", - "namespace": "cluster.stats" + "name": "ConnectorCustomScheduling", + "namespace": "connector._types" }, - "properties": [ - { - "name": "number_of_pipelines", - "required": true, + "specLocation": "connector/_types/Connector.ts#L127-L127", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } }, - { - "name": "processor_stats", - "required": true, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterProcessor", - "namespace": "cluster.stats" - } - } + "name": "CustomScheduling", + "namespace": "connector._types" } } - ], - "specLocation": "cluster/stats/types.ts#L270-L273" + } }, { "kind": "interface", "name": { - "name": "ClusterJvm", - "namespace": "cluster.stats" + "name": "ConnectorFeatures", + "namespace": "connector._types" }, "properties": [ { - "description": "Uptime duration, in milliseconds, since JVM last started.", - "name": "max_uptime_in_millis", - "required": true, + "name": "document_level_security", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "FeatureEnabled", + "namespace": "connector._types" + } + } + }, + { + "name": "filtering_advanced_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about memory used by selected nodes.", - "name": "mem", - "required": true, + "name": "filtering_rules", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterJvmMemory", - "namespace": "cluster.stats" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Number of active threads in use by JVM across all selected nodes.", - "name": "threads", - "required": true, + "name": "incremental_sync", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "FeatureEnabled", + "namespace": "connector._types" } } }, { - "description": "Contains statistics about the JVM versions used by selected nodes.", - "name": "versions", - "required": true, + "name": "sync_rules", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterJvmVersion", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "SyncRulesFeature", + "namespace": "connector._types" } } } ], - "specLocation": "cluster/stats/types.ts#L275-L292" + "specLocation": "connector/_types/Connector.ts#L223-L229" + }, + { + "kind": "enum", + "members": [ + { + "name": "str" + }, + { + "name": "int" + }, + { + "name": "list" + }, + { + "name": "bool" + } + ], + "name": { + "name": "ConnectorFieldType", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L42-L47" }, { "kind": "interface", "name": { - "name": "ClusterJvmMemory", - "namespace": "cluster.stats" + "name": "ConnectorScheduling", + "namespace": "connector._types" }, "properties": [ { - "description": "Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.", - "name": "heap_max_in_bytes", + "name": "enabled", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Memory, in bytes, currently in use by the heap across all selected nodes.", - "name": "heap_used_in_bytes", + "description": "The interval is expressed using the crontab syntax", + "name": "interval", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/stats/types.ts#L294-L303" + "specLocation": "connector/_types/Connector.ts#L105-L109" + }, + { + "kind": "enum", + "members": [ + { + "name": "created" + }, + { + "name": "needs_configuration" + }, + { + "name": "configured" + }, + { + "name": "connected" + }, + { + "name": "error" + } + ], + "name": { + "name": "ConnectorStatus", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L129-L135" }, { "kind": "interface", "name": { - "name": "ClusterJvmVersion", - "namespace": "cluster.stats" + "name": "CustomScheduling", + "namespace": "connector._types" }, "properties": [ { - "description": "Always `true`. All distributions come with a bundled Java Development Kit (JDK).", - "name": "bundled_jdk", + "name": "configuration_overrides", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "CustomSchedulingConfigurationOverrides", + "namespace": "connector._types" } } }, { - "description": "Total number of selected nodes using JVM.", - "name": "count", + "name": "enabled", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If `true`, a bundled JDK is in use by JVM.", - "name": "using_bundled_jdk", + "name": "interval", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Version of JVM used by one or more selected nodes.", - "name": "version", - "required": true, + "name": "last_synced", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Name of the JVM.", - "name": "vm_name", + "name": "name", "required": true, "type": { "kind": "instance_of", @@ -103015,238 +106317,313 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "connector/_types/Connector.ts#L119-L125" + }, + { + "kind": "interface", + "name": { + "name": "CustomSchedulingConfigurationOverrides", + "namespace": "connector._types" + }, + "properties": [ { - "description": "Vendor of the JVM.", - "name": "vm_vendor", - "required": true, + "name": "max_crawl_depth", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Full version number of JVM.\nThe full version number includes a plus sign (+) followed by the build number.", - "name": "vm_version", - "required": true, + "name": "sitemap_discovery_disabled", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "cluster/stats/types.ts#L305-L335" - }, - { - "kind": "interface", - "name": { - "name": "ClusterNetworkTypes", - "namespace": "cluster.stats" - }, - "properties": [ + }, { - "description": "Contains statistics about the HTTP network types used by selected nodes.", - "name": "http_types", - "required": true, + "name": "domain_allowlist", + "required": false, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } } } }, { - "description": "Contains statistics about the transport network types used by selected nodes.", - "name": "transport_types", - "required": true, + "name": "sitemap_urls", + "required": false, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - "kind": "dictionary_of", - "singleKey": false, + } + } + }, + { + "name": "seed_urls", + "required": false, + "type": { + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } } ], - "specLocation": "cluster/stats/types.ts#L337-L346" + "specLocation": "connector/_types/Connector.ts#L111-L117" }, { "kind": "interface", "name": { - "name": "ClusterNodeCount", - "namespace": "cluster.stats" + "name": "Dependency", + "namespace": "connector._types" }, "properties": [ { - "name": "coordinating_only", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "data", + "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ScalarValue", "namespace": "_types" } } + } + ], + "specLocation": "connector/_types/Connector.ts#L29-L32" + }, + { + "kind": "enum", + "members": [ + { + "name": "textbox" }, { - "name": "data_cold", + "name": "textarea" + }, + { + "name": "numeric" + }, + { + "name": "toggle" + }, + { + "name": "dropdown" + } + ], + "name": { + "name": "DisplayType", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L34-L40" + }, + { + "kind": "interface", + "name": { + "name": "FeatureEnabled", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "enabled", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "connector/_types/Connector.ts#L214-L216" + }, + { + "kind": "interface", + "name": { + "name": "FilteringAdvancedSnippet", + "namespace": "connector._types" + }, + "properties": [ { - "name": "data_content", + "name": "created_at", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.13.0" - } - }, - "name": "data_frozen", - "required": false, - "since": "7.13.0", + "name": "updated_at", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "data_hot", + "name": "value", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } - }, + } + ], + "specLocation": "connector/_types/Connector.ts#L191-L195" + }, + { + "kind": "interface", + "name": { + "name": "FilteringConfig", + "namespace": "connector._types" + }, + "properties": [ { - "name": "data_warm", + "name": "active", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "FilteringRules", + "namespace": "connector._types" } } }, { - "name": "ingest", + "name": "domain", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "master", + "name": "draft", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "FilteringRules", + "namespace": "connector._types" } } + } + ], + "specLocation": "connector/_types/Connector.ts#L208-L212" + }, + { + "kind": "enum", + "members": [ + { + "name": "exclude" }, { - "name": "ml", + "name": "include" + } + ], + "name": { + "name": "FilteringPolicy", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L154-L157" + }, + { + "kind": "interface", + "name": { + "name": "FilteringRule", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "created_at", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "remote_cluster_client", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "total", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "transform", + "name": "order", "required": true, "type": { "kind": "instance_of", @@ -103257,638 +106634,1018 @@ } }, { - "name": "voting_only", + "name": "policy", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "FilteringPolicy", + "namespace": "connector._types" } } - } - ], - "specLocation": "cluster/stats/types.ts#L348-L367" - }, - { - "kind": "interface", - "name": { - "name": "ClusterNodes", - "namespace": "cluster.stats" - }, - "properties": [ + }, { - "description": "Contains counts for nodes selected by the request’s node filters.", - "name": "count", + "name": "rule", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterNodeCount", - "namespace": "cluster.stats" + "name": "FilteringRuleRule", + "namespace": "connector._types" } } }, { - "description": "Contains statistics about the discovery types used by selected nodes.", - "docId": "modules-discovery-hosts-providers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-discovery-hosts-providers.html", - "name": "discovery_types", + "name": "updated_at", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about file stores by selected nodes.", - "name": "fs", + "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterFileSystem", - "namespace": "cluster.stats" + "name": "string", + "namespace": "_builtins" } } + } + ], + "specLocation": "connector/_types/Connector.ts#L169-L178" + }, + { + "kind": "enum", + "members": [ + { + "name": "contains" }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "indexing_pressure", + "name": "ends_with" + }, + { + "name": "equals" + }, + { + "name": "regex" + }, + { + "name": "starts_with" + }, + { + "codegenName": "greater_than", + "name": ">" + }, + { + "codegenName": "less_than", + "name": "<" + } + ], + "name": { + "name": "FilteringRuleRule", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L159-L167" + }, + { + "kind": "interface", + "name": { + "name": "FilteringRules", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "advanced_snippet", "required": true, - "since": "7.16.0", "type": { "kind": "instance_of", "type": { - "name": "IndexingPressure", - "namespace": "cluster.stats" + "name": "FilteringAdvancedSnippet", + "namespace": "connector._types" } } }, { - "name": "ingest", + "name": "rules", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "ClusterIngest", - "namespace": "cluster.stats" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FilteringRule", + "namespace": "connector._types" + } } } }, { - "description": "Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.", - "name": "jvm", + "name": "validation", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterJvm", - "namespace": "cluster.stats" + "name": "FilteringRulesValidation", + "namespace": "connector._types" } } - }, + } + ], + "specLocation": "connector/_types/Connector.ts#L202-L206" + }, + { + "kind": "interface", + "name": { + "name": "FilteringRulesValidation", + "namespace": "connector._types" + }, + "properties": [ { - "description": "Contains statistics about the transport and HTTP networks used by selected nodes.", - "name": "network_types", + "name": "errors", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "ClusterNetworkTypes", - "namespace": "cluster.stats" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FilteringValidation", + "namespace": "connector._types" + } } } }, { - "description": "Contains statistics about the operating systems used by selected nodes.", - "name": "os", + "name": "state", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterOperatingSystem", - "namespace": "cluster.stats" + "name": "FilteringValidationState", + "namespace": "connector._types" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L197-L200" + }, + { + "kind": "interface", + "name": { + "name": "FilteringValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "ids", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "Contains statistics about Elasticsearch distributions installed on selected nodes.", - "name": "packaging_types", + "name": "messages", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "NodePackagingType", - "namespace": "cluster.stats" + "name": "string", + "namespace": "_builtins" } } } + } + ], + "specLocation": "connector/_types/Connector.ts#L180-L183" + }, + { + "kind": "enum", + "members": [ + { + "name": "edited" }, { - "description": "Contains statistics about installed plugins and modules by selected nodes.\nIf no plugins or modules are installed, this array is empty.", - "name": "plugins", + "name": "invalid" + }, + { + "name": "valid" + } + ], + "name": { + "name": "FilteringValidationState", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L185-L189" + }, + { + "kind": "interface", + "name": { + "name": "GreaterThanValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PluginStats", - "namespace": "_types" - } - } + "kind": "literal_value", + "value": "\"greater_than\"" } }, { - "description": "Contains statistics about processes used by selected nodes.", - "name": "process", + "name": "constraint", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterProcess", - "namespace": "cluster.stats" + "name": "double", + "namespace": "_types" } } + } + ], + "specLocation": "connector/_types/Connector.ts#L62-L65" + }, + { + "kind": "interface", + "name": { + "name": "IncludedInValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "\"included_in\"" + } }, { - "description": "Array of Elasticsearch versions used on selected nodes.", - "name": "versions", + "name": "constraint", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/stats/types.ts#L369-L402" + "specLocation": "connector/_types/Connector.ts#L72-L75" }, { "kind": "interface", "name": { - "name": "ClusterOperatingSystem", - "namespace": "cluster.stats" + "name": "IngestPipelineParams", + "namespace": "connector._types" }, "properties": [ { - "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.", - "name": "allocated_processors", + "name": "extract_binary_content", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.", - "name": "architectures", - "required": false, + "name": "name", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterOperatingSystemArchitecture", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Number of processors available to JVM across all selected nodes.", - "name": "available_processors", + "name": "reduce_whitespace", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about memory used by selected nodes.", - "name": "mem", + "name": "run_ml_inference", "required": true, "type": { "kind": "instance_of", "type": { - "name": "OperatingSystemMemoryInfo", - "namespace": "cluster.stats" + "name": "boolean", + "namespace": "_builtins" } } + } + ], + "specLocation": "connector/_types/Connector.ts#L147-L152" + }, + { + "kind": "interface", + "name": { + "name": "LessThanValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "\"less_than\"" + } }, { - "description": "Contains statistics about operating systems used by selected nodes.", - "name": "names", + "name": "constraint", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterOperatingSystemName", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } + } + ], + "specLocation": "connector/_types/Connector.ts#L57-L60" + }, + { + "kind": "interface", + "name": { + "name": "ListTypeValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "\"list_type\"" + } }, { - "description": "Contains statistics about operating systems used by selected nodes.", - "name": "pretty_names", + "name": "constraint", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ClusterOperatingSystemPrettyName", - "namespace": "cluster.stats" + "name": "ScalarValue", + "namespace": "_types" } } } } ], - "specLocation": "cluster/stats/types.ts#L415-L442" + "specLocation": "connector/_types/Connector.ts#L67-L70" }, { "kind": "interface", "name": { - "name": "ClusterOperatingSystemArchitecture", - "namespace": "cluster.stats" + "name": "RegexValidation", + "namespace": "connector._types" }, "properties": [ { - "description": "Name of an architecture used by one or more selected nodes.", - "name": "arch", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "\"regex\"" } }, { - "description": "Number of selected nodes using the architecture.", - "name": "count", + "name": "constraint", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/stats/types.ts#L404-L413" + "specLocation": "connector/_types/Connector.ts#L77-L80" }, { "kind": "interface", "name": { - "name": "ClusterOperatingSystemName", - "namespace": "cluster.stats" + "name": "SchedulingConfiguration", + "namespace": "connector._types" }, "properties": [ { - "description": "Number of selected nodes using the operating system.", - "name": "count", - "required": true, + "name": "access_control", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ConnectorScheduling", + "namespace": "connector._types" } } }, { - "description": "Name of an operating system used by one or more selected nodes.", - "name": "name", - "required": true, + "name": "full", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "ConnectorScheduling", + "namespace": "connector._types" + } + } + }, + { + "name": "incremental", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ConnectorScheduling", + "namespace": "connector._types" } } } ], - "specLocation": "cluster/stats/types.ts#L444-L453" + "specLocation": "connector/_types/Connector.ts#L231-L235" }, { "kind": "interface", "name": { - "name": "ClusterOperatingSystemPrettyName", - "namespace": "cluster.stats" + "name": "SelectOption", + "namespace": "connector._types" }, "properties": [ { - "description": "Number of selected nodes using the operating system.", - "name": "count", + "name": "label", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Human-readable name of an operating system used by one or more selected nodes.", - "name": "pretty_name", + "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/stats/types.ts#L455-L464" + "specLocation": "connector/_types/Connector.ts#L24-L27" }, { "kind": "interface", "name": { - "name": "ClusterProcess", - "namespace": "cluster.stats" + "name": "SyncRulesFeature", + "namespace": "connector._types" }, "properties": [ { - "description": "Contains statistics about CPU used by selected nodes.", - "name": "cpu", - "required": true, + "name": "advanced", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterProcessCpu", - "namespace": "cluster.stats" + "name": "FeatureEnabled", + "namespace": "connector._types" } } }, { - "description": "Contains statistics about open file descriptors in selected nodes.", - "name": "open_file_descriptors", - "required": true, + "name": "basic", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterProcessOpenFileDescriptors", - "namespace": "cluster.stats" + "name": "FeatureEnabled", + "namespace": "connector._types" } } } ], - "specLocation": "cluster/stats/types.ts#L466-L475" + "specLocation": "connector/_types/Connector.ts#L218-L221" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "canceling" + }, + { + "name": "canceled" + }, + { + "name": "completed" + }, + { + "name": "error" + }, + { + "name": "in_progress" + }, + { + "name": "pending" + }, + { + "name": "suspended" + } + ], "name": { - "name": "ClusterProcessCpu", - "namespace": "cluster.stats" + "name": "SyncStatus", + "namespace": "connector._types" }, - "properties": [ - { - "description": "Percentage of CPU used across all selected nodes.\nReturns `-1` if not supported.", - "name": "percent", - "required": true, - "type": { + "specLocation": "connector/_types/Connector.ts#L137-L145" + }, + { + "kind": "type_alias", + "name": { + "name": "Validation", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L49-L55", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "LessThanValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GreaterThanValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ListTypeValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IncludedInValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RegexValidation", + "namespace": "connector._types" } } - } - ], - "specLocation": "cluster/stats/types.ts#L477-L483" + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "type" + } }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Updates the last_seen field in the connector, and sets it to current timestamp", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ClusterProcessOpenFileDescriptors", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "connector.check_in" }, - "properties": [ + "path": [ { - "description": "Average number of concurrently open file descriptors.\nReturns `-1` if not supported.", - "name": "avg", + "description": "The unique identifier of the connector to be checked in", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, - { - "description": "Maximum number of concurrently open file descriptors allowed across all selected nodes.\nReturns `-1` if not supported.", - "name": "max", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/check_in/ConnectorCheckInRequest.ts#L22-L36" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.check_in" + }, + "specLocation": "connector/check_in/ConnectorCheckInResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes a connector.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.delete" + }, + "path": [ { - "description": "Minimum number of concurrently open file descriptors across all selected nodes.\nReturns -1 if not supported.", - "name": "min", + "description": "The unique identifier of the connector to be deleted", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "cluster/stats/types.ts#L485-L501" + "query": [], + "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L36" }, { - "kind": "interface", + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", "name": { - "name": "ClusterProcessor", - "namespace": "cluster.stats" + "name": "Response", + "namespace": "connector.delete" }, - "properties": [ + "specLocation": "connector/delete/ConnectorDeleteResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves a connector.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.get" + }, + "path": [ { - "name": "count", + "description": "The unique identifier of the connector", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, - { - "name": "current", - "required": true, + } + ], + "query": [], + "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L36" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", + "name": "Connector", + "namespace": "connector._types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.get" + }, + "specLocation": "connector/get/ConnectorGetResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "last_access_control_sync_error", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + }, + { + "name": "last_access_control_sync_scheduled_at", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_access_control_sync_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncStatus", + "namespace": "connector._types" + } + } + }, + { + "name": "last_deleted_document_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "last_incremental_sync_scheduled_at", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_indexed_document_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "last_seen", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + }, + { + "name": "last_sync_error", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } } - } - }, - { - "name": "failed", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "last_sync_scheduled_at", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "name": "time", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "last_sync_status", + "required": false, "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "SyncStatus", + "namespace": "connector._types" } - ], - "kind": "instance_of", + } + }, + { + "name": "last_synced", + "required": false, "type": { - "name": "DurationValue", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } + ] + }, + "description": "Updates last sync stats in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ], - "specLocation": "cluster/stats/types.ts#L503-L509" - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "ClusterShardMetrics", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "connector.last_sync" }, - "properties": [ - { - "description": "Mean number of shards in an index, counting only shards assigned to selected nodes.", - "name": "avg", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "description": "Maximum number of shards in an index, counting only shards assigned to selected nodes.", - "name": "max", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, + "path": [ { - "description": "Minimum number of shards in an index, counting only shards assigned to selected nodes.", - "name": "min", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "cluster/stats/types.ts#L511-L524" + "query": [], + "specLocation": "connector/last_sync/ConnectorUpdateLastSyncRequest.ts#L25-L55" }, { - "kind": "interface", - "name": { - "name": "FieldTypes", - "namespace": "cluster.stats" - }, - "properties": [ - { - "description": "The name for the field type in selected nodes.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "Name", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.last_sync" + }, + "specLocation": "connector/last_sync/ConnectorUpdateLastSyncResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns existing connectors.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.list" + }, + "path": [], + "query": [ { - "description": "The number of occurrences of the field type in selected nodes.", - "name": "count", - "required": true, + "description": "Starting offset (default: 0)", + "name": "from", + "required": false, "type": { "kind": "instance_of", "type": { @@ -103898,9 +107655,9 @@ } }, { - "description": "The number of indices containing the field type in selected nodes.", - "name": "index_count", - "required": true, + "description": "Specifies a max number of results to get", + "name": "size", + "required": false, "type": { "kind": "instance_of", "type": { @@ -103910,510 +107667,893 @@ } }, { - "description": "For dense_vector field types, number of indexed vector types in selected nodes.", - "name": "indexed_vector_count", + "description": "A comma-separated list of connector index names to fetch connector documents for", + "name": "index_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Indices", "namespace": "_types" } } }, { - "description": "For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.", - "name": "indexed_vector_dim_max", + "description": "A comma-separated list of connector names to fetch connector documents for", + "name": "connector_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Names", "namespace": "_types" } } }, { - "description": "For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.", - "name": "indexed_vector_dim_min", + "description": "A comma-separated list of connector service types to fetch connector documents for", + "name": "service_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Names", "namespace": "_types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.13.0" - } - }, - "description": "The number of fields that declare a script.", - "name": "script_count", + "description": "A wildcard query string that filters connectors with matching name, description or index name", + "name": "query", "required": false, - "since": "7.13.0", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "cluster/stats/types.ts#L136-L167" + "specLocation": "connector/list/ConnectorListRequest.ts#L23-L57" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "results", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Connector", + "namespace": "connector._types" + } + } + } + } + ] + }, + "kind": "response", "name": { - "name": "FieldTypesMappings", - "namespace": "cluster.stats" + "name": "Response", + "namespace": "connector.list" }, - "properties": [ - { - "description": "Contains statistics about field data types used in selected nodes.", - "name": "field_types", - "required": true, - "type": { - "kind": "array_of", - "value": { + "specLocation": "connector/list/ConnectorListResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "description", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" + "name": "string", + "namespace": "_builtins" } } - } - }, - { - "description": "Contains statistics about runtime field data types used in selected nodes.", - "name": "runtime_field_types", - "required": false, - "type": { - "kind": "array_of", - "value": { + }, + { + "name": "index_name", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "RuntimeFieldTypes", - "namespace": "cluster.stats" + "name": "WithNullValue", + "namespace": "_spec_utils" } } - } - }, - { - "description": "Total number of fields in all non-system indices.", - "name": "total_field_count", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "is_native", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "description": "Total number of fields in all non-system indices, accounting for mapping deduplication.", - "name": "total_deduplicated_field_count", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "language", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "description": "Total size of all mappings after deduplication and compression.", - "name": "total_deduplicated_mapping_size", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "name", + "required": false, "type": { - "name": "ByteSize", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "description": "Total size of all mappings, in bytes, after deduplication and compression.", - "name": "total_deduplicated_mapping_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "service_type", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } + ] + }, + "description": "Creates a connector.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ], - "specLocation": "cluster/stats/types.ts#L109-L134" - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "IndexingPressure", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "connector.post" }, - "properties": [ - { - "name": "memory", - "required": true, - "type": { - "kind": "instance_of", + "path": [], + "query": [], + "specLocation": "connector/post/ConnectorPostRequest.ts#L22-L42" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "id", + "required": true, "type": { - "name": "IndexingPressureMemory", - "namespace": "cluster.stats" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } } - } - ], - "specLocation": "cluster/stats/types.ts#L570-L572" - }, - { - "kind": "interface", + ] + }, + "kind": "response", "name": { - "name": "IndexingPressureMemory", - "namespace": "cluster.stats" + "name": "Response", + "namespace": "connector.post" }, - "properties": [ - { - "name": "current", - "required": true, - "type": { - "kind": "instance_of", + "specLocation": "connector/post/ConnectorPostResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "description", + "required": false, "type": { - "name": "IndexingPressureMemorySummary", - "namespace": "cluster.stats" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "name": "limit_in_bytes", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "index_name", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } } - } - }, - { - "name": "total", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "is_native", + "required": false, "type": { - "name": "IndexingPressureMemorySummary", - "namespace": "cluster.stats" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "language", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "service_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } + ] + }, + "description": "Creates or updates a connector.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ], - "specLocation": "cluster/stats/types.ts#L574-L578" - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "IndexingPressureMemorySummary", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "connector.put" }, - "properties": [ + "path": [ { - "name": "all_in_bytes", + "description": "The unique identifier of the connector to be created or updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, - { - "name": "combined_coordinating_and_primary_in_bytes", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/put/ConnectorPutRequest.ts#L23-L49" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "name": "coordinating_in_bytes", - "required": true, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.put" + }, + "specLocation": "connector/put/ConnectorPutResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "api_key_id", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } } - } - }, - { - "name": "coordinating_rejections", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "api_key_secret_id", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } } } - }, + ] + }, + "description": "Updates the API key id in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_api_key_id" + }, + "path": [ { - "name": "primary_in_bytes", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, - { - "name": "primary_rejections", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "name": "replica_in_bytes", - "required": true, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_api_key_id" + }, + "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "configuration", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "ConnectorConfiguration", + "namespace": "connector._types" + } } - } - }, - { - "name": "replica_rejections", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "values", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } } } + ] + }, + "description": "Updates the configuration field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ], - "specLocation": "cluster/stats/types.ts#L580-L589" - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "IndicesVersions", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "connector.update_configuration" }, - "properties": [ + "path": [ { - "name": "index_count", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } - }, - { - "name": "primary_shard_count", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L47" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "name": "total_primary_bytes", - "required": true, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_configuration" + }, + "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "error", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } } } - }, + ] + }, + "description": "Updates the filtering field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_error" + }, + "path": [ { - "name": "version", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "cluster/stats/types.ts#L263-L268" + "query": [], + "specLocation": "connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L44" }, { - "kind": "interface", - "name": { - "name": "NodePackagingType", - "namespace": "cluster.stats" - }, - "properties": [ - { - "description": "Number of selected nodes using the distribution flavor and file type.", - "name": "count", - "required": true, - "type": { - "kind": "instance_of", + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "description": "Type of Elasticsearch distribution. This is always `default`.", - "name": "flavor", - "required": true, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_error" + }, + "specLocation": "connector/update_error/ConnectorUpdateErrorResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "filtering", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FilteringConfig", + "namespace": "connector._types" + } + } } } - }, + ] + }, + "description": "Updates the filtering field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_filtering" + }, + "path": [ { - "description": "File type (such as `tar` or `zip`) used for the distribution package.", - "name": "type", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } } ], - "specLocation": "cluster/stats/types.ts#L526-L539" + "query": [], + "specLocation": "connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L23-L44" }, { - "kind": "interface", - "name": { - "name": "OperatingSystemMemoryInfo", - "namespace": "cluster.stats" - }, - "properties": [ - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "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.", - "name": "adjusted_total_in_bytes", - "required": false, - "since": "7.16.0", - "type": { - "kind": "instance_of", + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "description": "Amount, in bytes, of free physical memory across all selected nodes.", - "name": "free_in_bytes", - "required": true, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_filtering" + }, + "specLocation": "connector/update_filtering/ConnectorUpdateFilteringResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "index_name", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } } } - }, + ] + }, + "description": "Updates the index_name in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_index_name" + }, + "path": [ { - "description": "Percentage of free physical memory across all selected nodes.", - "name": "free_percent", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } - }, - { - "description": "Total amount, in bytes, of physical memory across all selected nodes.", - "name": "total_in_bytes", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "description": "Amount, in bytes, of physical memory in use across all selected nodes.", - "name": "used_in_bytes", - "required": true, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_index_name" + }, + "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "name", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, + ] + }, + "description": "Updates the name and description fields in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_name" + }, + "path": [ { - "description": "Percentage of physical memory in use across all selected nodes.", - "name": "used_percent", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "cluster/stats/types.ts#L541-L568" + "query": [], + "specLocation": "connector/update_name/ConnectorUpdateNameRequest.ts#L22-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_name" + }, + "specLocation": "connector/update_name/ConnectorUpdateNameResponse.ts#L22-L26" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "name": "is_native", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] }, - "description": "Returns cluster statistics.\nIt returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).", + "description": "Updates the is_native flag in the connector document", "inherits": { "type": { "name": "RequestBase", @@ -104423,155 +108563,206 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.stats" + "namespace": "connector.update_native" }, "path": [ { - "description": "Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.", - "name": "node_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeIds", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "If `true`, returns settings in flat format.", - "name": "flat_settings", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its stats.\nHowever, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout.", - "name": "timeout", - "required": false, + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "cluster/stats/ClusterStatsRequest.ts#L24-L50" + "query": [], + "specLocation": "connector/update_native/ConnectorUpdateNativeRequest.ts#L22-L42" }, { "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "StatsResponseBase", - "namespace": "cluster.stats" + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } } - } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "cluster.stats" + "namespace": "connector.update_native" }, - "specLocation": "cluster/stats/ClusterStatsResponse.ts#L53-L55" + "specLocation": "connector/update_native/ConnectorUpdateNativeResponse.ts#L22-L26" }, { - "kind": "interface", - "name": { - "name": "RuntimeFieldTypes", - "namespace": "cluster.stats" - }, - "properties": [ - { - "description": "Maximum number of characters for a single runtime field script.", - "name": "chars_max", - "required": true, - "type": { - "kind": "instance_of", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "pipeline", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "IngestPipelineParams", + "namespace": "connector._types" + } } } - }, + ] + }, + "description": "Updates the pipeline field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_pipeline" + }, + "path": [ { - "description": "Total number of characters for the scripts that define the current runtime field data type.", - "name": "chars_total", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } - }, - { - "description": "Number of runtime fields mapped to the field data type in selected nodes.", - "name": "count", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "description": "Maximum number of accesses to doc_values for a single runtime field script", - "name": "doc_max", - "required": true, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_pipeline" + }, + "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "scheduling", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "SchedulingConfiguration", + "namespace": "connector._types" + } } } - }, + ] + }, + "description": "Updates the scheduling field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_scheduling" + }, + "path": [ { - "description": "Total number of accesses to doc_values for the scripts that define the current runtime field data type.", - "name": "doc_total", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } - }, - { - "description": "Number of indices containing a mapping of the runtime field data type in selected nodes.", - "name": "index_count", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "description": "Script languages used for the runtime fields scripts.", - "name": "lang", - "required": true, - "type": { - "kind": "array_of", - "value": { + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_scheduling" + }, + "specLocation": "connector/update_scheduling/ConnectorUpdateSchedulingResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "service_type", + "required": true, + "type": { "kind": "instance_of", "type": { "name": "string", @@ -104579,183 +108770,133 @@ } } } - }, - { - "description": "Maximum number of lines for a single runtime field script.", - "name": "lines_max", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Total number of lines for the scripts that define the current runtime field data type.", - "name": "lines_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Field data type used in selected nodes.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "description": "Number of runtime fields that don’t declare a script.", - "name": "scriptless_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Number of runtime fields that shadow an indexed field.", - "name": "shadowed_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Maximum number of accesses to _source for a single runtime field script.", - "name": "source_max", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Total number of accesses to _source for the scripts that define the current runtime field data type.", - "name": "source_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ], - "specLocation": "cluster/stats/types.ts#L169-L226" - }, - { + ] + }, + "description": "Updates the service type of the connector", "inherits": { "type": { - "name": "NodesResponseBase", - "namespace": "nodes._types" + "name": "RequestBase", + "namespace": "_types" } }, - "kind": "interface", + "kind": "request", "name": { - "name": "StatsResponseBase", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "connector.update_service_type" }, - "properties": [ - { - "description": "Name of the cluster, based on the cluster name setting.", - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, + "path": [ { - "description": "Unique identifier for the cluster.", - "name": "cluster_uuid", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Uuid", + "name": "Id", "namespace": "_types" } } - }, - { - "description": "Contains statistics about indices with shards assigned to selected nodes.", - "name": "indices", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts#L22-L42" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "ClusterIndices", - "namespace": "cluster.stats" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - }, - { - "description": "Contains statistics about nodes selected by the request’s node filters.", - "docId": "cluster-nodes", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html#cluster-nodes", - "name": "nodes", - "required": true, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_service_type" + }, + "specLocation": "connector/update_service_type/ConnectorUpdateServiceTypeResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "status", + "required": true, "type": { - "name": "ClusterNodes", - "namespace": "cluster.stats" + "kind": "instance_of", + "type": { + "name": "ConnectorStatus", + "namespace": "connector._types" + } } } - }, + ] + }, + "description": "Updates the status of the connector", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_status" + }, + "path": [ { - "description": "Health status of the cluster, based on the state of its primary and replica shards.", - "name": "status", + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "HealthStatus", + "name": "Id", "namespace": "_types" } } - }, - { - "description": "Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.", - "name": "timestamp", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "connector/update_status/ConnectorUpdateStatusRequest.ts#L23-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } } } - } - ], - "specLocation": "cluster/stats/ClusterStatsResponse.ts#L25-L51" + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_status" + }, + "specLocation": "connector/update_status/ConnectorUpdateStatusResponse.ts#L22-L26" }, { "attachedBehaviors": [ diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 23ec09bd7b..720eea3d87 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -482,6 +482,18 @@ "response definition cluster.put_component_template:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" ] }, + "connector.delete": { + "request": [], + "response": [ + "response definition connector.delete:Response / body / instance_of - Non-leaf type cannot be used here: '_types:AcknowledgedResponseBase'" + ] + }, + "connector.last_sync": { + "request": [ + "type_alias definition _spec_utils:WithNullValue / union_of / instance_of - No type definition for '_spec_utils:T'" + ], + "response": [] + }, "create": { "request": [], "response": [ diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 7b0732762e..dac1ae1944 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -2027,12 +2027,16 @@ export interface SpecUtilsBaseNode { transport_address: TransportAddress } +export type SpecUtilsNullValue = null + export type SpecUtilsPipeSeparatedFlags = T | string export type SpecUtilsStringified = T | string export type SpecUtilsVoid = void +export type SpecUtilsWithNullValue = T | SpecUtilsNullValue + export interface AcknowledgedResponseBase { acknowledged: boolean } @@ -9066,6 +9070,410 @@ export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase { timestamp: long } +export interface ConnectorConnector { + api_key_id?: string + configuration: ConnectorConnectorConfiguration + custom_scheduling: ConnectorConnectorCustomScheduling + description?: string + error?: string + features: ConnectorConnectorFeatures + filtering: ConnectorFilteringConfig[] + id?: Id + index_name?: string + is_native: boolean + language?: string + last_access_control_sync_error?: string + last_access_control_sync_scheduled_at?: string + last_access_control_sync_status?: ConnectorSyncStatus + last_deleted_document_count?: long + last_incremental_sync_scheduled_at?: string + last_indexed_document_count?: long + last_seen?: string + last_sync_error?: string + last_sync_scheduled_at?: string + last_sync_status?: ConnectorSyncStatus + last_synced?: string + name?: string + pipeline?: ConnectorIngestPipelineParams + scheduling: ConnectorSchedulingConfiguration + service_type: string + status: ConnectorConnectorStatus + sync_now: boolean +} + +export interface ConnectorConnectorConfigProperties { + category?: string + default_value: ScalarValue + depends_on: ConnectorDependency[] + display: ConnectorDisplayType + label: string + options: ConnectorSelectOption[] + order?: integer + placeholder?: string + required: boolean + sensitive: boolean + tooltip?: string + type: ConnectorConnectorFieldType + ui_restrictions: string[] + validations: ConnectorValidation[] + value: ScalarValue +} + +export type ConnectorConnectorConfiguration = Record + +export type ConnectorConnectorCustomScheduling = Record + +export interface ConnectorConnectorFeatures { + document_level_security?: ConnectorFeatureEnabled + filtering_advanced_config?: boolean + filtering_rules?: boolean + incremental_sync?: ConnectorFeatureEnabled + sync_rules?: ConnectorSyncRulesFeature +} + +export type ConnectorConnectorFieldType = 'str' | 'int' | 'list' | 'bool' + +export interface ConnectorConnectorScheduling { + enabled: boolean + interval: string +} + +export type ConnectorConnectorStatus = 'created' | 'needs_configuration' | 'configured' | 'connected' | 'error' + +export interface ConnectorCustomScheduling { + configuration_overrides: ConnectorCustomSchedulingConfigurationOverrides + enabled: boolean + interval: string + last_synced?: string + name: string +} + +export interface ConnectorCustomSchedulingConfigurationOverrides { + max_crawl_depth?: integer + sitemap_discovery_disabled?: boolean + domain_allowlist?: string[] + sitemap_urls?: string[] + seed_urls?: string[] +} + +export interface ConnectorDependency { + field: string + value: ScalarValue +} + +export type ConnectorDisplayType = 'textbox' | 'textarea' | 'numeric' | 'toggle' | 'dropdown' + +export interface ConnectorFeatureEnabled { + enabled: boolean +} + +export interface ConnectorFilteringAdvancedSnippet { + created_at: string + updated_at: string + value: Record +} + +export interface ConnectorFilteringConfig { + active: ConnectorFilteringRules + domain: string + draft: ConnectorFilteringRules +} + +export type ConnectorFilteringPolicy = 'exclude' | 'include' + +export interface ConnectorFilteringRule { + created_at: string + field: string + id: string + order: integer + policy: ConnectorFilteringPolicy + rule: ConnectorFilteringRuleRule + updated_at: string + value: string +} + +export type ConnectorFilteringRuleRule = 'contains' | 'ends_with' | 'equals' | 'regex' | 'starts_with' | '>' | '<' + +export interface ConnectorFilteringRules { + advanced_snippet: ConnectorFilteringAdvancedSnippet + rules: ConnectorFilteringRule[] + validation: ConnectorFilteringRulesValidation +} + +export interface ConnectorFilteringRulesValidation { + errors: ConnectorFilteringValidation[] + state: ConnectorFilteringValidationState +} + +export interface ConnectorFilteringValidation { + ids: string[] + messages: string[] +} + +export type ConnectorFilteringValidationState = 'edited' | 'invalid' | 'valid' + +export interface ConnectorGreaterThanValidation { + type: '"greater_than"' + constraint: double +} + +export interface ConnectorIncludedInValidation { + type: '"included_in"' + constraint: string +} + +export interface ConnectorIngestPipelineParams { + extract_binary_content: boolean + name: string + reduce_whitespace: boolean + run_ml_inference: boolean +} + +export interface ConnectorLessThanValidation { + type: '"less_than"' + constraint: double +} + +export interface ConnectorListTypeValidation { + type: '"list_type"' + constraint: ScalarValue[] +} + +export interface ConnectorRegexValidation { + type: '"regex"' + constraint: string +} + +export interface ConnectorSchedulingConfiguration { + access_control?: ConnectorConnectorScheduling + full?: ConnectorConnectorScheduling + incremental?: ConnectorConnectorScheduling +} + +export interface ConnectorSelectOption { + label: string + value: string +} + +export interface ConnectorSyncRulesFeature { + advanced?: ConnectorFeatureEnabled + basic?: ConnectorFeatureEnabled +} + +export type ConnectorSyncStatus = 'canceling' | 'canceled' | 'completed' | 'error' | 'in_progress' | 'pending' | 'suspended' + +export type ConnectorValidation = ConnectorLessThanValidation | ConnectorGreaterThanValidation | ConnectorListTypeValidation | ConnectorIncludedInValidation | ConnectorRegexValidation + +export interface ConnectorCheckInRequest extends RequestBase { + connector_id: Id +} + +export interface ConnectorCheckInResponse { + result: Result +} + +export interface ConnectorDeleteRequest extends RequestBase { + connector_id: Id +} + +export type ConnectorDeleteResponse = AcknowledgedResponseBase + +export interface ConnectorGetRequest extends RequestBase { + connector_id: Id +} + +export type ConnectorGetResponse = ConnectorConnector + +export interface ConnectorLastSyncRequest extends RequestBase { + connector_id: Id + body?: { + last_access_control_sync_error?: SpecUtilsWithNullValue + last_access_control_sync_scheduled_at?: string + last_access_control_sync_status?: ConnectorSyncStatus + last_deleted_document_count?: long + last_incremental_sync_scheduled_at?: string + last_indexed_document_count?: long + last_seen?: SpecUtilsWithNullValue + last_sync_error?: SpecUtilsWithNullValue + last_sync_scheduled_at?: string + last_sync_status?: ConnectorSyncStatus + last_synced?: string + } +} + +export interface ConnectorLastSyncResponse { + result: Result +} + +export interface ConnectorListRequest extends RequestBase { + from?: integer + size?: integer + index_name?: Indices + connector_name?: Names + service_type?: Names + query?: string +} + +export interface ConnectorListResponse { + count: long + results: ConnectorConnector[] +} + +export interface ConnectorPostRequest extends RequestBase { + body?: { + description?: string + index_name: SpecUtilsWithNullValue + is_native?: boolean + language?: string + name?: string + service_type?: string + } +} + +export interface ConnectorPostResponse { + id: Id +} + +export interface ConnectorPutRequest extends RequestBase { + connector_id: Id + body?: { + description?: string + index_name: SpecUtilsWithNullValue + is_native?: boolean + language?: string + name?: string + service_type?: string + } +} + +export interface ConnectorPutResponse { + result: Result +} + +export interface ConnectorUpdateApiKeyIdRequest extends RequestBase { + connector_id: Id + body?: { + api_key_id?: SpecUtilsWithNullValue + api_key_secret_id?: SpecUtilsWithNullValue + } +} + +export interface ConnectorUpdateApiKeyIdResponse { + result: Result +} + +export interface ConnectorUpdateConfigurationRequest extends RequestBase { + connector_id: Id + body?: { + configuration?: ConnectorConnectorConfiguration + values?: Record + } +} + +export interface ConnectorUpdateConfigurationResponse { + result: Result +} + +export interface ConnectorUpdateErrorRequest extends RequestBase { + connector_id: Id + body?: { + error: SpecUtilsWithNullValue + } +} + +export interface ConnectorUpdateErrorResponse { + result: Result +} + +export interface ConnectorUpdateFilteringRequest extends RequestBase { + connector_id: Id + body?: { + filtering: ConnectorFilteringConfig[] + } +} + +export interface ConnectorUpdateFilteringResponse { + result: Result +} + +export interface ConnectorUpdateIndexNameRequest extends RequestBase { + connector_id: Id + body?: { + index_name: SpecUtilsWithNullValue + } +} + +export interface ConnectorUpdateIndexNameResponse { + result: Result +} + +export interface ConnectorUpdateNameRequest extends RequestBase { + connector_id: Id + body?: { + name: string + description?: string + } +} + +export interface ConnectorUpdateNameResponse { + result: Result +} + +export interface ConnectorUpdateNativeRequest extends RequestBase { + connector_id: Id + body?: { + is_native: boolean + } +} + +export interface ConnectorUpdateNativeResponse { + result: Result +} + +export interface ConnectorUpdatePipelineRequest extends RequestBase { + connector_id: Id + body?: { + pipeline: ConnectorIngestPipelineParams + } +} + +export interface ConnectorUpdatePipelineResponse { + result: Result +} + +export interface ConnectorUpdateSchedulingRequest extends RequestBase { + connector_id: Id + body?: { + scheduling: ConnectorSchedulingConfiguration + } +} + +export interface ConnectorUpdateSchedulingResponse { + result: Result +} + +export interface ConnectorUpdateServiceTypeRequest extends RequestBase { + connector_id: Id + body?: { + service_type: string + } +} + +export interface ConnectorUpdateServiceTypeResponse { + result: Result +} + +export interface ConnectorUpdateStatusRequest extends RequestBase { + connector_id: Id + body?: { + status: ConnectorConnectorStatus + } +} + +export interface ConnectorUpdateStatusResponse { + result: Result +} + export interface DanglingIndicesDeleteDanglingIndexRequest extends RequestBase { index_uuid: Uuid accept_data_loss: boolean diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 7d74196563..64814d7eb3 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -78,6 +78,24 @@ cluster-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/c cluster-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html common-options,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html +connector-checkin,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html +connector-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html +connector-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html +connector-last-sync,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html +connector-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html +connector-post,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html +connector-put,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html +connector-configuration,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-configuration-api.html +connector-update-api-key-id,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-api-key-id-api.html +connector-update-error,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-error-api.html +connector-update-filtering,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html +connector-update-index-name,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-index-name-api.html +connector-update-name,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-name-description-api.html +connector-update-native,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-native-api.html +connector-update-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-pipeline-api.html +connector-update-scheduling,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-scheduling-api.html +connector-update-service-type,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-service-type-api.html +connector-update-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-status-api.html convert-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/convert-processor.html cron-expressions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-cron-expressions csv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/csv-processor.html diff --git a/specification/_json_spec/connector.check_in.json b/specification/_json_spec/connector.check_in.json new file mode 100644 index 0000000000..eb81cad389 --- /dev/null +++ b/specification/_json_spec/connector.check_in.json @@ -0,0 +1,27 @@ +{ + "connector.check_in": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-api.html", + "description": "Updates the last_seen timestamp in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_check_in", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/connector.delete.json b/specification/_json_spec/connector.delete.json new file mode 100644 index 0000000000..bd0bd8de94 --- /dev/null +++ b/specification/_json_spec/connector.delete.json @@ -0,0 +1,27 @@ +{ + "connector.delete": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-api.html", + "description": "Deletes a connector." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}", + "methods": ["DELETE"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be deleted." + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/connector.get.json b/specification/_json_spec/connector.get.json new file mode 100644 index 0000000000..372267f8d6 --- /dev/null +++ b/specification/_json_spec/connector.get.json @@ -0,0 +1,27 @@ +{ + "connector.get": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-api.html", + "description": "Returns the details about a connector." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}", + "methods": ["GET"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be returned." + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/connector.last_sync.json b/specification/_json_spec/connector.last_sync.json new file mode 100644 index 0000000000..0ef4e37e5d --- /dev/null +++ b/specification/_json_spec/connector.last_sync.json @@ -0,0 +1,32 @@ +{ + "connector.last_sync": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-last-sync-api.html", + "description": "Updates the stats of last sync in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_last_sync", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "Object with stats related to the last connector sync run.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.list.json b/specification/_json_spec/connector.list.json new file mode 100644 index 0000000000..26670cb8e7 --- /dev/null +++ b/specification/_json_spec/connector.list.json @@ -0,0 +1,49 @@ +{ + "connector.list": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-api.html", + "description": "Lists all connectors." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector", + "methods": ["GET"] + } + ] + }, + "params": { + "from": { + "type": "int", + "default": 0, + "description": "Starting offset (default: 0)" + }, + "size": { + "type": "int", + "default": 100, + "description": "Specifies a max number of results to get (default: 100)" + }, + "index_name": { + "type": "list", + "description": "A comma-separated list of connector index names to fetch connector documents for" + }, + "connector_name": { + "type": "list", + "description": "A comma-separated list of connector names to fetch connector documents for" + }, + "service_type": { + "type": "list", + "description": "A comma-separated list of connector service types to fetch connector documents for" + }, + "query": { + "type": "string", + "description": "A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names" + } + } + } +} diff --git a/specification/_json_spec/connector.post.json b/specification/_json_spec/connector.post.json new file mode 100644 index 0000000000..2f020f2c29 --- /dev/null +++ b/specification/_json_spec/connector.post.json @@ -0,0 +1,26 @@ +{ + "connector.post": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html", + "description": "Creates a connector." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector", + "methods": ["POST"] + } + ] + }, + "body": { + "description": "The connector configuration.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.put.json b/specification/_json_spec/connector.put.json new file mode 100644 index 0000000000..649b6b7a3b --- /dev/null +++ b/specification/_json_spec/connector.put.json @@ -0,0 +1,32 @@ +{ + "connector.put": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html", + "description": "Creates or updates a connector." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be created or updated." + } + } + } + ] + }, + "body": { + "description": "The connector configuration.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_api_key_id.json b/specification/_json_spec/connector.update_api_key_id.json new file mode 100644 index 0000000000..b065cc6aad --- /dev/null +++ b/specification/_json_spec/connector.update_api_key_id.json @@ -0,0 +1,32 @@ +{ + "connector.update_api_key_id": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-api-key-id-api.html", + "description": "Updates the API key id and/or API key secret id fields in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_api_key_id", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's API key id and/or Connector Secret document id for that API key.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_configuration.json b/specification/_json_spec/connector.update_configuration.json new file mode 100644 index 0000000000..07f3dd4eb4 --- /dev/null +++ b/specification/_json_spec/connector.update_configuration.json @@ -0,0 +1,32 @@ +{ + "connector.update_configuration": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-configuration-api.html", + "description": "Updates the connector configuration." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_configuration", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "Mapping between field names to configuration.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_error.json b/specification/_json_spec/connector.update_error.json new file mode 100644 index 0000000000..5b095850bd --- /dev/null +++ b/specification/_json_spec/connector.update_error.json @@ -0,0 +1,32 @@ +{ + "connector.update_error": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-error-api.html", + "description": "Updates the error field in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_error", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's error.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_filtering.json b/specification/_json_spec/connector.update_filtering.json new file mode 100644 index 0000000000..8779403b22 --- /dev/null +++ b/specification/_json_spec/connector.update_filtering.json @@ -0,0 +1,32 @@ +{ + "connector.update_filtering": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html", + "description": "Updates the filtering field in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_filtering", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "A list of connector filtering configurations.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_index_name.json b/specification/_json_spec/connector.update_index_name.json new file mode 100644 index 0000000000..36de276177 --- /dev/null +++ b/specification/_json_spec/connector.update_index_name.json @@ -0,0 +1,32 @@ +{ + "connector.update_index_name": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-index-name-api.html", + "description": "Updates the index name of the connector." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_index_name", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's index name.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_name.json b/specification/_json_spec/connector.update_name.json new file mode 100644 index 0000000000..f68f7ae0a8 --- /dev/null +++ b/specification/_json_spec/connector.update_name.json @@ -0,0 +1,32 @@ +{ + "connector.update_name": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-name-description-api.html", + "description": "Updates the name and/or description fields in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_name", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's name and/or description.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_native.json b/specification/_json_spec/connector.update_native.json new file mode 100644 index 0000000000..94296a7f46 --- /dev/null +++ b/specification/_json_spec/connector.update_native.json @@ -0,0 +1,32 @@ +{ + "connector.update_native": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/connector-apis.html", + "description": "Updates the is_native flag of the connector." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_native", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's is_native flag", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_pipeline.json b/specification/_json_spec/connector.update_pipeline.json new file mode 100644 index 0000000000..f9049f6821 --- /dev/null +++ b/specification/_json_spec/connector.update_pipeline.json @@ -0,0 +1,32 @@ +{ + "connector.update_pipeline": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-pipeline-api.html", + "description": "Updates the pipeline field in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_pipeline", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object with connector ingest pipeline configuration.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_scheduling.json b/specification/_json_spec/connector.update_scheduling.json new file mode 100644 index 0000000000..ee8b2544ab --- /dev/null +++ b/specification/_json_spec/connector.update_scheduling.json @@ -0,0 +1,32 @@ +{ + "connector.update_scheduling": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-scheduling-api.html", + "description": "Updates the scheduling field in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_scheduling", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's scheduling configuration.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_service_type.json b/specification/_json_spec/connector.update_service_type.json new file mode 100644 index 0000000000..93a2eb1f9c --- /dev/null +++ b/specification/_json_spec/connector.update_service_type.json @@ -0,0 +1,32 @@ +{ + "connector.update_service_type": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-service-type-api.html", + "description": "Updates the service type of the connector." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_service_type", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's service type.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_status.json b/specification/_json_spec/connector.update_status.json new file mode 100644 index 0000000000..d97db87c60 --- /dev/null +++ b/specification/_json_spec/connector.update_status.json @@ -0,0 +1,32 @@ +{ + "connector.update_status": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-status-api.html", + "description": "Updates the status of the connector." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_status", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's status.", + "required": true + } + } +} diff --git a/specification/connector/_types/Connector.ts b/specification/connector/_types/Connector.ts new file mode 100644 index 0000000000..a594663ff0 --- /dev/null +++ b/specification/connector/_types/Connector.ts @@ -0,0 +1,266 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { Id, ScalarValue } from '@_types/common' +import { double, integer, long } from '@_types/Numeric' +import { Dictionary } from '@spec_utils/Dictionary' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' + +interface SelectOption { + label: string + value: string +} + +interface Dependency { + field: string + value: ScalarValue +} + +enum DisplayType { + textbox, + textarea, + numeric, + toggle, + dropdown +} + +enum ConnectorFieldType { + str, + int, + list, + bool +} + +/** @variants internal tag='type' */ +type Validation = + | LessThanValidation + | GreaterThanValidation + | ListTypeValidation + | IncludedInValidation + | RegexValidation + +export interface LessThanValidation { + type: 'less_than' + constraint: double +} + +export interface GreaterThanValidation { + type: 'greater_than' + constraint: double +} + +export interface ListTypeValidation { + type: 'list_type' + constraint: ScalarValue[] +} + +export interface IncludedInValidation { + type: 'included_in' + constraint: string +} + +export interface RegexValidation { + type: 'regex' + constraint: string +} + +export interface ConnectorConfigProperties { + category?: string + default_value: ScalarValue + depends_on: Dependency[] + display: DisplayType + label: string + options: SelectOption[] + order?: integer + placeholder?: string + required: boolean + sensitive: boolean + tooltip?: string + type: ConnectorFieldType + ui_restrictions: string[] + validations: Validation[] + value: ScalarValue +} + +export type ConnectorConfiguration = Dictionary< + string, + ConnectorConfigProperties +> + +export interface ConnectorScheduling { + enabled: boolean + /** The interval is expressed using the crontab syntax */ + interval: string +} + +interface CustomSchedulingConfigurationOverrides { + max_crawl_depth?: integer + sitemap_discovery_disabled?: boolean + domain_allowlist?: string[] + sitemap_urls?: string[] + seed_urls?: string[] +} + +interface CustomScheduling { + configuration_overrides: CustomSchedulingConfigurationOverrides + enabled: boolean + interval: string + last_synced?: string + name: string +} + +export type ConnectorCustomScheduling = Dictionary + +export enum ConnectorStatus { + created, + needs_configuration, + configured, + connected, + error +} + +export enum SyncStatus { + canceling, + canceled, + completed, + error, + in_progress, + pending, + suspended +} + +export interface IngestPipelineParams { + extract_binary_content: boolean + name: string + reduce_whitespace: boolean + run_ml_inference: boolean +} + +enum FilteringPolicy { + exclude, + include +} + +enum FilteringRuleRule { + contains, + ends_with, + equals, + regex, + starts_with, + greater_than = '>', + less_than = '<' +} + +interface FilteringRule { + created_at: string + field: string + id: string + order: integer + policy: FilteringPolicy + rule: FilteringRuleRule + updated_at: string + value: string +} + +interface FilteringValidation { + ids: string[] + messages: string[] +} + +enum FilteringValidationState { + edited, + invalid, + valid +} + +interface FilteringAdvancedSnippet { + created_at: string + updated_at: string + value: Dictionary +} + +interface FilteringRulesValidation { + errors: FilteringValidation[] + state: FilteringValidationState +} + +interface FilteringRules { + advanced_snippet: FilteringAdvancedSnippet + rules: FilteringRule[] + validation: FilteringRulesValidation +} + +export interface FilteringConfig { + active: FilteringRules + domain: string + draft: FilteringRules +} + +interface FeatureEnabled { + enabled: boolean +} + +interface SyncRulesFeature { + advanced?: FeatureEnabled + basic?: FeatureEnabled +} + +export interface ConnectorFeatures { + document_level_security?: FeatureEnabled + filtering_advanced_config?: boolean + filtering_rules?: boolean + incremental_sync?: FeatureEnabled + sync_rules?: SyncRulesFeature +} + +export interface SchedulingConfiguration { + access_control?: ConnectorScheduling + full?: ConnectorScheduling + incremental?: ConnectorScheduling +} + +export interface Connector { + api_key_id?: string + configuration: ConnectorConfiguration + custom_scheduling: ConnectorCustomScheduling + description?: string + error?: string + features: ConnectorFeatures + filtering: FilteringConfig[] + id?: Id + index_name?: string + is_native: boolean + language?: string + last_access_control_sync_error?: string + last_access_control_sync_scheduled_at?: string + last_access_control_sync_status?: SyncStatus + last_deleted_document_count?: long + last_incremental_sync_scheduled_at?: string + last_indexed_document_count?: long + last_seen?: string + last_sync_error?: string + last_sync_scheduled_at?: string + last_sync_status?: SyncStatus + last_synced?: string + name?: string + pipeline?: IngestPipelineParams + scheduling: SchedulingConfiguration + service_type: string + status: ConnectorStatus + sync_now: boolean +} diff --git a/specification/connector/check_in/ConnectorCheckInRequest.ts b/specification/connector/check_in/ConnectorCheckInRequest.ts new file mode 100644 index 0000000000..4c29b9c956 --- /dev/null +++ b/specification/connector/check_in/ConnectorCheckInRequest.ts @@ -0,0 +1,36 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Updates the last_seen field in the connector, and sets it to current timestamp + * @rest_spec_name connector.check_in + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-checkin + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be checked in + */ + connector_id: Id + } +} diff --git a/specification/connector/check_in/ConnectorCheckInResponse.ts b/specification/connector/check_in/ConnectorCheckInResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/check_in/ConnectorCheckInResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/delete/ConnectorDeleteRequest.ts b/specification/connector/delete/ConnectorDeleteRequest.ts new file mode 100644 index 0000000000..ebfd921566 --- /dev/null +++ b/specification/connector/delete/ConnectorDeleteRequest.ts @@ -0,0 +1,36 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Deletes a connector. + * @rest_spec_name connector.delete + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-delete + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be deleted + */ + connector_id: Id + } +} diff --git a/specification/connector/delete/ConnectorDeleteResponse.ts b/specification/connector/delete/ConnectorDeleteResponse.ts new file mode 100644 index 0000000000..7374da4a4c --- /dev/null +++ b/specification/connector/delete/ConnectorDeleteResponse.ts @@ -0,0 +1,24 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { AcknowledgedResponseBase } from '@_types/Base' + +export class Response { + body: AcknowledgedResponseBase +} diff --git a/specification/connector/get/ConnectorGetRequest.ts b/specification/connector/get/ConnectorGetRequest.ts new file mode 100644 index 0000000000..cf54bcd7d0 --- /dev/null +++ b/specification/connector/get/ConnectorGetRequest.ts @@ -0,0 +1,36 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Retrieves a connector. + * @rest_spec_name connector.get + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-get + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector + */ + connector_id: Id + } +} diff --git a/specification/connector/get/ConnectorGetResponse.ts b/specification/connector/get/ConnectorGetResponse.ts new file mode 100644 index 0000000000..fcd6d37908 --- /dev/null +++ b/specification/connector/get/ConnectorGetResponse.ts @@ -0,0 +1,24 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Connector } from '../_types/Connector' + +export class Response { + body: Connector +} diff --git a/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts b/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts new file mode 100644 index 0000000000..1b65b4b57d --- /dev/null +++ b/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts @@ -0,0 +1,55 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { SyncStatus } from '../_types/Connector' +import { long } from '@_types/Numeric' +import { WithNullValue } from '@spec_utils/utils' + +/** + * Updates last sync stats in the connector document + * @rest_spec_name connector.last_sync + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-last-sync + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * Connector last sync stats + */ + body: { + last_access_control_sync_error?: WithNullValue + last_access_control_sync_scheduled_at?: string + last_access_control_sync_status?: SyncStatus + last_deleted_document_count?: long + last_incremental_sync_scheduled_at?: string + last_indexed_document_count?: long + last_seen?: WithNullValue + last_sync_error?: WithNullValue + last_sync_scheduled_at?: string + last_sync_status?: SyncStatus + last_synced?: string + } +} diff --git a/specification/connector/last_sync/ConnectorUpdateLastSyncResponse.ts b/specification/connector/last_sync/ConnectorUpdateLastSyncResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/last_sync/ConnectorUpdateLastSyncResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/list/ConnectorListRequest.ts b/specification/connector/list/ConnectorListRequest.ts new file mode 100644 index 0000000000..ab93a22cc5 --- /dev/null +++ b/specification/connector/list/ConnectorListRequest.ts @@ -0,0 +1,57 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Names, Indices } from '@_types/common' +import { integer } from '@_types/Numeric' + +/** + * Returns existing connectors. + * @rest_spec_name connector.list + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-list + */ +export interface Request extends RequestBase { + query_parameters: { + /** + * Starting offset (default: 0) + */ + from?: integer + /** + * Specifies a max number of results to get + */ + size?: integer + /** + * A comma-separated list of connector index names to fetch connector documents for + */ + index_name?: Indices + /** + * A comma-separated list of connector names to fetch connector documents for + */ + connector_name?: Names + /** + * A comma-separated list of connector service types to fetch connector documents for + */ + service_type?: Names + /** + * A wildcard query string that filters connectors with matching name, description or index name + */ + query?: string + } +} diff --git a/specification/connector/list/ConnectorListResponse.ts b/specification/connector/list/ConnectorListResponse.ts new file mode 100644 index 0000000000..b582d0f204 --- /dev/null +++ b/specification/connector/list/ConnectorListResponse.ts @@ -0,0 +1,28 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { long } from '@_types/Numeric' +import { Connector } from '../_types/Connector' + +export class Response { + body: { + count: long + results: Connector[] + } +} diff --git a/specification/connector/post/ConnectorPostRequest.ts b/specification/connector/post/ConnectorPostRequest.ts new file mode 100644 index 0000000000..65108071e4 --- /dev/null +++ b/specification/connector/post/ConnectorPostRequest.ts @@ -0,0 +1,42 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { WithNullValue } from '@spec_utils/utils' + +/** + * Creates a connector. + * @rest_spec_name connector.post + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-post + */ +export interface Request extends RequestBase { + /** + * The connector document to be created + */ + /** @codegen_name connector */ + body: { + description?: string + index_name: WithNullValue + is_native?: boolean + language?: string + name?: string + service_type?: string + } +} diff --git a/specification/connector/post/ConnectorPostResponse.ts b/specification/connector/post/ConnectorPostResponse.ts new file mode 100644 index 0000000000..69e3a38113 --- /dev/null +++ b/specification/connector/post/ConnectorPostResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Id } from '@_types/common' + +export class Response { + body: { + id: Id + } +} diff --git a/specification/connector/put/ConnectorPutRequest.ts b/specification/connector/put/ConnectorPutRequest.ts new file mode 100644 index 0000000000..479dbfd671 --- /dev/null +++ b/specification/connector/put/ConnectorPutRequest.ts @@ -0,0 +1,49 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { WithNullValue } from '@spec_utils/utils' + +/** + * Creates or updates a connector. + * @rest_spec_name connector.put + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-put + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be created or updated + */ + connector_id: Id + } + /** + * The connector document to be created + */ + /** @codegen_name connector */ + body: { + description?: string + index_name: WithNullValue + is_native?: boolean + language?: string + name?: string + service_type?: string + } +} diff --git a/specification/connector/put/ConnectorPutResponse.ts b/specification/connector/put/ConnectorPutResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/put/ConnectorPutResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts b/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts new file mode 100644 index 0000000000..034988f844 --- /dev/null +++ b/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts @@ -0,0 +1,44 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { WithNullValue } from '@spec_utils/utils' + +/** + * Updates the API key id in the connector document + * @rest_spec_name connector.update_api_key_id + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-api-key-id + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector api key request body + */ + body: { + api_key_id?: WithNullValue + api_key_secret_id?: WithNullValue + } +} diff --git a/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponse.ts b/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts b/specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts new file mode 100644 index 0000000000..d8ea69987a --- /dev/null +++ b/specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts @@ -0,0 +1,47 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { ConnectorConfiguration } from '../_types/Connector' +import { Dictionary } from '@spec_utils/Dictionary' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' + +/** + * Updates the configuration field in the connector document + * @rest_spec_name connector.update_configuration + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-configuration + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector configuration + */ + /** @codegen_name configuration */ + body: { + configuration?: ConnectorConfiguration + values?: Dictionary + } +} diff --git a/specification/connector/update_configuration/ConnectorUpdateConfigurationResponse.ts b/specification/connector/update_configuration/ConnectorUpdateConfigurationResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_configuration/ConnectorUpdateConfigurationResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_error/ConnectorUpdateErrorRequest.ts b/specification/connector/update_error/ConnectorUpdateErrorRequest.ts new file mode 100644 index 0000000000..623a59cac9 --- /dev/null +++ b/specification/connector/update_error/ConnectorUpdateErrorRequest.ts @@ -0,0 +1,44 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { WithNullValue } from '@spec_utils/utils' + +/** + * Updates the filtering field in the connector document + * @rest_spec_name connector.update_error + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-error + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector error + */ + /** @codegen_name error */ + body: { + error: WithNullValue + } +} diff --git a/specification/connector/update_error/ConnectorUpdateErrorResponse.ts b/specification/connector/update_error/ConnectorUpdateErrorResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_error/ConnectorUpdateErrorResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_filtering/ConnectorUpdateFilteringRequest.ts b/specification/connector/update_filtering/ConnectorUpdateFilteringRequest.ts new file mode 100644 index 0000000000..7c66ecfc2d --- /dev/null +++ b/specification/connector/update_filtering/ConnectorUpdateFilteringRequest.ts @@ -0,0 +1,44 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { FilteringConfig } from '../_types/Connector' + +/** + * Updates the filtering field in the connector document + * @rest_spec_name connector.update_filtering + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-filtering + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector filtering configuration + */ + /** @codegen_name filtering */ + body: { + filtering: FilteringConfig[] + } +} diff --git a/specification/connector/update_filtering/ConnectorUpdateFilteringResponse.ts b/specification/connector/update_filtering/ConnectorUpdateFilteringResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_filtering/ConnectorUpdateFilteringResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_index_name/ConnectorUpdateIndexNameRequest.ts b/specification/connector/update_index_name/ConnectorUpdateIndexNameRequest.ts new file mode 100644 index 0000000000..326a4b739d --- /dev/null +++ b/specification/connector/update_index_name/ConnectorUpdateIndexNameRequest.ts @@ -0,0 +1,43 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { WithNullValue } from '@spec_utils/utils' + +/** + * Updates the index_name in the connector document + * @rest_spec_name connector.update_index_name + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-index-name + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector index name + */ + body: { + index_name: WithNullValue + } +} diff --git a/specification/connector/update_index_name/ConnectorUpdateIndexNameResponse.ts b/specification/connector/update_index_name/ConnectorUpdateIndexNameResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_index_name/ConnectorUpdateIndexNameResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_name/ConnectorUpdateNameRequest.ts b/specification/connector/update_name/ConnectorUpdateNameRequest.ts new file mode 100644 index 0000000000..fdadbb5705 --- /dev/null +++ b/specification/connector/update_name/ConnectorUpdateNameRequest.ts @@ -0,0 +1,43 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Updates the name and description fields in the connector document + * @rest_spec_name connector.update_name + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-name + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector name and description + */ + body: { + name: string + description?: string + } +} diff --git a/specification/connector/update_name/ConnectorUpdateNameResponse.ts b/specification/connector/update_name/ConnectorUpdateNameResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_name/ConnectorUpdateNameResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_native/ConnectorUpdateNativeRequest.ts b/specification/connector/update_native/ConnectorUpdateNativeRequest.ts new file mode 100644 index 0000000000..803a91ef59 --- /dev/null +++ b/specification/connector/update_native/ConnectorUpdateNativeRequest.ts @@ -0,0 +1,42 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Updates the is_native flag in the connector document + * @rest_spec_name connector.update_native + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-native + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector is_native flag + */ + body: { + is_native: boolean + } +} diff --git a/specification/connector/update_native/ConnectorUpdateNativeResponse.ts b/specification/connector/update_native/ConnectorUpdateNativeResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_native/ConnectorUpdateNativeResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts b/specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts new file mode 100644 index 0000000000..f092192a48 --- /dev/null +++ b/specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts @@ -0,0 +1,44 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { IngestPipelineParams } from '../_types/Connector' + +/** + * Updates the pipeline field in the connector document + * @rest_spec_name connector.update_pipeline + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-pipeline + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector pipeline object + */ + /** @codegen_name pipeline */ + body: { + pipeline: IngestPipelineParams + } +} diff --git a/specification/connector/update_pipeline/ConnectorUpdatePipelineResponse.ts b/specification/connector/update_pipeline/ConnectorUpdatePipelineResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_pipeline/ConnectorUpdatePipelineResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts b/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts new file mode 100644 index 0000000000..75f184b21a --- /dev/null +++ b/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts @@ -0,0 +1,44 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { SchedulingConfiguration } from '../_types/Connector' + +/** + * Updates the scheduling field in the connector document + * @rest_spec_name connector.update_scheduling + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-scheduling + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector scheduling object + */ + /** @codegen_name scheduling */ + body: { + scheduling: SchedulingConfiguration + } +} diff --git a/specification/connector/update_scheduling/ConnectorUpdateSchedulingResponse.ts b/specification/connector/update_scheduling/ConnectorUpdateSchedulingResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_scheduling/ConnectorUpdateSchedulingResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts b/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts new file mode 100644 index 0000000000..d89e2c3643 --- /dev/null +++ b/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts @@ -0,0 +1,42 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Updates the service type of the connector + * @rest_spec_name connector.update_service_type + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-service-type + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector service type + */ + body: { + service_type: string + } +} diff --git a/specification/connector/update_service_type/ConnectorUpdateServiceTypeResponse.ts b/specification/connector/update_service_type/ConnectorUpdateServiceTypeResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_service_type/ConnectorUpdateServiceTypeResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +} diff --git a/specification/connector/update_status/ConnectorUpdateStatusRequest.ts b/specification/connector/update_status/ConnectorUpdateStatusRequest.ts new file mode 100644 index 0000000000..e1242c0e47 --- /dev/null +++ b/specification/connector/update_status/ConnectorUpdateStatusRequest.ts @@ -0,0 +1,43 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { ConnectorStatus } from '../_types/Connector' + +/** + * Updates the status of the connector + * @rest_spec_name connector.update_status + * @availability stack since=8.12.0 stability=experimental + * @availability serverless stability=experimental visibility=public + * @doc_id connector-update-status + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector to be updated + */ + connector_id: Id + } + /** + * The connector service type + */ + body: { + status: ConnectorStatus + } +} diff --git a/specification/connector/update_status/ConnectorUpdateStatusResponse.ts b/specification/connector/update_status/ConnectorUpdateStatusResponse.ts new file mode 100644 index 0000000000..fc194d6f20 --- /dev/null +++ b/specification/connector/update_status/ConnectorUpdateStatusResponse.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Result } from '@_types/Result' + +export class Response { + body: { + result: Result + } +}