@elastic/schemas 0.4.5 → 0.5.1

package/lib/cjs/es/json/cat.tasks.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.tasks", "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "The task action names, which are used to limit the response.", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about shard recoveries.", "x-found-in": "query" }, "nodes": { "type": "array", "items": { "type": "string" }, "description": "Unique node identifiers, which are used to limit the response.", "x-found-in": "query" }, "parent_task_id": { "type": "string", "description": "The parent task identifier, which is used to limit the response.", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatTasksColumns", "description": "A comma-separated list of columns names to display. It supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the task has completed.", "x-found-in": "query" } }, "description": "Get task information.\n\nGet information about tasks currently running 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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.tasks", "description": "Get task information.\n\nGet information about tasks currently running 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.", "x-api": { "id": "cat.tasks", "name": "tasks", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/tasks", "x-urls": [{ "path": "/_cat/tasks", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.0.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "x-response-type": "text", "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "The task action names, which are used to limit the response.", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about shard recoveries.", "x-found-in": "query" }, "nodes": { "type": "array", "items": { "type": "string" }, "description": "Unique node identifiers, which are used to limit the response.", "x-found-in": "query" }, "parent_task_id": { "type": "string", "description": "The parent task identifier, which is used to limit the response.", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatTasksColumns", "description": "A comma-separated list of columns names to display. It supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the task has completed.", "x-found-in": "query" } } }

package/lib/cjs/es/json/cat.templates.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.templates", "type": "object", "properties": { "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatTemplatesColumns", "description": "A comma-separated list of columns names to display. It supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.", "x-found-in": "path" } }, "description": "Get index template information.\n\nGet information about the 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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.templates", "description": "Get index template information.\n\nGet information about the 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.", "x-api": { "id": "cat.templates", "name": "templates", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/templates/{name}", "x-urls": [{ "path": "/_cat/templates", "methods": ["GET"] }, { "path": "/_cat/templates/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "x-response-type": "text", "type": "object", "properties": { "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatTemplatesColumns", "description": "A comma-separated list of columns names to display. It supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.", "x-found-in": "path" } } }

package/lib/cjs/es/json/cat.thread_pool.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.thread_pool", "type": "object", "properties": { "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatThreadPoolColumns", "description": "List of columns to appear in the response. Supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "thread_pool_patterns": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.", "x-found-in": "path" } }, "description": "Get thread pool statistics.\n\nGet 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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.thread_pool", "description": "Get thread pool statistics.\n\nGet 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.", "x-api": { "id": "cat.thread_pool", "name": "thread-pool", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/thread_pool/{thread_pool_patterns}", "x-urls": [{ "path": "/_cat/thread_pool", "methods": ["GET"] }, { "path": "/_cat/thread_pool/{thread_pool_patterns}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "x-response-type": "text", "type": "object", "properties": { "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatThreadPoolColumns", "description": "List of columns to appear in the response. Supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "thread_pool_patterns": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.", "x-found-in": "path" } } }

package/lib/cjs/es/json/cat.transforms.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.transforms", "type": "object", "properties": { "allow_no_match": { "type": "boolean", "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.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of transforms.", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatTransformColumns", "description": "Comma-separated list of column names to display.", "x-found-in": "query" }, "s": { "$ref": "./cat._types.json#/$defs/cat._types__CatTransformColumns", "description": "Comma-separated list of column names or column aliases used to sort the response.", "x-found-in": "query" }, "size": { "type": "number", "description": "The maximum number of transforms to obtain.", "x-found-in": "query" }, "transform_id": { "type": "string", "description": "A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.", "x-found-in": "path" } }, "description": "Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT 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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.transforms", "description": "Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT 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.", "x-api": { "id": "cat.transforms", "name": "transforms", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/transforms/{transform_id}", "x-urls": [{ "path": "/_cat/transforms", "methods": ["GET"] }, { "path": "/_cat/transforms/{transform_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-response-type": "text", "type": "object", "properties": { "allow_no_match": { "type": "boolean", "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.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of transforms.", "x-found-in": "query" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatTransformColumns", "description": "Comma-separated list of column names to display.", "x-found-in": "query" }, "s": { "$ref": "./cat._types.json#/$defs/cat._types__CatTransformColumns", "description": "Comma-separated list of column names or column aliases used to sort the response.", "x-found-in": "query" }, "size": { "type": "number", "description": "The maximum number of transforms to obtain.", "x-found-in": "query" }, "transform_id": { "type": "string", "description": "A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.", "x-found-in": "path" } } }

package/lib/cjs/es/json/ccr.delete_auto_follow_pattern.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.delete_auto_follow_pattern", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The auto-follow pattern collection to delete.", "x-found-in": "path" } }, "required": ["name"], "description": "Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.delete_auto_follow_pattern", "description": "Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns.", "x-api": { "id": "ccr.delete_auto_follow_pattern", "name": "delete-auto-follow-pattern", "namespace": "ccr" }, "x-method": "DELETE", "x-path": "/_ccr/auto_follow/{name}", "x-urls": [{ "path": "/_ccr/auto_follow/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The auto-follow pattern collection to delete.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/ccr.follow.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.follow", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.", "x-found-in": "query" }, "data_stream_name": { "type": "string", "description": "If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.", "x-found-in": "body" }, "leader_index": { "type": "string", "description": "The name of the index in the leader cluster to follow.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding write requests on the follower.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.", "x-found-in": "body" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader index.", "x-found-in": "body" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "description": "Settings to override from the leader index.", "x-found-in": "body" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index", "leader_index", "remote_cluster"], "description": "Create a follower.\n\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.follow", "description": "Create a follower.\n\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.", "x-api": { "id": "ccr.follow", "name": "follow", "namespace": "ccr" }, "x-method": "PUT", "x-path": "/{index}/_ccr/follow", "x-urls": [{ "path": "/{index}/_ccr/follow", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.", "x-found-in": "query", "x-availability": { "stack": {} } }, "data_stream_name": { "type": "string", "description": "If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.", "x-found-in": "body" }, "leader_index": { "type": "string", "description": "The name of the index in the leader cluster to follow.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding write requests on the follower.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.", "x-found-in": "body" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader index.", "x-found-in": "body" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "description": "Settings to override from the leader index.", "x-found-in": "body" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index", "leader_index", "remote_cluster"] }

package/lib/cjs/es/json/ccr.follow_info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.follow_info", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-delimited list of follower index patterns.", "x-found-in": "path" } }, "required": ["index"], "description": "Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.follow_info", "description": "Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", "x-api": { "id": "ccr.follow_info", "name": "follow-info", "namespace": "ccr" }, "x-method": "GET", "x-path": "/{index}/_ccr/info", "x-urls": [{ "path": "/{index}/_ccr/info", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.7.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-delimited list of follower index patterns.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/ccr.follow_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.follow_stats", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-delimited list of index patterns.", "x-found-in": "path" } }, "required": ["index"], "description": "Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.follow_stats", "description": "Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", "x-api": { "id": "ccr.follow_stats", "name": "follow-stats", "namespace": "ccr" }, "x-method": "GET", "x-path": "/{index}/_ccr/stats", "x-urls": [{ "path": "/{index}/_ccr/stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-delimited list of index patterns.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/ccr.forget_follower.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.forget_follower", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "follower_cluster": { "type": "string", "x-found-in": "body" }, "follower_index": { "type": "string", "x-found-in": "body" }, "follower_index_uuid": { "type": "string", "x-found-in": "body" }, "leader_remote_cluster": { "type": "string", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the leader index for which specified follower retention leases should be removed", "x-found-in": "path" } }, "required": ["index"], "description": "Forget a follower.\n\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.forget_follower", "description": "Forget a follower.\n\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.", "x-api": { "id": "ccr.forget_follower", "name": "forget-follower", "namespace": "ccr" }, "x-method": "POST", "x-path": "/{index}/_ccr/forget_follower", "x-urls": [{ "path": "/{index}/_ccr/forget_follower", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.7.0", "stability": "stable" } }, "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "follower_cluster": { "type": "string", "x-found-in": "body" }, "follower_index": { "type": "string", "x-found-in": "body" }, "follower_index_uuid": { "type": "string", "x-found-in": "body" }, "leader_remote_cluster": { "type": "string", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the leader index for which specified follower retention leases should be removed", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/ccr.get_auto_follow_pattern.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.get_auto_follow_pattern", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The auto-follow pattern collection that you want to retrieve.\nIf you do not specify a name, the API returns information for all collections.", "x-found-in": "path" } }, "description": "Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.get_auto_follow_pattern", "description": "Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns.", "x-api": { "id": "ccr.get_auto_follow_pattern", "name": "get-auto-follow-pattern", "namespace": "ccr" }, "x-method": "GET", "x-path": "/_ccr/auto_follow/{name}", "x-urls": [{ "path": "/_ccr/auto_follow", "methods": ["GET"] }, { "path": "/_ccr/auto_follow/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The auto-follow pattern collection that you want to retrieve.\nIf you do not specify a name, the API returns information for all collections.", "x-found-in": "path" } } }

package/lib/cjs/es/json/ccr.pause_auto_follow_pattern.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.pause_auto_follow_pattern", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the auto-follow pattern to pause.", "x-found-in": "path" } }, "required": ["name"], "description": "Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.pause_auto_follow_pattern", "description": "Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", "x-api": { "id": "ccr.pause_auto_follow_pattern", "name": "pause-auto-follow-pattern", "namespace": "ccr" }, "x-method": "POST", "x-path": "/_ccr/auto_follow/{name}/pause", "x-urls": [{ "path": "/_ccr/auto_follow/{name}/pause", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the auto-follow pattern to pause.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/ccr.pause_follow.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.pause_follow", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index"], "description": "Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.pause_follow", "description": "Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", "x-api": { "id": "ccr.pause_follow", "name": "pause-follow", "namespace": "ccr" }, "x-method": "POST", "x-path": "/{index}/_ccr/pause_follow", "x-urls": [{ "path": "/{index}/_ccr/pause_follow", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/ccr.put_auto_follow_pattern.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.put_auto_follow_pattern", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader indices to match against.", "x-found-in": "body" }, "follow_index_pattern": { "type": "string", "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.", "x-found-in": "body" }, "leader_index_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", "x-found-in": "body" }, "leader_index_exclusion_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "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.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "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.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "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.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "name": { "type": "string", "description": "The name of the collection of auto-follow patterns.", "x-found-in": "path" } }, "required": ["name", "remote_cluster"], "description": "Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.put_auto_follow_pattern", "description": "Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.", "x-api": { "id": "ccr.put_auto_follow_pattern", "name": "put-auto-follow-pattern", "namespace": "ccr" }, "x-method": "PUT", "x-path": "/_ccr/auto_follow/{name}", "x-urls": [{ "path": "/_ccr/auto_follow/{name}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader indices to match against.", "x-found-in": "body" }, "follow_index_pattern": { "type": "string", "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.", "x-found-in": "body" }, "leader_index_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", "x-found-in": "body" }, "leader_index_exclusion_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "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.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "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.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "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.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "name": { "type": "string", "description": "The name of the collection of auto-follow patterns.", "x-found-in": "path" } }, "required": ["name", "remote_cluster"] }

package/lib/cjs/es/json/ccr.resume_auto_follow_pattern.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_auto_follow_pattern", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the auto-follow pattern to resume.", "x-found-in": "path" } }, "required": ["name"], "description": "Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_auto_follow_pattern", "description": "Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", "x-api": { "id": "ccr.resume_auto_follow_pattern", "name": "resume-auto-follow-pattern", "namespace": "ccr" }, "x-method": "POST", "x-path": "/_ccr/auto_follow/{name}/resume", "x-urls": [{ "path": "/_ccr/auto_follow/{name}/resume", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the auto-follow pattern to resume.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/ccr.resume_follow.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_follow", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "max_outstanding_read_requests": { "type": "number", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_read_request_size": { "type": "string", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "x-found-in": "body" }, "max_write_buffer_size": { "type": "string", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_write_request_size": { "type": "string", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the follow index to resume following", "x-found-in": "path" } }, "required": ["index"], "description": "Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_follow", "description": "Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index.", "x-api": { "id": "ccr.resume_follow", "name": "resume-follow", "namespace": "ccr" }, "x-method": "POST", "x-path": "/{index}/_ccr/resume_follow", "x-urls": [{ "path": "/{index}/_ccr/resume_follow", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "max_outstanding_read_requests": { "type": "number", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_read_request_size": { "type": "string", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "x-found-in": "body" }, "max_write_buffer_size": { "type": "string", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_write_request_size": { "type": "string", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the follow index to resume following", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/ccr.stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.stats", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "description": "Get cross-cluster replication stats.\n\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.stats", "description": "Get cross-cluster replication stats.\n\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", "x-api": { "id": "ccr.stats", "name": "stats", "namespace": "ccr" }, "x-method": "GET", "x-path": "/_ccr/stats", "x-urls": [{ "path": "/_ccr/stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } } }

package/lib/cjs/es/json/ccr.unfollow.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.unfollow", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index"], "description": "Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.unfollow", "description": "Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", "x-api": { "id": "ccr.unfollow", "name": "unfollow", "namespace": "ccr" }, "x-method": "POST", "x-path": "/{index}/_ccr/unfollow", "x-urls": [{ "path": "/{index}/_ccr/unfollow", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.5.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index"] }

package/lib/cjs/es/json/clear_scroll.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "clear_scroll", "type": "object", "properties": { "scroll_id": { "$ref": "./_types.json#/$defs/_types__ScrollIds", "description": "A comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.\nIMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.", "x-found-in": "body" } }, "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "clear_scroll", "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search.", "x-api": { "id": "clear_scroll", "name": "clear-scroll", "namespace": null }, "x-method": "DELETE", "x-path": "/_search/scroll", "x-urls": [{ "path": "/_search/scroll", "methods": ["DELETE"] }, { "path": "/_search/scroll/{scroll_id}", "methods": ["DELETE"], "deprecated": { "since": "7.0.0", "description": "A scroll id can be quite large and should be specified as part of the body" } }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "scroll_id": { "$ref": "./_types.json#/$defs/_types__ScrollIds", "description": "A comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.\nIMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.", "x-found-in": "body", "x-deprecated": { "since": "7.0.0" } } } }

package/lib/cjs/es/json/close_point_in_time.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "close_point_in_time", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the point-in-time.", "x-found-in": "body" } }, "required": ["id"], "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "close_point_in_time", "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "x-api": { "id": "close_point_in_time", "name": "close-point-in-time", "namespace": null }, "x-method": "DELETE", "x-path": "/_pit", "x-urls": [{ "path": "/_pit", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the point-in-time.", "x-found-in": "body" } }, "required": ["id"] }

package/lib/cjs/es/json/cluster.allocation_explain.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.allocation_explain", "type": "object", "properties": { "index": { "type": "string", "description": "The name of the index that you would like an explanation for.", "x-found-in": "body" }, "shard": { "type": "number", "description": "An identifier for the shard that you would like an explanation for.", "x-found-in": "body" }, "primary": { "type": "boolean", "description": "If true, returns an explanation for the primary shard for the specified shard ID.", "x-found-in": "body" }, "current_node": { "type": "string", "description": "Explain a shard only if it is currently located on the specified node name or node ID.", "x-found-in": "body" }, "include_disk_info": { "type": "boolean", "description": "If true, returns information about disk usage and shard sizes.", "x-found-in": "query" }, "include_yes_decisions": { "type": "boolean", "description": "If true, returns YES decisions in explanation.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" } }, "description": "Explain the shard allocations.\n\nGet explanations for shard allocations in the cluster.\nThis API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.\nFor unassigned shards, it provides an explanation for why the shard is unassigned.\nFor assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.\nThis API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.\nRefer to the linked documentation for examples of how to troubleshoot allocation issues using this API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.allocation_explain", "description": "Explain the shard allocations.\n\nGet explanations for shard allocations in the cluster.\nThis API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.\nFor unassigned shards, it provides an explanation for why the shard is unassigned.\nFor assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.\nThis API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.\nRefer to the linked documentation for examples of how to troubleshoot allocation issues using this API.", "x-api": { "id": "cluster.allocation_explain", "name": "allocation-explain", "namespace": "cluster" }, "x-method": "GET", "x-path": "/_cluster/allocation/explain", "x-urls": [{ "path": "/_cluster/allocation/explain", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "index": { "type": "string", "description": "The name of the index that you would like an explanation for.", "x-found-in": "body" }, "shard": { "type": "number", "description": "An identifier for the shard that you would like an explanation for.", "x-found-in": "body" }, "primary": { "type": "boolean", "description": "If true, returns an explanation for the primary shard for the specified shard ID.", "x-found-in": "body" }, "current_node": { "type": "string", "description": "Explain a shard only if it is currently located on the specified node name or node ID.", "x-found-in": "body" }, "include_disk_info": { "type": "boolean", "description": "If true, returns information about disk usage and shard sizes.", "x-found-in": "query" }, "include_yes_decisions": { "type": "boolean", "description": "If true, returns YES decisions in explanation.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" } } }

package/lib/cjs/es/json/cluster.delete_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.delete_component_template", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list or wildcard expression of component template names used to limit the request.", "x-found-in": "path" } }, "required": ["name"], "description": "Delete component templates.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.delete_component_template", "description": "Delete component templates.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "x-api": { "id": "cluster.delete_component_template", "name": "delete-component-template", "namespace": "cluster" }, "x-method": "DELETE", "x-path": "/_component_template/{name}", "x-urls": [{ "path": "/_component_template/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.8.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list or wildcard expression of component template names used to limit the request.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/cluster.delete_voting_config_exclusions.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.delete_voting_config_exclusions", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_removal": { "type": "boolean", "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.", "x-found-in": "query" } }, "description": "Clear cluster voting config exclusions.\n\nRemove master-eligible nodes from the voting configuration exclusion list." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.delete_voting_config_exclusions", "description": "Clear cluster voting config exclusions.\n\nRemove master-eligible nodes from the voting configuration exclusion list.", "x-api": { "id": "cluster.delete_voting_config_exclusions", "name": "delete-voting-config-exclusions", "namespace": "cluster" }, "x-method": "DELETE", "x-path": "/_cluster/voting_config_exclusions", "x-urls": [{ "path": "/_cluster/voting_config_exclusions", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.0.0", "stability": "stable" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_removal": { "type": "boolean", "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.", "x-found-in": "query" } } }

package/lib/cjs/es/json/cluster.exists_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.exists_component_template", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.", "x-found-in": "path" } }, "required": ["name"], "description": "Check component templates.\n\nReturns information about whether a particular component template exists." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.exists_component_template", "description": "Check component templates.\n\nReturns information about whether a particular component template exists.", "x-api": { "id": "cluster.exists_component_template", "name": "exists-component-template", "namespace": "cluster" }, "x-method": "HEAD", "x-path": "/_component_template/{name}", "x-urls": [{ "path": "/_component_template/{name}", "methods": ["HEAD"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.8.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.", "x-found-in": "query", "x-deprecated": { "since": "9.0.0", "description": "This parameter has no effect, is now deprecated, and will be removed in a future version." } }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.", "x-found-in": "path" } }, "required": ["name"] }

package/lib/cjs/es/json/cluster.get_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.get_component_template", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "settings_filter": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "Return all default configurations for the component template", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "name": { "type": "string", "description": "Name of component template to retrieve. Wildcard (`*`) expressions are supported.", "x-found-in": "path" } }, "description": "Get component templates.\n\nGet information about component templates." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.get_component_template", "description": "Get component templates.\n\nGet information about component templates.", "x-api": { "id": "cluster.get_component_template", "name": "get-component-template", "namespace": "cluster" }, "x-method": "GET", "x-path": "/_component_template/{name}", "x-urls": [{ "path": "/_component_template", "methods": ["GET"] }, { "path": "/_component_template/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.8.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "settings_filter": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "Return all default configurations for the component template", "x-found-in": "query", "x-availability": { "stack": { "since": "8.11.0", "stability": "stable" }, "serverless": { "stability": "stable" } } }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", "x-found-in": "query", "x-deprecated": { "since": "9.0.0", "description": "This parameter has no effect, is now deprecated, and will be removed in a future version." } }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "name": { "type": "string", "description": "Name of component template to retrieve. Wildcard (`*`) expressions are supported.", "x-found-in": "path" } } }

package/lib/cjs/es/json/cluster.get_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.get_settings", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, also returns the values of all other cluster settings set in the\n`elasticsearch.yml` file on one of the nodes in your cluster, together with the default\nvalues of all other cluster settings on that node. The default value of each setting may\ndepend on the values of other settings on that node. If the nodes in your cluster do not all\nhave the same configuration then the values returned by this API may vary from invocation to\ninvocation and may not reflect the values that Elasticsearch uses in all situations. Use the\n`GET _nodes/settings` API to fetch the settings for each individual node in your cluster.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "description": "Get cluster-wide settings.\n\nBy default, it returns only settings that have been explicitly defined." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.get_settings", "description": "Get cluster-wide settings.\n\nBy default, it returns only settings that have been explicitly defined.", "x-api": { "id": "cluster.get_settings", "name": "get-settings", "namespace": "cluster" }, "x-method": "GET", "x-path": "/_cluster/settings", "x-urls": [{ "path": "/_cluster/settings", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If `true`, also returns the values of all other cluster settings set in the\n`elasticsearch.yml` file on one of the nodes in your cluster, together with the default\nvalues of all other cluster settings on that node. The default value of each setting may\ndepend on the values of other settings on that node. If the nodes in your cluster do not all\nhave the same configuration then the values returned by this API may vary from invocation to\ninvocation and may not reflect the values that Elasticsearch uses in all situations. Use the\n`GET _nodes/settings` API to fetch the settings for each individual node in your cluster.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } } }

package/lib/cjs/es/json/cluster.health.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.health", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "level": { "$ref": "./_types.json#/$defs/_types__Level", "description": "Return health information at a specific level of detail.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, retrieve information from the local node only.\nIf false, retrieve information from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "Wait for the specified number of active shards.\nUse `all` to wait for all shards in the cluster to be active.\nUse `0` to not wait.", "x-found-in": "query" }, "wait_for_events": { "$ref": "./_types.json#/$defs/_types__WaitForEvents", "description": "Wait until all currently queued events with the given priority are processed.", "x-found-in": "query" }, "wait_for_nodes": { "$ref": "./cluster.health.json#/$defs/cluster.health__WaitForNodes", "description": "Wait until the specified number (N) of nodes is available.\nIt also accepts `>=N`, `<=N`, `>N` and `<N`.\nAlternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.", "x-found-in": "query" }, "wait_for_no_initializing_shards": { "type": "boolean", "description": "Wait (until the timeout expires) for the cluster to have no shard initializations.\nIf false, the request does not wait for initializing shards.", "x-found-in": "query" }, "wait_for_no_relocating_shards": { "type": "boolean", "description": "Wait (until the timeout expires) for the cluster to have no shard relocations.\nIf false, the request not wait for relocating shards.", "x-found-in": "query" }, "wait_for_status": { "$ref": "./_types.json#/$defs/_types__HealthStatus", "description": "Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).\nA green status is better than yellow and yellow is better than red.\nBy default, the request does not wait for a particular status.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and index aliases that limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use _all or `*`.", "x-found-in": "path" } }, "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn 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. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.health", "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn 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. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", "x-api": { "id": "cluster.health", "name": "health", "namespace": "cluster" }, "x-method": "GET", "x-path": "/_cluster/health/{index}", "x-urls": [{ "path": "/_cluster/health", "methods": ["GET"] }, { "path": "/_cluster/health/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "1.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "level": { "$ref": "./_types.json#/$defs/_types__Level", "description": "Return health information at a specific level of detail.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, retrieve information from the local node only.\nIf false, retrieve information from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "Wait for the specified number of active shards.\nUse `all` to wait for all shards in the cluster to be active.\nUse `0` to not wait.", "x-found-in": "query", "x-availability": { "stack": {} } }, "wait_for_events": { "$ref": "./_types.json#/$defs/_types__WaitForEvents", "description": "Wait until all currently queued events with the given priority are processed.", "x-found-in": "query" }, "wait_for_nodes": { "$ref": "./cluster.health.json#/$defs/cluster.health__WaitForNodes", "description": "Wait until the specified number (N) of nodes is available.\nIt also accepts `>=N`, `<=N`, `>N` and `<N`.\nAlternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.", "x-found-in": "query" }, "wait_for_no_initializing_shards": { "type": "boolean", "description": "Wait (until the timeout expires) for the cluster to have no shard initializations.\nIf false, the request does not wait for initializing shards.", "x-found-in": "query" }, "wait_for_no_relocating_shards": { "type": "boolean", "description": "Wait (until the timeout expires) for the cluster to have no shard relocations.\nIf false, the request not wait for relocating shards.", "x-found-in": "query" }, "wait_for_status": { "$ref": "./_types.json#/$defs/_types__HealthStatus", "description": "Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).\nA green status is better than yellow and yellow is better than red.\nBy default, the request does not wait for a particular status.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and index aliases that limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use _all or `*`.", "x-found-in": "path" } } }

package/lib/cjs/es/json/cluster.info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.info", "type": "object", "properties": { "target": { "$ref": "./_types.json#/$defs/_types__ClusterInfoTargets", "description": "Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.", "x-found-in": "path" } }, "required": ["target"], "description": "Get cluster info.\n\nReturns basic information about the cluster." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.info", "description": "Get cluster info.\n\nReturns basic information about the cluster.", "x-api": { "id": "cluster.info", "name": "info", "namespace": "cluster" }, "x-method": "GET", "x-path": "/_info/{target}", "x-urls": [{ "path": "/_info/{target}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "target": { "$ref": "./_types.json#/$defs/_types__ClusterInfoTargets", "description": "Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.", "x-found-in": "path" } }, "required": ["target"] }

package/lib/cjs/es/json/cluster.pending_tasks.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.pending_tasks", "type": "object", "properties": { "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" } }, "description": "Get the pending cluster tasks.\n\nGet information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.\n\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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.pending_tasks", "description": "Get the pending cluster tasks.\n\nGet information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.\n\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.", "x-api": { "id": "cluster.pending_tasks", "name": "pending-tasks", "namespace": "cluster" }, "x-method": "GET", "x-path": "/_cluster/pending_tasks", "x-urls": [{ "path": "/_cluster/pending_tasks", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" } } }

package/lib/cjs/es/json/cluster.post_voting_config_exclusions.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.post_voting_config_exclusions", "type": "object", "properties": { "node_names": { "$ref": "./_types.json#/$defs/_types__Names", "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.", "x-found-in": "query" }, "node_ids": { "$ref": "./_types.json#/$defs/_types__Ids", "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.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" } }, "description": "Update voting configuration exclusions.\n\nUpdate the cluster voting config exclusions by node IDs or node names.\nBy default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.\nIf you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually.\nThe API adds an entry for each specified node to the cluster’s voting configuration exclusions list.\nIt then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.\n\nClusters should have no voting configuration exclusions in normal operation.\nOnce the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`.\nThis API waits for the nodes to be fully removed from the cluster before it returns.\nIf your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.\n\nA response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.\nIf the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration.\nIn that case, you may safely retry the call.\n\nNOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period.\nThey are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.post_voting_config_exclusions", "description": "Update voting configuration exclusions.\n\nUpdate the cluster voting config exclusions by node IDs or node names.\nBy default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.\nIf you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually.\nThe API adds an entry for each specified node to the cluster’s voting configuration exclusions list.\nIt then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.\n\nClusters should have no voting configuration exclusions in normal operation.\nOnce the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`.\nThis API waits for the nodes to be fully removed from the cluster before it returns.\nIf your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.\n\nA response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.\nIf the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration.\nIn that case, you may safely retry the call.\n\nNOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period.\nThey are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.", "x-api": { "id": "cluster.post_voting_config_exclusions", "name": "post-voting-config-exclusions", "namespace": "cluster" }, "x-method": "POST", "x-path": "/_cluster/voting_config_exclusions", "x-urls": [{ "path": "/_cluster/voting_config_exclusions", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.0.0", "stability": "stable" } }, "type": "object", "properties": { "node_names": { "$ref": "./_types.json#/$defs/_types__Names", "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.", "x-found-in": "query" }, "node_ids": { "$ref": "./_types.json#/$defs/_types__Ids", "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.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" } } }

package/lib/cjs/es/json/cluster.put_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_component_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing component templates.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for create the component template.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "The template to be applied which includes mappings, settings, or aliases configuration.", "x-found-in": "body" }, "version": { "type": "number", "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.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "name": { "type": "string", "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.", "x-found-in": "path" } }, "required": ["name", "template"], "description": "Create or update a component template.\n\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.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_component_template", "description": "Create or update a component template.\n\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.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list.", "x-api": { "id": "cluster.put_component_template", "name": "put-component-template", "namespace": "cluster" }, "x-method": "PUT", "x-path": "/_component_template/{name}", "x-urls": [{ "path": "/_component_template/{name}", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.8.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing component templates.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for create the component template.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "The template to be applied which includes mappings, settings, or aliases configuration.", "x-found-in": "body" }, "version": { "type": "number", "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.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "name": { "type": "string", "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.", "x-found-in": "path" } }, "required": ["name", "template"] }

package/lib/cjs/es/json/cluster.put_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_settings", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "Return settings in flat format", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.", "x-found-in": "query" }, "persistent": { "type": "object", "additionalProperties": {}, "description": "The settings that persist after the cluster restarts.", "x-found-in": "body" }, "transient": { "type": "object", "additionalProperties": {}, "description": "The settings that do not persist after the cluster restarts.", "x-found-in": "body" } }, "description": "Update the cluster settings.\n\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_settings", "description": "Update the cluster settings.\n\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.", "x-api": { "id": "cluster.put_settings", "name": "put-settings", "namespace": "cluster" }, "x-method": "PUT", "x-path": "/_cluster/settings", "x-urls": [{ "path": "/_cluster/settings", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "Return settings in flat format", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.", "x-found-in": "query" }, "persistent": { "type": "object", "additionalProperties": {}, "description": "The settings that persist after the cluster restarts.", "x-found-in": "body" }, "transient": { "type": "object", "additionalProperties": {}, "description": "The settings that do not persist after the cluster restarts.", "x-found-in": "body" } } }

package/lib/cjs/es/json/cluster.remote_info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.remote_info", "type": "object", "properties": {}, "description": "Get remote cluster information.\n\nGet information about configured remote clusters.\nThe API returns connection and endpoint information keyed by the configured remote cluster alias.\n\n> info\n> This API returns information that reflects current state on the local cluster.\n> The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.\n> Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.\n> To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster)." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.remote_info", "description": "Get remote cluster information.\n\nGet information about configured remote clusters.\nThe API returns connection and endpoint information keyed by the configured remote cluster alias.\n\n> info\n> This API returns information that reflects current state on the local cluster.\n> The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.\n> Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.\n> To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster).", "x-api": { "id": "cluster.remote_info", "name": "remote-info", "namespace": "cluster" }, "x-method": "GET", "x-path": "/_remote/info", "x-urls": [{ "path": "/_remote/info", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" } }, "type": "object", "properties": {} }

package/lib/cjs/es/json/cluster.reroute.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.reroute", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If true, then the request simulates the operation.\nIt will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, then the response contains an explanation of why the commands can or cannot run.", "x-found-in": "query" }, "metric": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Limits the information returned to the specified metrics.", "x-found-in": "query" }, "retry_failed": { "type": "boolean", "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "commands": { "type": "array", "items": { "$ref": "./cluster.reroute.json#/$defs/cluster.reroute__Command" }, "description": "Defines the commands to perform.", "x-found-in": "body" } }, "description": "Reroute the cluster.\n\nManually change the allocation of individual shards in the cluster.\nFor example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.\n\nIt is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state.\nFor example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.\n\nThe cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting.\nIf allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.\n\nThe cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated.\nThis scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.\n\nOnce the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.reroute", "description": "Reroute the cluster.\n\nManually change the allocation of individual shards in the cluster.\nFor example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.\n\nIt is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state.\nFor example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.\n\nThe cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting.\nIf allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.\n\nThe cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated.\nThis scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.\n\nOnce the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards.", "x-api": { "id": "cluster.reroute", "name": "reroute", "namespace": "cluster" }, "x-method": "POST", "x-path": "/_cluster/reroute", "x-urls": [{ "path": "/_cluster/reroute", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If true, then the request simulates the operation.\nIt will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, then the response contains an explanation of why the commands can or cannot run.", "x-found-in": "query" }, "metric": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Limits the information returned to the specified metrics.", "x-found-in": "query", "x-deprecated": { "since": "8.6.0", "description": "This parameter has no effect; its use will be forbidden in a future version." } }, "retry_failed": { "type": "boolean", "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "commands": { "type": "array", "items": { "$ref": "./cluster.reroute.json#/$defs/cluster.reroute__Command" }, "description": "Defines the commands to perform.", "x-found-in": "body" } } }

package/lib/cjs/es/json/cluster.state.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.state", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "Return settings in flat format", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "Return local information, do not retrieve the state from master node", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout for waiting for new cluster state in case it is blocked", "x-found-in": "query" }, "wait_for_metadata_version": { "type": "number", "description": "Wait for the metadata version to be equal or greater than the specified metadata version", "x-found-in": "query" }, "wait_for_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for wait_for_metadata_version before timing out", "x-found-in": "query" }, "metric": { "$ref": "./cluster.state.json#/$defs/cluster.state__ClusterStateMetrics", "description": "Limit the information returned to the specified metrics.", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } }, "description": "Get the cluster state.\n\nGet comprehensive information about the state of the cluster.\n\nThe cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.\n\nThe elected master node ensures that every node in the cluster has a copy of the same cluster state.\nThis API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.\nYou may need to consult the Elasticsearch source code to determine the precise meaning of the response.\n\nBy default the API will route requests to the elected master node since this node is the authoritative source of cluster states.\nYou can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.\n\nElasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data.\nIf you use this API repeatedly, your cluster may become unstable.\n\nWARNING: The response is a representation of an internal data structure.\nIts format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version.\nDo not query this API using external monitoring tools.\nInstead, obtain the information you require using other more stable cluster APIs." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.state", "description": "Get the cluster state.\n\nGet comprehensive information about the state of the cluster.\n\nThe cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.\n\nThe elected master node ensures that every node in the cluster has a copy of the same cluster state.\nThis API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.\nYou may need to consult the Elasticsearch source code to determine the precise meaning of the response.\n\nBy default the API will route requests to the elected master node since this node is the authoritative source of cluster states.\nYou can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.\n\nElasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data.\nIf you use this API repeatedly, your cluster may become unstable.\n\nWARNING: The response is a representation of an internal data structure.\nIts format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version.\nDo not query this API using external monitoring tools.\nInstead, obtain the information you require using other more stable cluster APIs.", "x-api": { "id": "cluster.state", "name": "state", "namespace": "cluster" }, "x-method": "GET", "x-path": "/_cluster/state/{metric}/{index}", "x-urls": [{ "path": "/_cluster/state", "methods": ["GET"] }, { "path": "/_cluster/state/{metric}", "methods": ["GET"] }, { "path": "/_cluster/state/{metric}/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "1.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "Return settings in flat format", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "Return local information, do not retrieve the state from master node", "x-found-in": "query", "x-deprecated": { "since": "9.0.0", "description": "This parameter has no effect, is now deprecated, and will be removed in a future version." } }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout for waiting for new cluster state in case it is blocked", "x-found-in": "query" }, "wait_for_metadata_version": { "type": "number", "description": "Wait for the metadata version to be equal or greater than the specified metadata version", "x-found-in": "query" }, "wait_for_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for wait_for_metadata_version before timing out", "x-found-in": "query" }, "metric": { "$ref": "./cluster.state.json#/$defs/cluster.state__ClusterStateMetrics", "description": "Limit the information returned to the specified metrics.", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } } }

package/lib/cjs/es/json/connector.check_in.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.check_in", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be checked in", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.check_in", "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", "x-api": { "id": "connector.check_in", "name": "check-in", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_check_in", "x-urls": [{ "path": "/_connector/{connector_id}/_check_in", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be checked in", "x-found-in": "path" } }, "required": ["connector_id"] }

package/lib/cjs/es/json/connector.delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.delete", "type": "object", "properties": { "delete_sync_jobs": { "type": "boolean", "description": "A flag indicating if associated sync jobs should be also removed.", "x-found-in": "query" }, "hard": { "type": "boolean", "description": "A flag indicating if the connector should be hard deleted.", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be deleted", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.delete", "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "x-api": { "id": "connector.delete", "name": "delete", "namespace": "connector" }, "x-method": "DELETE", "x-path": "/_connector/{connector_id}", "x-urls": [{ "path": "/_connector/{connector_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "delete_sync_jobs": { "type": "boolean", "description": "A flag indicating if associated sync jobs should be also removed.", "x-found-in": "query" }, "hard": { "type": "boolean", "description": "A flag indicating if the connector should be hard deleted.", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be deleted", "x-found-in": "path" } }, "required": ["connector_id"] }

package/lib/cjs/es/json/connector.get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.get", "type": "object", "properties": { "include_deleted": { "type": "boolean", "description": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Get a connector.\n\nGet the details about a connector." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.get", "description": "Get a connector.\n\nGet the details about a connector.", "x-api": { "id": "connector.get", "name": "get", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector/{connector_id}", "x-urls": [{ "path": "/_connector/{connector_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "include_deleted": { "type": "boolean", "description": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector", "x-found-in": "path" } }, "required": ["connector_id"] }